From d315946ce9e3ceea6f19381ae53fba71abd09009 Mon Sep 17 00:00:00 2001
From: Duduf <git@duduf.com>
Date: Sun, 20 Nov 2022 16:07:10 +0100
Subject: [PATCH] 0.7.0 doc (still missing new server methods, will be added
 later)

---
 docs/changelog-api/index.html                 |  24 +-
 docs/changelog-app/index.html                 |  54 +-
 docs/changelog-maya/index.html                |  28 +-
 docs/changelog-server/index.html              |  45 +-
 docs/changelog/index.html                     |   6 +-
 docs/components/addons/index.html             |   6 +-
 docs/components/addons/maya-extend/index.html |   6 +-
 docs/components/addons/maya-import/index.html |   6 +-
 .../addons/maya-pipeline/index.html           |   6 +-
 .../components/addons/maya-publish/index.html |   6 +-
 .../addons/maya-scenesetup/index.html         |   6 +-
 docs/components/addons/maya/index.html        |   6 +-
 docs/components/client/admin/index.html       |   6 +-
 .../components/client/applications/index.html |   6 +-
 docs/components/client/assetgroups/index.html |   6 +-
 docs/components/client/assets/index.html      |   6 +-
 docs/components/client/filetypes/index.html   |   6 +-
 docs/components/client/index.html             |   6 +-
 docs/components/client/install/index.html     |   6 +-
 docs/components/client/pipeline/index.html    |   6 +-
 docs/components/client/pipetypes/index.html   |   6 +-
 docs/components/client/production/index.html  |   6 +-
 docs/components/client/project/index.html     |   6 +-
 docs/components/client/projects/index.html    |   6 +-
 docs/components/client/schedule/index.html    |   6 +-
 docs/components/client/sequences/index.html   |   6 +-
 docs/components/client/settings/index.html    |   6 +-
 docs/components/client/shots/index.html       |   6 +-
 docs/components/client/states/index.html      |   6 +-
 docs/components/client/steps/index.html       |   6 +-
 .../client/templateassetgroups/index.html     |   6 +-
 .../client/templatesteps/index.html           |   6 +-
 docs/components/client/users/index.html       |   6 +-
 docs/components/files/index.html              |   6 +-
 docs/components/files/naming/index.html       |   6 +-
 docs/components/files/tree/index.html         |   6 +-
 docs/components/index.html                    |   6 +-
 docs/components/server/admin/index.html       |   6 +-
 docs/components/server/config/index.html      |   6 +-
 docs/components/server/index.html             |   6 +-
 .../server/install-docker-mysql/index.html    |   6 +-
 .../server/install-docker-sqlite/index.html   |   6 +-
 docs/components/server/install-src/index.html |   6 +-
 docs/components/server/install/index.html     |   6 +-
 docs/components/server/update/index.html      |   6 +-
 docs/credits/index.html                       |   6 +-
 docs/dev/add-ons-reference/enum/index.html    |   6 +-
 .../implementation/index.html                 |   6 +-
 docs/dev/add-ons-reference/index.html         |   6 +-
 .../add-ons-reference/ram_asset/index.html    |   6 +-
 .../ram_assetgroup/index.html                 |   6 +-
 .../ram_daemon_interface/index.html           |   6 +-
 .../ram_file_info/index.html                  |   6 +-
 .../ram_file_manager/index.html               |   6 +-
 .../add-ons-reference/ram_filetype/index.html |   6 +-
 .../dev/add-ons-reference/ram_item/index.html |   6 +-
 .../ram_metadata_manager/index.html           |   6 +-
 .../add-ons-reference/ram_object/index.html   |   6 +-
 .../dev/add-ons-reference/ram_pipe/index.html |   6 +-
 .../add-ons-reference/ram_pipefile/index.html |   6 +-
 .../add-ons-reference/ram_project/index.html  |   6 +-
 .../add-ons-reference/ram_sequence/index.html |   6 +-
 .../add-ons-reference/ram_settings/index.html |   6 +-
 .../dev/add-ons-reference/ram_shot/index.html |   6 +-
 .../add-ons-reference/ram_state/index.html    |   6 +-
 .../add-ons-reference/ram_status/index.html   |   6 +-
 .../dev/add-ons-reference/ram_step/index.html |   6 +-
 .../dev/add-ons-reference/ram_user/index.html |   6 +-
 docs/dev/add-ons-reference/ramses/index.html  |   6 +-
 docs/dev/daemon-reference/create/index.html   |   6 +-
 .../getCurrentProject/index.html              |   6 +-
 docs/dev/daemon-reference/getData/index.html  |   6 +-
 .../daemon-reference/getObjects/index.html    |   6 +-
 docs/dev/daemon-reference/getPath/index.html  |   6 +-
 .../daemon-reference/getProjects/index.html   |   6 +-
 .../getRamsesFolder/index.html                |   6 +-
 docs/dev/daemon-reference/index.html          |   6 +-
 docs/dev/daemon-reference/ping/index.html     |   6 +-
 docs/dev/daemon-reference/raise/index.html    |   6 +-
 .../setCurrentProject/index.html              |   6 +-
 docs/dev/daemon-reference/setData/index.html  |   6 +-
 .../daemon-reference/uuidFromPath/index.html  |   6 +-
 docs/dev/files/naming/index.html              |   6 +-
 docs/dev/index.html                           |   6 +-
 docs/dev/objects/index.html                   |   6 +-
 docs/dev/server-reference/index.html          |   6 +-
 docs/index.html                               |  10 +-
 docs/licenses/gfdl/index.html                 |   6 +-
 docs/licenses/gnu-gpl/index.html              |   6 +-
 docs/pipeline/administration/index.html       |   6 +-
 docs/pipeline/index.html                      |   6 +-
 docs/pipeline/pipeline/index.html             |   6 +-
 docs/pipeline/planning/index.html             |   6 +-
 docs/pipeline/production/index.html           |   6 +-
 docs/quickstart/index.html                    |   4 +-
 docs/search/lunr.js                           |  24 +-
 docs/search/main.js                           |   6 +-
 docs/search/search_index.json                 |   2 +-
 docs/search/worker.js                         |   3 +
 docs/sitemap.xml                              | 855 ++++++++++--------
 docs/sitemap.xml.gz                           | Bin 800 -> 796 bytes
 src-docs/docs/changelog-api.md                |   8 +-
 src-docs/docs/changelog-app.md                |  22 +-
 src-docs/docs/changelog-maya.md               |   8 +-
 src-docs/docs/changelog-server.md             |  17 +-
 src-docs/mkdocs.yml                           |   2 +-
 106 files changed, 915 insertions(+), 731 deletions(-)

diff --git a/docs/changelog-api/index.html b/docs/changelog-api/index.html
index 40951f04..3e2f3265 100644
--- a/docs/changelog-api/index.html
+++ b/docs/changelog-api/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../quickstart/">Quick start</a>
+                <a href="../quickstart/">Quick start</a>
             </li>
         
         
@@ -1309,27 +1309,35 @@
     <div class="bs-sidebar hidden-print affix well" role="complementary">
         <ul class="nav bs-sidenav">
             <li class="first-level active"><a href="#ramses-api-changelog">Ramses API Changelog</a></li>
-                <li class="second-level"><a href="#060-beta">0.6.0-Beta</a></li>
+                <li class="second-level"><a href="#070-beta">0.7.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#new">New</a></li>
-                <li class="second-level"><a href="#050-beta">0.5.0-Beta</a></li>
+                <li class="second-level"><a href="#060-beta">0.6.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#new_1">New</a></li>
+                <li class="second-level"><a href="#050-beta">0.5.0-Beta</a></li>
+                    
+                    <li class="third-level"><a href="#new_2">New</a></li>
         </ul>
     </div>
     <div class="footer-meta"></div>
 </div></div>
         <div class="col-md-9" role="main">
 
-<p><img alt="META" src="authors:Nicolas &quot;Duduf&quot; Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/01" /></p>
+<p><img alt="META" src="authors:Nicolas &quot;Duduf&quot; Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/20" /></p>
 <h1 id="ramses-api-changelog">Ramses API Changelog</h1>
-<h2 id="060-beta">0.6.0-Beta</h2>
+<h2 id="070-beta">0.7.0-Beta</h2>
 <h3 id="new">New</h3>
 <ul>
+<li>0.7.0 compatibility update.</li>
+</ul>
+<h2 id="060-beta">0.6.0-Beta</h2>
+<h3 id="new_1">New</h3>
+<ul>
 <li>0.6.0 compatibility update.</li>
 </ul>
 <h2 id="050-beta">0.5.0-Beta</h2>
-<h3 id="new_1">New</h3>
+<h3 id="new_2">New</h3>
 <ul>
 <li>Changed and simplified data exchange.</li>
 <li>Added step general settings</li>
diff --git a/docs/changelog-app/index.html b/docs/changelog-app/index.html
index 141cccd6..f8ee53ce 100644
--- a/docs/changelog-app/index.html
+++ b/docs/changelog-app/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../quickstart/">Quick start</a>
+                <a href="../quickstart/">Quick start</a>
             </li>
         
         
@@ -1309,55 +1309,67 @@
     <div class="bs-sidebar hidden-print affix well" role="complementary">
         <ul class="nav bs-sidenav">
             <li class="first-level active"><a href="#ramses-application-changelog">Ramses Application Changelog</a></li>
-                <li class="second-level"><a href="#known-issues">Known Issues</a></li>
-                    
-                <li class="second-level"><a href="#060-beta">0.6.0-Beta</a></li>
+                <li class="second-level"><a href="#070-beta">0.7.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#new">New</a></li>
                     <li class="third-level"><a href="#improvements">Improvements</a></li>
                     <li class="third-level"><a href="#fixes">Fixes</a></li>
-                <li class="second-level"><a href="#050-beta">0.5.0-Beta</a></li>
+                <li class="second-level"><a href="#060-beta">0.6.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#new_1">New</a></li>
-                <li class="second-level"><a href="#030-alpha">0.3.0-Alpha</a></li>
+                    <li class="third-level"><a href="#improvements_1">Improvements</a></li>
+                    <li class="third-level"><a href="#fixes_1">Fixes</a></li>
+                <li class="second-level"><a href="#050-beta">0.5.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#new_2">New</a></li>
-                    <li class="third-level"><a href="#improvements_1">Improvements</a></li>
+                <li class="second-level"><a href="#030-alpha">0.3.0-Alpha</a></li>
+                    
+                    <li class="third-level"><a href="#new_3">New</a></li>
+                    <li class="third-level"><a href="#improvements_2">Improvements</a></li>
         </ul>
     </div>
     <div class="footer-meta"></div>
 </div></div>
         <div class="col-md-9" role="main">
 
-<p><img alt="META" src="authors:Nicolas &quot;Duduf&quot; Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/01" /></p>
+<p><img alt="META" src="authors:Nicolas &quot;Duduf&quot; Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/20" /></p>
 <h1 id="ramses-application-changelog">Ramses Application Changelog</h1>
-<h2 id="known-issues">Known Issues</h2>
+<h2 id="070-beta">0.7.0-Beta</h2>
+<h3 id="new">New</h3>
+<ul>
+<li>New syncing methods with the <em>Ramses Server</em> which are slower but more reliable, especially with big sets of data.</li>
+</ul>
+<h3 id="improvements">Improvements</h3>
+<ul>
+<li>Performance improvements, especially with big sets of data</li>
+</ul>
+<h3 id="fixes">Fixes</h3>
 <ul>
-<li><strong><em><a href="https://github.com/RxLaboratory/Ramses/issues/263">#263</a></em></strong>: The client may crash when removing a project which is not empty.</li>
-<li>On <strong><em>Windows</em></strong>, the tray icon may not be removed if the client crashes.</li>
-<li>On <strong><em>Mac OS</em></strong>, the user specific settings (current project, location of the nodes in the pipeline editor, &hellip;) may not be saved.</li>
-<li>On <strong><em>Linux</em></strong>, interaction with the timeline may be limited (impossible to select a shot, or open its folder).</li>
+<li>Fixed potential crash when loading some items from the <em>Ramses Scripting API</em>.</li>
+<li>Fixed potential crash when adding entries to the schedule.</li>
+<li>Fixed potential crash when loading specific databases.</li>
+<li>Fixed schedule entries which may not be correctly shown. No data was lost, it was just a display issue.</li>
 </ul>
 <h2 id="060-beta">0.6.0-Beta</h2>
-<h3 id="new">New</h3>
+<h3 id="new_1">New</h3>
 <ul>
 <li>It is now possible to set the port to use to connect to the server.</li>
 <li>Database manager/cleaner (for administrators)</li>
 </ul>
-<h3 id="improvements">Improvements</h3>
+<h3 id="improvements_1">Improvements</h3>
 <ul>
 <li>A local database can now connect only to the server it was intended to.</li>
 <li>The application can now show the server logs.</li>
 <li>Better log and display of errors</li>
 <li>Set to offline in case of server errors.</li>
 </ul>
-<h3 id="fixes">Fixes</h3>
+<h3 id="fixes_1">Fixes</h3>
 <ul>
 <li>Fixed performance issues with the schedule.</li>
 <li>The resolution of the projects is now correctly saved.</li>
 </ul>
 <h2 id="050-beta">0.5.0-Beta</h2>
-<h3 id="new_1">New</h3>
+<h3 id="new_2">New</h3>
 <ul>
 <li>Many UI and preformance improvements.</li>
 <li>Implemented the <em>Offline mode</em></li>
@@ -1365,7 +1377,7 @@ <h3 id="new_1">New</h3>
 <li>Added step general settings</li>
 </ul>
 <h2 id="030-alpha">0.3.0-Alpha</h2>
-<h3 id="new_2">New</h3>
+<h3 id="new_3">New</h3>
 <ul>
 <li>Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password “password” and you’ll have to update all passwords for all users from that account to re-enable their accounts.</li>
 <li>The Client shows the current RxLab’s funding status.</li>
@@ -1373,7 +1385,7 @@ <h3 id="new_2">New</h3>
 <li>Added publish settings to steps, to be used with add-ons.</li>
 <li>added a log level selector to the console.</li>
 </ul>
-<h3 id="improvements_1">Improvements</h3>
+<h3 id="improvements_2">Improvements</h3>
 <ul>
 <li>The status of the connexion (offline, connected, secured) is now shown on the status bar. A warning is logged when the connexion is not secured.</li>
 <li>Changing the file type of a step automatically updates the custom settings accordingly.</li>
diff --git a/docs/changelog-maya/index.html b/docs/changelog-maya/index.html
index 56b157b5..4e653cb5 100644
--- a/docs/changelog-maya/index.html
+++ b/docs/changelog-maya/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../quickstart/">Quick start</a>
+                <a href="../quickstart/">Quick start</a>
             </li>
         
         
@@ -1309,15 +1309,18 @@
     <div class="bs-sidebar hidden-print affix well" role="complementary">
         <ul class="nav bs-sidenav">
             <li class="first-level active"><a href="#ramses-laya-add-on-changelog">Ramses Laya Add-on Changelog</a></li>
-                <li class="second-level"><a href="#060-beta">0.6.0-Beta</a></li>
+                <li class="second-level"><a href="#070-beta">0.7.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#fixes">Fixes</a></li>
-                <li class="second-level"><a href="#052-beta">0.5.2-Beta</a></li>
+                <li class="second-level"><a href="#060-beta">0.6.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#fixes_1">Fixes</a></li>
-                <li class="second-level"><a href="#051-beta">0.5.1-Beta</a></li>
+                <li class="second-level"><a href="#052-beta">0.5.2-Beta</a></li>
                     
                     <li class="third-level"><a href="#fixes_2">Fixes</a></li>
+                <li class="second-level"><a href="#051-beta">0.5.1-Beta</a></li>
+                    
+                    <li class="third-level"><a href="#fixes_3">Fixes</a></li>
                 <li class="second-level"><a href="#050-beta">0.5.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#new">New</a></li>
@@ -1330,20 +1333,25 @@
 </div></div>
         <div class="col-md-9" role="main">
 
-<p><img alt="META" src="authors:Nicolas &quot;Duduf&quot; Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/01" /></p>
+<p><img alt="META" src="authors:Nicolas &quot;Duduf&quot; Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/20" /></p>
 <h1 id="ramses-laya-add-on-changelog">Ramses Laya Add-on Changelog</h1>
-<h2 id="060-beta">0.6.0-Beta</h2>
+<h2 id="070-beta">0.7.0-Beta</h2>
 <h3 id="fixes">Fixes</h3>
 <ul>
+<li>Fixed &lsquo;save scene as&rsquo; failing with random items.</li>
+</ul>
+<h2 id="060-beta">0.6.0-Beta</h2>
+<h3 id="fixes_1">Fixes</h3>
+<ul>
 <li>Fixed &lsquo;save scene as&rsquo; with incorrect step settings</li>
 </ul>
 <h2 id="052-beta">0.5.2-Beta</h2>
-<h3 id="fixes_1">Fixes</h3>
+<h3 id="fixes_2">Fixes</h3>
 <ul>
 <li>Fixed &lsquo;save scene as&rsquo; when the corresponding step doesn&rsquo;t have any general setting</li>
 </ul>
 <h2 id="051-beta">0.5.1-Beta</h2>
-<h3 id="fixes_2">Fixes</h3>
+<h3 id="fixes_3">Fixes</h3>
 <ul>
 <li>Removed duplicate formats in import settings</li>
 <li>Don&rsquo;t add selection to sets during scene setup</li>
diff --git a/docs/changelog-server/index.html b/docs/changelog-server/index.html
index 02c76f05..ec9c99bb 100644
--- a/docs/changelog-server/index.html
+++ b/docs/changelog-server/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../quickstart/">Quick start</a>
+                <a href="../quickstart/">Quick start</a>
             </li>
         
         
@@ -1309,61 +1309,78 @@
     <div class="bs-sidebar hidden-print affix well" role="complementary">
         <ul class="nav bs-sidenav">
             <li class="first-level active"><a href="#ramses-server-changelog">Ramses Server Changelog</a></li>
-                <li class="second-level"><a href="#060-beta">0.6.0-Beta</a></li>
+                <li class="second-level"><a href="#070-beta">0.7.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#new">New</a></li>
                     <li class="third-level"><a href="#fixes">Fixes</a></li>
-                <li class="second-level"><a href="#051-beta">0.5.1-Beta</a></li>
+                <li class="second-level"><a href="#060-beta">0.6.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#new_1">New</a></li>
                     <li class="third-level"><a href="#fixes_1">Fixes</a></li>
-                <li class="second-level"><a href="#050-beta">0.5.0-Beta</a></li>
+                <li class="second-level"><a href="#051-beta">0.5.1-Beta</a></li>
                     
                     <li class="third-level"><a href="#new_2">New</a></li>
-                <li class="second-level"><a href="#030-alpha">0.3.0-Alpha</a></li>
+                    <li class="third-level"><a href="#fixes_2">Fixes</a></li>
+                <li class="second-level"><a href="#050-beta">0.5.0-Beta</a></li>
                     
                     <li class="third-level"><a href="#new_3">New</a></li>
+                <li class="second-level"><a href="#030-alpha">0.3.0-Alpha</a></li>
+                    
+                    <li class="third-level"><a href="#new_4">New</a></li>
         </ul>
     </div>
     <div class="footer-meta"></div>
 </div></div>
         <div class="col-md-9" role="main">
 
-<p><img alt="META" src="authors:Nicolas &quot;Duduf&quot; Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/01" /></p>
+<p><img alt="META" src="authors:Nicolas &quot;Duduf&quot; Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/20" /></p>
 <h1 id="ramses-server-changelog">Ramses Server Changelog</h1>
-<h2 id="060-beta">0.6.0-Beta</h2>
+<h2 id="070-beta">0.7.0-Beta</h2>
+<p>Starting with this version, the <em>Ramses Server</em> is compatible only with versions of MySQL more recent than 8.0, though it can still use SQLite too.</p>
 <h3 id="new">New</h3>
 <ul>
+<li>New syncing methods which are slower but more reliable, especially with big sets of data.</li>
+<li>Improved performance with big sets of data.</li>
+<li>When using SQLite, &lsquo;VACUUM&rsquo; is run at regular intervals to optimize the size of the file and fix potential issues with failed queries.</li>
+<li>Refuse client connexions if they&rsquo;re using the wrong version.</li>
+</ul>
+<h3 id="fixes">Fixes</h3>
+<ul>
+<li>Accepts requests with missing &lsquo;Content-Type&rsquo; header. Assumes it&rsquo;s <em>JSON</em> by default.</li>
+</ul>
+<h2 id="060-beta">0.6.0-Beta</h2>
+<h3 id="new_1">New</h3>
+<ul>
 <li>We now provide tested <em>Docker</em> configurations to easily install and run <em>Ramses Docker containers</em>.</li>
 <li>Each instance of a <em>Ramses Server</em> now had a unique universal identifier (UUID) to make sure a client won&rsquo;t connect to a wrong server by mistake.</li>
 <li>Added new server-side logs.</li>
 <li>The <em>login</em> requests now returns details (data) about the connected user (if login is successful).</li>
 <li>Ability to deactivate the session timeout.</li>
 </ul>
-<h3 id="fixes">Fixes</h3>
+<h3 id="fixes_1">Fixes</h3>
 <ul>
 <li>Fixed the user table in case a (removed) username already exists when creating a new user.</li>
 <li>Fixed installation issues when using <em>SQLite</em>.</li>
 </ul>
 <h2 id="051-beta">0.5.1-Beta</h2>
-<h3 id="new_1">New</h3>
+<h3 id="new_2">New</h3>
 <ul>
 <li>Added (debug) logs to the replies which can be shown by clients.</li>
 </ul>
-<h3 id="fixes_1">Fixes</h3>
+<h3 id="fixes_2">Fixes</h3>
 <ul>
 <li>Fixed issues when table prefixes start with a number.</li>
 <li>Fixed connection issues when the URL ends with a /</li>
 <li>Ignore some sync errors when not in Dev mode</li>
 </ul>
 <h2 id="050-beta">0.5.0-Beta</h2>
-<h3 id="new_2">New</h3>
+<h3 id="new_3">New</h3>
 <ul>
 <li>Changed and simplified data exchange.</li>
 <li>Added step general settings</li>
 </ul>
 <h2 id="030-alpha">0.3.0-Alpha</h2>
-<h3 id="new_3">New</h3>
+<h3 id="new_4">New</h3>
 <ul>
 <li>The Rubika Flavor is merged into the official add-on.</li>
 <li>Added update command</li>
diff --git a/docs/changelog/index.html b/docs/changelog/index.html
index 11849818..40c6b653 100644
--- a/docs/changelog/index.html
+++ b/docs/changelog/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../quickstart/">Quick start</a>
+                <a href="../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/addons/index.html b/docs/components/addons/index.html
index 158ade47..2790c3a2 100644
--- a/docs/components/addons/index.html
+++ b/docs/components/addons/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/addons/maya-extend/index.html b/docs/components/addons/maya-extend/index.html
index 7e1eb1b1..d24285a2 100644
--- a/docs/components/addons/maya-extend/index.html
+++ b/docs/components/addons/maya-extend/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/addons/maya-import/index.html b/docs/components/addons/maya-import/index.html
index 75643899..1f0a7d39 100644
--- a/docs/components/addons/maya-import/index.html
+++ b/docs/components/addons/maya-import/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/addons/maya-pipeline/index.html b/docs/components/addons/maya-pipeline/index.html
index 9a2cc6ca..ef2cfcc9 100644
--- a/docs/components/addons/maya-pipeline/index.html
+++ b/docs/components/addons/maya-pipeline/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/addons/maya-publish/index.html b/docs/components/addons/maya-publish/index.html
index f28a489e..170adc95 100644
--- a/docs/components/addons/maya-publish/index.html
+++ b/docs/components/addons/maya-publish/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/addons/maya-scenesetup/index.html b/docs/components/addons/maya-scenesetup/index.html
index 23b13c8e..e56ea49f 100644
--- a/docs/components/addons/maya-scenesetup/index.html
+++ b/docs/components/addons/maya-scenesetup/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/addons/maya/index.html b/docs/components/addons/maya/index.html
index e3f30b6b..9dcd4872 100644
--- a/docs/components/addons/maya/index.html
+++ b/docs/components/addons/maya/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/admin/index.html b/docs/components/client/admin/index.html
index 8b711643..55c0ba75 100644
--- a/docs/components/client/admin/index.html
+++ b/docs/components/client/admin/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/applications/index.html b/docs/components/client/applications/index.html
index acc04201..00214f2a 100644
--- a/docs/components/client/applications/index.html
+++ b/docs/components/client/applications/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/assetgroups/index.html b/docs/components/client/assetgroups/index.html
index 4f9d07bb..c408ac42 100644
--- a/docs/components/client/assetgroups/index.html
+++ b/docs/components/client/assetgroups/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/assets/index.html b/docs/components/client/assets/index.html
index b9483d96..ba7a021e 100644
--- a/docs/components/client/assets/index.html
+++ b/docs/components/client/assets/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/filetypes/index.html b/docs/components/client/filetypes/index.html
index 6ced40a5..0e405886 100644
--- a/docs/components/client/filetypes/index.html
+++ b/docs/components/client/filetypes/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/index.html b/docs/components/client/index.html
index ce3595d5..2da2a0a5 100644
--- a/docs/components/client/index.html
+++ b/docs/components/client/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/install/index.html b/docs/components/client/install/index.html
index 2add0fe9..d5eeb691 100644
--- a/docs/components/client/install/index.html
+++ b/docs/components/client/install/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/pipeline/index.html b/docs/components/client/pipeline/index.html
index 1065476e..71903754 100644
--- a/docs/components/client/pipeline/index.html
+++ b/docs/components/client/pipeline/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/pipetypes/index.html b/docs/components/client/pipetypes/index.html
index 1a748fed..d03e567d 100644
--- a/docs/components/client/pipetypes/index.html
+++ b/docs/components/client/pipetypes/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/production/index.html b/docs/components/client/production/index.html
index 5ebe2238..1283ac12 100644
--- a/docs/components/client/production/index.html
+++ b/docs/components/client/production/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/project/index.html b/docs/components/client/project/index.html
index 2876b834..94b85869 100644
--- a/docs/components/client/project/index.html
+++ b/docs/components/client/project/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/projects/index.html b/docs/components/client/projects/index.html
index 27fc0572..c4e7f627 100644
--- a/docs/components/client/projects/index.html
+++ b/docs/components/client/projects/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/schedule/index.html b/docs/components/client/schedule/index.html
index 80ffe19f..9ab93a84 100644
--- a/docs/components/client/schedule/index.html
+++ b/docs/components/client/schedule/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/sequences/index.html b/docs/components/client/sequences/index.html
index 49196b64..08063a32 100644
--- a/docs/components/client/sequences/index.html
+++ b/docs/components/client/sequences/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/settings/index.html b/docs/components/client/settings/index.html
index 62e2443f..7ec5ec52 100644
--- a/docs/components/client/settings/index.html
+++ b/docs/components/client/settings/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/shots/index.html b/docs/components/client/shots/index.html
index d483be16..80277d0c 100644
--- a/docs/components/client/shots/index.html
+++ b/docs/components/client/shots/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/states/index.html b/docs/components/client/states/index.html
index 21366013..0ab8f661 100644
--- a/docs/components/client/states/index.html
+++ b/docs/components/client/states/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/steps/index.html b/docs/components/client/steps/index.html
index 615c74a1..969c6482 100644
--- a/docs/components/client/steps/index.html
+++ b/docs/components/client/steps/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/templateassetgroups/index.html b/docs/components/client/templateassetgroups/index.html
index a5b08eca..0ef7ac66 100644
--- a/docs/components/client/templateassetgroups/index.html
+++ b/docs/components/client/templateassetgroups/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/templatesteps/index.html b/docs/components/client/templatesteps/index.html
index c73d8dc6..8e5e8695 100644
--- a/docs/components/client/templatesteps/index.html
+++ b/docs/components/client/templatesteps/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/client/users/index.html b/docs/components/client/users/index.html
index 41b61a70..9d0b0c6e 100644
--- a/docs/components/client/users/index.html
+++ b/docs/components/client/users/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/files/index.html b/docs/components/files/index.html
index a57f5c22..8e3b9eca 100644
--- a/docs/components/files/index.html
+++ b/docs/components/files/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/files/naming/index.html b/docs/components/files/naming/index.html
index 4dd466f7..71949a08 100644
--- a/docs/components/files/naming/index.html
+++ b/docs/components/files/naming/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/files/tree/index.html b/docs/components/files/tree/index.html
index 9c53cd8d..f44a356e 100644
--- a/docs/components/files/tree/index.html
+++ b/docs/components/files/tree/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/index.html b/docs/components/index.html
index f0d4480f..adc76efe 100644
--- a/docs/components/index.html
+++ b/docs/components/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../quickstart/">Quick start</a>
+                <a href="../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/server/admin/index.html b/docs/components/server/admin/index.html
index c3b28f95..5e7e4c71 100644
--- a/docs/components/server/admin/index.html
+++ b/docs/components/server/admin/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/server/config/index.html b/docs/components/server/config/index.html
index 02a4f45d..5224d1b1 100644
--- a/docs/components/server/config/index.html
+++ b/docs/components/server/config/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/server/index.html b/docs/components/server/index.html
index e061d417..8139db1a 100644
--- a/docs/components/server/index.html
+++ b/docs/components/server/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/server/install-docker-mysql/index.html b/docs/components/server/install-docker-mysql/index.html
index ee10838b..52c5f53b 100644
--- a/docs/components/server/install-docker-mysql/index.html
+++ b/docs/components/server/install-docker-mysql/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/server/install-docker-sqlite/index.html b/docs/components/server/install-docker-sqlite/index.html
index 8bba178d..07c6415a 100644
--- a/docs/components/server/install-docker-sqlite/index.html
+++ b/docs/components/server/install-docker-sqlite/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/server/install-src/index.html b/docs/components/server/install-src/index.html
index e31040de..56742e39 100644
--- a/docs/components/server/install-src/index.html
+++ b/docs/components/server/install-src/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/server/install/index.html b/docs/components/server/install/index.html
index fc3a90e2..9753d3c0 100644
--- a/docs/components/server/install/index.html
+++ b/docs/components/server/install/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/components/server/update/index.html b/docs/components/server/update/index.html
index 0fbd14bc..9bd82764 100644
--- a/docs/components/server/update/index.html
+++ b/docs/components/server/update/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/credits/index.html b/docs/credits/index.html
index 626f52e4..14f84146 100644
--- a/docs/credits/index.html
+++ b/docs/credits/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../quickstart/">Quick start</a>
+                <a href="../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/enum/index.html b/docs/dev/add-ons-reference/enum/index.html
index eb7baaf4..ccbead7c 100644
--- a/docs/dev/add-ons-reference/enum/index.html
+++ b/docs/dev/add-ons-reference/enum/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/implementation/index.html b/docs/dev/add-ons-reference/implementation/index.html
index 839f3475..47dac3a3 100644
--- a/docs/dev/add-ons-reference/implementation/index.html
+++ b/docs/dev/add-ons-reference/implementation/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/index.html b/docs/dev/add-ons-reference/index.html
index 36c67322..9e986f98 100644
--- a/docs/dev/add-ons-reference/index.html
+++ b/docs/dev/add-ons-reference/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_asset/index.html b/docs/dev/add-ons-reference/ram_asset/index.html
index 92b1a64f..d4c8a397 100644
--- a/docs/dev/add-ons-reference/ram_asset/index.html
+++ b/docs/dev/add-ons-reference/ram_asset/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_assetgroup/index.html b/docs/dev/add-ons-reference/ram_assetgroup/index.html
index 3e642182..e6eeda21 100644
--- a/docs/dev/add-ons-reference/ram_assetgroup/index.html
+++ b/docs/dev/add-ons-reference/ram_assetgroup/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_daemon_interface/index.html b/docs/dev/add-ons-reference/ram_daemon_interface/index.html
index c284e1ac..102a7a3e 100644
--- a/docs/dev/add-ons-reference/ram_daemon_interface/index.html
+++ b/docs/dev/add-ons-reference/ram_daemon_interface/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_file_info/index.html b/docs/dev/add-ons-reference/ram_file_info/index.html
index 880493d2..5b777d59 100644
--- a/docs/dev/add-ons-reference/ram_file_info/index.html
+++ b/docs/dev/add-ons-reference/ram_file_info/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_file_manager/index.html b/docs/dev/add-ons-reference/ram_file_manager/index.html
index 6a25d837..d2ef0a1e 100644
--- a/docs/dev/add-ons-reference/ram_file_manager/index.html
+++ b/docs/dev/add-ons-reference/ram_file_manager/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_filetype/index.html b/docs/dev/add-ons-reference/ram_filetype/index.html
index f9b03da2..103ceed5 100644
--- a/docs/dev/add-ons-reference/ram_filetype/index.html
+++ b/docs/dev/add-ons-reference/ram_filetype/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_item/index.html b/docs/dev/add-ons-reference/ram_item/index.html
index 32e4edad..6af10e23 100644
--- a/docs/dev/add-ons-reference/ram_item/index.html
+++ b/docs/dev/add-ons-reference/ram_item/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_metadata_manager/index.html b/docs/dev/add-ons-reference/ram_metadata_manager/index.html
index d2d54958..ac3f5626 100644
--- a/docs/dev/add-ons-reference/ram_metadata_manager/index.html
+++ b/docs/dev/add-ons-reference/ram_metadata_manager/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_object/index.html b/docs/dev/add-ons-reference/ram_object/index.html
index 7786c7d5..f6e0afdc 100644
--- a/docs/dev/add-ons-reference/ram_object/index.html
+++ b/docs/dev/add-ons-reference/ram_object/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_pipe/index.html b/docs/dev/add-ons-reference/ram_pipe/index.html
index ec2c1590..35dfaa05 100644
--- a/docs/dev/add-ons-reference/ram_pipe/index.html
+++ b/docs/dev/add-ons-reference/ram_pipe/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_pipefile/index.html b/docs/dev/add-ons-reference/ram_pipefile/index.html
index ae8332b1..da06ed7d 100644
--- a/docs/dev/add-ons-reference/ram_pipefile/index.html
+++ b/docs/dev/add-ons-reference/ram_pipefile/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_project/index.html b/docs/dev/add-ons-reference/ram_project/index.html
index f3c812f0..8add943b 100644
--- a/docs/dev/add-ons-reference/ram_project/index.html
+++ b/docs/dev/add-ons-reference/ram_project/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_sequence/index.html b/docs/dev/add-ons-reference/ram_sequence/index.html
index 7f7fec95..c5d87da3 100644
--- a/docs/dev/add-ons-reference/ram_sequence/index.html
+++ b/docs/dev/add-ons-reference/ram_sequence/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_settings/index.html b/docs/dev/add-ons-reference/ram_settings/index.html
index df218a7b..60ab1ba4 100644
--- a/docs/dev/add-ons-reference/ram_settings/index.html
+++ b/docs/dev/add-ons-reference/ram_settings/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_shot/index.html b/docs/dev/add-ons-reference/ram_shot/index.html
index 27fd1c8d..611b695a 100644
--- a/docs/dev/add-ons-reference/ram_shot/index.html
+++ b/docs/dev/add-ons-reference/ram_shot/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_state/index.html b/docs/dev/add-ons-reference/ram_state/index.html
index c440059f..aee1929a 100644
--- a/docs/dev/add-ons-reference/ram_state/index.html
+++ b/docs/dev/add-ons-reference/ram_state/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_status/index.html b/docs/dev/add-ons-reference/ram_status/index.html
index a2556a90..7b28ce9d 100644
--- a/docs/dev/add-ons-reference/ram_status/index.html
+++ b/docs/dev/add-ons-reference/ram_status/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_step/index.html b/docs/dev/add-ons-reference/ram_step/index.html
index 239ea9bf..efb9d622 100644
--- a/docs/dev/add-ons-reference/ram_step/index.html
+++ b/docs/dev/add-ons-reference/ram_step/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ram_user/index.html b/docs/dev/add-ons-reference/ram_user/index.html
index 78dfadbf..d1d9c4a9 100644
--- a/docs/dev/add-ons-reference/ram_user/index.html
+++ b/docs/dev/add-ons-reference/ram_user/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/add-ons-reference/ramses/index.html b/docs/dev/add-ons-reference/ramses/index.html
index 0089be16..0926616f 100644
--- a/docs/dev/add-ons-reference/ramses/index.html
+++ b/docs/dev/add-ons-reference/ramses/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/create/index.html b/docs/dev/daemon-reference/create/index.html
index 216455ac..c66c6d27 100644
--- a/docs/dev/daemon-reference/create/index.html
+++ b/docs/dev/daemon-reference/create/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/getCurrentProject/index.html b/docs/dev/daemon-reference/getCurrentProject/index.html
index 809bd1b3..fcde31e3 100644
--- a/docs/dev/daemon-reference/getCurrentProject/index.html
+++ b/docs/dev/daemon-reference/getCurrentProject/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/getData/index.html b/docs/dev/daemon-reference/getData/index.html
index 6d100eb5..c0fe0038 100644
--- a/docs/dev/daemon-reference/getData/index.html
+++ b/docs/dev/daemon-reference/getData/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/getObjects/index.html b/docs/dev/daemon-reference/getObjects/index.html
index 7824e215..ce97588e 100644
--- a/docs/dev/daemon-reference/getObjects/index.html
+++ b/docs/dev/daemon-reference/getObjects/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/getPath/index.html b/docs/dev/daemon-reference/getPath/index.html
index 9a247b35..e43879f8 100644
--- a/docs/dev/daemon-reference/getPath/index.html
+++ b/docs/dev/daemon-reference/getPath/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/getProjects/index.html b/docs/dev/daemon-reference/getProjects/index.html
index fa630ae8..6900c312 100644
--- a/docs/dev/daemon-reference/getProjects/index.html
+++ b/docs/dev/daemon-reference/getProjects/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/getRamsesFolder/index.html b/docs/dev/daemon-reference/getRamsesFolder/index.html
index 22d700e0..d9d8e945 100644
--- a/docs/dev/daemon-reference/getRamsesFolder/index.html
+++ b/docs/dev/daemon-reference/getRamsesFolder/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/index.html b/docs/dev/daemon-reference/index.html
index cdc6bb25..95063af3 100644
--- a/docs/dev/daemon-reference/index.html
+++ b/docs/dev/daemon-reference/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/ping/index.html b/docs/dev/daemon-reference/ping/index.html
index 09089cba..cc29d9dc 100644
--- a/docs/dev/daemon-reference/ping/index.html
+++ b/docs/dev/daemon-reference/ping/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/raise/index.html b/docs/dev/daemon-reference/raise/index.html
index c82c63dd..3711cdfa 100644
--- a/docs/dev/daemon-reference/raise/index.html
+++ b/docs/dev/daemon-reference/raise/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/setCurrentProject/index.html b/docs/dev/daemon-reference/setCurrentProject/index.html
index 055291ae..94b6f504 100644
--- a/docs/dev/daemon-reference/setCurrentProject/index.html
+++ b/docs/dev/daemon-reference/setCurrentProject/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/setData/index.html b/docs/dev/daemon-reference/setData/index.html
index 0298132d..a83c46d5 100644
--- a/docs/dev/daemon-reference/setData/index.html
+++ b/docs/dev/daemon-reference/setData/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/daemon-reference/uuidFromPath/index.html b/docs/dev/daemon-reference/uuidFromPath/index.html
index 9a9c75f6..5b5599a4 100644
--- a/docs/dev/daemon-reference/uuidFromPath/index.html
+++ b/docs/dev/daemon-reference/uuidFromPath/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/files/naming/index.html b/docs/dev/files/naming/index.html
index b3a8d06b..efe607ab 100644
--- a/docs/dev/files/naming/index.html
+++ b/docs/dev/files/naming/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../../..">v0.6 (Beta)</a>
+                        <a href="../../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../../../..">v0.6 (Beta)</a>
+                <a href="../../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../../../quickstart/">Quick start</a>
+                <a href="../../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/index.html b/docs/dev/index.html
index 601b64c6..f57799b9 100644
--- a/docs/dev/index.html
+++ b/docs/dev/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../quickstart/">Quick start</a>
+                <a href="../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/objects/index.html b/docs/dev/objects/index.html
index c8695fb7..ad7afd8e 100644
--- a/docs/dev/objects/index.html
+++ b/docs/dev/objects/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/dev/server-reference/index.html b/docs/dev/server-reference/index.html
index d4fe2548..47d1e2cf 100644
--- a/docs/dev/server-reference/index.html
+++ b/docs/dev/server-reference/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/index.html b/docs/index.html
index 7d1fabe8..dcfc9bfb 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -11,7 +11,7 @@
     <link rel="shortcut icon" href="img/favicon.ico">
 
     
-    <title>v0.6 (Beta) - Ramses</title>
+    <title>v0.7 (Beta) - Ramses</title>
     
 
     <link rel="stylesheet" href="css/fontawesome.css">
@@ -72,7 +72,7 @@
                 
                 
                     <li class="active">
-                        <a href=".">v0.6 (Beta)</a>
+                        <a href=".">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,7 +820,7 @@
         
         
             <li class="active">
-                <a href=".">v0.6 (Beta)</a>
+                <a href=".">v0.7 (Beta)</a>
             </li>
         
         
@@ -1529,6 +1529,6 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 </html>
 
 <!--
-MkDocs version : 1.1.2
-Build Date UTC : 2022-11-02 08:40:19.612911+00:00
+MkDocs version : 1.2.3
+Build Date UTC : 2022-11-20 15:05:53.908559+00:00
 -->
diff --git a/docs/licenses/gfdl/index.html b/docs/licenses/gfdl/index.html
index 08b2443c..6ce38b9c 100644
--- a/docs/licenses/gfdl/index.html
+++ b/docs/licenses/gfdl/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/licenses/gnu-gpl/index.html b/docs/licenses/gnu-gpl/index.html
index 24fb1c65..0020610c 100644
--- a/docs/licenses/gnu-gpl/index.html
+++ b/docs/licenses/gnu-gpl/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/pipeline/administration/index.html b/docs/pipeline/administration/index.html
index 2f44fdf6..f5e3d5d0 100644
--- a/docs/pipeline/administration/index.html
+++ b/docs/pipeline/administration/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/pipeline/index.html b/docs/pipeline/index.html
index 8801ef4a..09f5801a 100644
--- a/docs/pipeline/index.html
+++ b/docs/pipeline/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../quickstart/">Quick start</a>
+                <a href="../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/pipeline/pipeline/index.html b/docs/pipeline/pipeline/index.html
index 47ab71ea..a966d51a 100644
--- a/docs/pipeline/pipeline/index.html
+++ b/docs/pipeline/pipeline/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/pipeline/planning/index.html b/docs/pipeline/planning/index.html
index 449e8fe9..7e9d12f7 100644
--- a/docs/pipeline/planning/index.html
+++ b/docs/pipeline/planning/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/pipeline/production/index.html b/docs/pipeline/production/index.html
index fb6e7c6a..40b24be3 100644
--- a/docs/pipeline/production/index.html
+++ b/docs/pipeline/production/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="../..">v0.6 (Beta)</a>
+                        <a href="../..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,13 +820,13 @@
         
         
             <li >
-                <a href="../../../..">v0.6 (Beta)</a>
+                <a href="../..">v0.7 (Beta)</a>
             </li>
         
         
         
             <li >
-                <a href="../../../../quickstart/">Quick start</a>
+                <a href="../../quickstart/">Quick start</a>
             </li>
         
         
diff --git a/docs/quickstart/index.html b/docs/quickstart/index.html
index 2697d404..61df156f 100644
--- a/docs/quickstart/index.html
+++ b/docs/quickstart/index.html
@@ -72,7 +72,7 @@
                 
                 
                     <li >
-                        <a href="..">v0.6 (Beta)</a>
+                        <a href="..">v0.7 (Beta)</a>
                     </li>
                 
                 
@@ -820,7 +820,7 @@
         
         
             <li >
-                <a href="../..">v0.6 (Beta)</a>
+                <a href="..">v0.7 (Beta)</a>
             </li>
         
         
diff --git a/docs/search/lunr.js b/docs/search/lunr.js
index 4ca0c508..6aa370fb 100644
--- a/docs/search/lunr.js
+++ b/docs/search/lunr.js
@@ -1,6 +1,6 @@
 /**
  * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  * @license MIT
  */
 
@@ -57,7 +57,7 @@ var lunr = function (config) {
 lunr.version = "2.3.9"
 /*!
  * lunr.utils
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -177,7 +177,7 @@ lunr.FieldRef.prototype.toString = function () {
 }
 /*!
  * lunr.Set
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -389,7 +389,7 @@ lunr.Token.prototype.clone = function (fn) {
 }
 /*!
  * lunr.tokenizer
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -465,7 +465,7 @@ lunr.tokenizer = function (obj, metadata) {
 lunr.tokenizer.separator = /[\s\-]+/
 /*!
  * lunr.Pipeline
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -732,7 +732,7 @@ lunr.Pipeline.prototype.toJSON = function () {
 }
 /*!
  * lunr.Vector
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -929,7 +929,7 @@ lunr.Vector.prototype.toJSON = function () {
 /* eslint-disable */
 /*!
  * lunr.stemmer
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt
  */
 
@@ -1151,7 +1151,7 @@ lunr.stemmer = (function(){
 lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')
 /*!
  * lunr.stopWordFilter
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -1316,7 +1316,7 @@ lunr.stopWordFilter = lunr.generateStopWordFilter([
 lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')
 /*!
  * lunr.trimmer
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -1343,7 +1343,7 @@ lunr.trimmer = function (token) {
 lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')
 /*!
  * lunr.TokenSet
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -1827,7 +1827,7 @@ lunr.TokenSet.Builder.prototype.minimize = function (downTo) {
 }
 /*!
  * lunr.Index
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
@@ -2319,7 +2319,7 @@ lunr.Index.load = function (serializedIndex) {
 }
 /*!
  * lunr.Builder
- * Copyright (C) 2021 Oliver Nightingale
+ * Copyright (C) 2020 Oliver Nightingale
  */
 
 /**
diff --git a/docs/search/main.js b/docs/search/main.js
index 0e1fc811..c5ccfa61 100644
--- a/docs/search/main.js
+++ b/docs/search/main.js
@@ -37,7 +37,11 @@ function displayResults (results) {
       search_results.insertAdjacentHTML('beforeend', html);
     }
   } else {
-    search_results.insertAdjacentHTML('beforeend', "<p>No results found</p>");
+    var noResultsText = search_results.getAttribute('data-no-results-text');
+    if (!noResultsText) {
+      noResultsText = "No results found";
+    }
+    search_results.insertAdjacentHTML('beforeend', '<p>' + noResultsText + '</p>');
   }
 }
 
diff --git a/docs/search/search_index.json b/docs/search/search_index.json
index c7d7f232..8494a51b 100644
--- a/docs/search/search_index.json
+++ b/docs/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Ramses - The Rx Asset Management System Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . What\u2019s this? Ramses , the Rx Asset Management System, is a complete framework to help you, your team, your studio, track the production of your films. It is meant to be used both by freelancers, small or big teams. Let\u2019s have a look at a few key features. \u25b9 Read the changelog to know exactly what\u2019s already available and what\u2019s planned (along with known issues) \u25b9 Free and open source Ramses is licensed under the GNU General Public License v3, which means you\u2019re free to do anything you\u2019d like with it, use it the way you want, modify it, and share your modifications. \u25b9 Production Planning Ramses helps you easily plan your production , and estimate how long you\u2019ll need to produce your project. For each shot and asset of the project, you\u2019ll be able to (automatically) estimate how long it will take to produce, and Ramses will keep track of all estimations for you so you can plan accordingly. \u25b8 Read more \u25b9 Production Tracking At any time, Ramses can tell you where you are in the production, how late (or not) you are, and warn you if something\u2019s going wrong. You can always keep a close (or overall) look at the production , and check which assets and shots are longer or shorter to produce, and the state in which they are at any time. \u25b8 Read more \u25b9 Pipeline automation In combination with the Ramses Add-ons which integrate Ramses in your favorite creative software, Ramses is able to automate your pipeline , managing the versionning of the files, the exports, imports and all these manual tasks a robot could do for you. An example: the Autodesk Maya shelf of the Ramses Maya Add-on. With a nice and modern nodal view, it\u2019s easy to design your pipeline, connecting each step and setting how the data should go from one step to the other. All this information will be used both by the Ramses production tracking algorithms and the Add-ons to help you focus on your real work: creation . \u25b8 Read more \u25b9 (Very) Easy-to-use A tool like Ramses is here to help, not to give you a headache. All user interface components have been carefully crafted to be beautiful, but most of all to be intuitive and practical . Everything has to be clear, precise, and meaningful. Of course, there\u2019s this comprehensive documentation if you have any doubt\u2026 \u25b9 And also\u2026 Why would one want to track one\u2019s production from a web browser? Ramses comes with its own native application for Linux , Mac OS and Windows . It\u2019s designed to by very light and unintrusive, fast and responsive. It ususally takes about ten times less memory than a usual web-browser with a single tab opened. Ramses is extensible . Although it already comes with some add-ons for your creative software, if you have specific needs, you can use the provided Python and Adobe ExtendScript API , to implement your own add-ons which fully integrate with both Ramses and your creative applications. The Daemon and the Server API are also fully documented. And, after all, Ramses is open source! Ramses can manage all your files : the idea is that you won\u2019t ever need to search for any file through the system\u2019s explorer. \u25b9 The future Ramses is (far from) not finished . And probably never will: it is going to evolve, and there are a lot of other planned features and improvements on their way! \u25b9 Read the changelog for more details about what\u2019s going on, and known issues Here are some of the features which are not available yet but which will be available in the future. The Dashboard will be an area where each user accesses all its important data and schedule. It comes with notifications so you won\u2019t miss any change concerning your assets, shots and steps. Project Planning : a simple but indispensable tool to easily plan the production of the project, at the very beginning of the production. With this planning tool you will be able to set the important dates of the production, the deadlines for each step, all in an easy-to-use and visual panel. Status automation : when a character is rigged, it means it\u2019s ready to be animated. Status automation will automatically update the states of all the items according to the pipeline design, and your custom rules. Data export and import : if you\u2019re planning important software update, or for your backups at the end of a production, it may be useful to export and re-import your data. File tools will provide automatic ways to manage your files, create new assets and shots from already existing files, clean the tree, backup, remove temporary data, batch rename files and folders\u2026 Editing tools to manage your shots from your edits. Automatically set shot duration, order and other metadata by just importing your edit. A lot of UI improvements and tweaks are planned too, and work will be done to improve the performance of the Ramses Client Application even further. Syncthing integration will provide a free, open, and secure way to synchronize all files and data of your production accross multiple workstations, servers, NAS, etc. There\u2019s also a lot of ongoing work to extend the supported creative applications through Ramses Add-ons. \u25b9 Read the Add-ons section for a detailed list of existing and planned add-ons License Software The software this documentation is referring to is licensed under the GNU General Public License . Copyright (C) 2020 Nicolas Dufresne and Contributors. This program is free software; you can redistribute them and/or modify them under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program . If not, see http://www.gnu.org/licenses/ . Icons and other graphical elements All graphical elements, especially icons, are from RxUI by Nicolas Dufresne and RxLaboratory are licensed under CC BY-NC-SA 4.0 . Copyright (C) 2021 Nicolas Dufresne and Contributors. This Documentation Copyright (C) 2020 Nicolas Dufresne and Contributors. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled \u201c Documentation License \u201d.","title":"v0.6 (Beta)"},{"location":"#ramses-the-rx-asset-management-system","text":"Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues .","title":"Ramses - The Rx Asset Management System"},{"location":"#whats-this","text":"Ramses , the Rx Asset Management System, is a complete framework to help you, your team, your studio, track the production of your films. It is meant to be used both by freelancers, small or big teams. Let\u2019s have a look at a few key features. \u25b9 Read the changelog to know exactly what\u2019s already available and what\u2019s planned (along with known issues)","title":"What's this?"},{"location":"#free-and-open-source","text":"Ramses is licensed under the GNU General Public License v3, which means you\u2019re free to do anything you\u2019d like with it, use it the way you want, modify it, and share your modifications.","title":"\u25b9 Free and open source"},{"location":"#production-planning","text":"Ramses helps you easily plan your production , and estimate how long you\u2019ll need to produce your project. For each shot and asset of the project, you\u2019ll be able to (automatically) estimate how long it will take to produce, and Ramses will keep track of all estimations for you so you can plan accordingly. \u25b8 Read more","title":"\u25b9 Production Planning"},{"location":"#production-tracking","text":"At any time, Ramses can tell you where you are in the production, how late (or not) you are, and warn you if something\u2019s going wrong. You can always keep a close (or overall) look at the production , and check which assets and shots are longer or shorter to produce, and the state in which they are at any time. \u25b8 Read more","title":"\u25b9 Production Tracking"},{"location":"#pipeline-automation","text":"In combination with the Ramses Add-ons which integrate Ramses in your favorite creative software, Ramses is able to automate your pipeline , managing the versionning of the files, the exports, imports and all these manual tasks a robot could do for you. An example: the Autodesk Maya shelf of the Ramses Maya Add-on. With a nice and modern nodal view, it\u2019s easy to design your pipeline, connecting each step and setting how the data should go from one step to the other. All this information will be used both by the Ramses production tracking algorithms and the Add-ons to help you focus on your real work: creation . \u25b8 Read more","title":"\u25b9 Pipeline automation"},{"location":"#very-easy-to-use","text":"A tool like Ramses is here to help, not to give you a headache. All user interface components have been carefully crafted to be beautiful, but most of all to be intuitive and practical . Everything has to be clear, precise, and meaningful. Of course, there\u2019s this comprehensive documentation if you have any doubt\u2026","title":"\u25b9 (Very) Easy-to-use"},{"location":"#and-also","text":"Why would one want to track one\u2019s production from a web browser? Ramses comes with its own native application for Linux , Mac OS and Windows . It\u2019s designed to by very light and unintrusive, fast and responsive. It ususally takes about ten times less memory than a usual web-browser with a single tab opened. Ramses is extensible . Although it already comes with some add-ons for your creative software, if you have specific needs, you can use the provided Python and Adobe ExtendScript API , to implement your own add-ons which fully integrate with both Ramses and your creative applications. The Daemon and the Server API are also fully documented. And, after all, Ramses is open source! Ramses can manage all your files : the idea is that you won\u2019t ever need to search for any file through the system\u2019s explorer.","title":"\u25b9 And also..."},{"location":"#the-future","text":"Ramses is (far from) not finished . And probably never will: it is going to evolve, and there are a lot of other planned features and improvements on their way! \u25b9 Read the changelog for more details about what\u2019s going on, and known issues Here are some of the features which are not available yet but which will be available in the future. The Dashboard will be an area where each user accesses all its important data and schedule. It comes with notifications so you won\u2019t miss any change concerning your assets, shots and steps. Project Planning : a simple but indispensable tool to easily plan the production of the project, at the very beginning of the production. With this planning tool you will be able to set the important dates of the production, the deadlines for each step, all in an easy-to-use and visual panel. Status automation : when a character is rigged, it means it\u2019s ready to be animated. Status automation will automatically update the states of all the items according to the pipeline design, and your custom rules. Data export and import : if you\u2019re planning important software update, or for your backups at the end of a production, it may be useful to export and re-import your data. File tools will provide automatic ways to manage your files, create new assets and shots from already existing files, clean the tree, backup, remove temporary data, batch rename files and folders\u2026 Editing tools to manage your shots from your edits. Automatically set shot duration, order and other metadata by just importing your edit. A lot of UI improvements and tweaks are planned too, and work will be done to improve the performance of the Ramses Client Application even further. Syncthing integration will provide a free, open, and secure way to synchronize all files and data of your production accross multiple workstations, servers, NAS, etc. There\u2019s also a lot of ongoing work to extend the supported creative applications through Ramses Add-ons. \u25b9 Read the Add-ons section for a detailed list of existing and planned add-ons","title":"\u25b9 The future"},{"location":"#license","text":"","title":"License"},{"location":"#software","text":"The software this documentation is referring to is licensed under the GNU General Public License . Copyright (C) 2020 Nicolas Dufresne and Contributors. This program is free software; you can redistribute them and/or modify them under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program . If not, see http://www.gnu.org/licenses/ .","title":"Software"},{"location":"#icons-and-other-graphical-elements","text":"All graphical elements, especially icons, are from RxUI by Nicolas Dufresne and RxLaboratory are licensed under CC BY-NC-SA 4.0 . Copyright (C) 2021 Nicolas Dufresne and Contributors.","title":"Icons and other graphical elements"},{"location":"#this-documentation","text":"Copyright (C) 2020 Nicolas Dufresne and Contributors. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled \u201c Documentation License \u201d.","title":"This Documentation"},{"location":"changelog-api/","text":"Ramses API Changelog 0.6.0-Beta New 0.6.0 compatibility update. 0.5.0-Beta New Changed and simplified data exchange. Added step general settings","title":"API"},{"location":"changelog-api/#ramses-api-changelog","text":"","title":"Ramses API Changelog"},{"location":"changelog-api/#060-beta","text":"","title":"0.6.0-Beta"},{"location":"changelog-api/#new","text":"0.6.0 compatibility update.","title":"New"},{"location":"changelog-api/#050-beta","text":"","title":"0.5.0-Beta"},{"location":"changelog-api/#new_1","text":"Changed and simplified data exchange. Added step general settings","title":"New"},{"location":"changelog-app/","text":"Ramses Application Changelog Known Issues #263 : The client may crash when removing a project which is not empty. On Windows , the tray icon may not be removed if the client crashes. On Mac OS , the user specific settings (current project, location of the nodes in the pipeline editor, \u2026) may not be saved. On Linux , interaction with the timeline may be limited (impossible to select a shot, or open its folder). 0.6.0-Beta New It is now possible to set the port to use to connect to the server. Database manager/cleaner (for administrators) Improvements A local database can now connect only to the server it was intended to. The application can now show the server logs. Better log and display of errors Set to offline in case of server errors. Fixes Fixed performance issues with the schedule. The resolution of the projects is now correctly saved. 0.5.0-Beta New Many UI and preformance improvements. Implemented the Offline mode Changed and simplified data exchange. Added step general settings 0.3.0-Alpha New Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password \u201cpassword\u201d and you\u2019ll have to update all passwords for all users from that account to re-enable their accounts. The Client shows the current RxLab\u2019s funding status. The schedule now has a dedicated line to add notes/comments. Added publish settings to steps, to be used with add-ons. added a log level selector to the console. Improvements The status of the connexion (offline, connected, secured) is now shown on the status bar. A warning is logged when the connexion is not secured. Changing the file type of a step automatically updates the custom settings accordingly.","title":"Application"},{"location":"changelog-app/#ramses-application-changelog","text":"","title":"Ramses Application Changelog"},{"location":"changelog-app/#known-issues","text":"#263 : The client may crash when removing a project which is not empty. On Windows , the tray icon may not be removed if the client crashes. On Mac OS , the user specific settings (current project, location of the nodes in the pipeline editor, \u2026) may not be saved. On Linux , interaction with the timeline may be limited (impossible to select a shot, or open its folder).","title":"Known Issues"},{"location":"changelog-app/#060-beta","text":"","title":"0.6.0-Beta"},{"location":"changelog-app/#new","text":"It is now possible to set the port to use to connect to the server. Database manager/cleaner (for administrators)","title":"New"},{"location":"changelog-app/#improvements","text":"A local database can now connect only to the server it was intended to. The application can now show the server logs. Better log and display of errors Set to offline in case of server errors.","title":"Improvements"},{"location":"changelog-app/#fixes","text":"Fixed performance issues with the schedule. The resolution of the projects is now correctly saved.","title":"Fixes"},{"location":"changelog-app/#050-beta","text":"","title":"0.5.0-Beta"},{"location":"changelog-app/#new_1","text":"Many UI and preformance improvements. Implemented the Offline mode Changed and simplified data exchange. Added step general settings","title":"New"},{"location":"changelog-app/#030-alpha","text":"","title":"0.3.0-Alpha"},{"location":"changelog-app/#new_2","text":"Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password \u201cpassword\u201d and you\u2019ll have to update all passwords for all users from that account to re-enable their accounts. The Client shows the current RxLab\u2019s funding status. The schedule now has a dedicated line to add notes/comments. Added publish settings to steps, to be used with add-ons. added a log level selector to the console.","title":"New"},{"location":"changelog-app/#improvements_1","text":"The status of the connexion (offline, connected, secured) is now shown on the status bar. A warning is logged when the connexion is not secured. Changing the file type of a step automatically updates the custom settings accordingly.","title":"Improvements"},{"location":"changelog-maya/","text":"Ramses Laya Add-on Changelog 0.6.0-Beta Fixes Fixed \u2018save scene as\u2019 with incorrect step settings 0.5.2-Beta Fixes Fixed \u2018save scene as\u2019 when the corresponding step doesn\u2019t have any general setting 0.5.1-Beta Fixes Removed duplicate formats in import settings Don\u2019t add selection to sets during scene setup Fixed publish with missing shaders 0.5.0-Beta New Completely changed (and simplified) the server API to support syncing with clients. Warning: this update is not compatible with older versions. As we\u2019re moving from Alpha to Beta test, there\u2019s no way to migrate your data when updating this time, as we were just testing the framework. Now that we\u2019re in Beta test, this is fixed and future updates won\u2019t break compatibility anymore. 0.3.0-Alpha New Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password \u201cpassword\u201d and you\u2019ll have to update all passwords for all users from that account to re-enable their accounts. The schedule now has a dedicated line to add notes/comments. Added publish settings to steps, to be used with add-ons.","title":"Maya"},{"location":"changelog-maya/#ramses-laya-add-on-changelog","text":"","title":"Ramses Laya Add-on Changelog"},{"location":"changelog-maya/#060-beta","text":"","title":"0.6.0-Beta"},{"location":"changelog-maya/#fixes","text":"Fixed \u2018save scene as\u2019 with incorrect step settings","title":"Fixes"},{"location":"changelog-maya/#052-beta","text":"","title":"0.5.2-Beta"},{"location":"changelog-maya/#fixes_1","text":"Fixed \u2018save scene as\u2019 when the corresponding step doesn\u2019t have any general setting","title":"Fixes"},{"location":"changelog-maya/#051-beta","text":"","title":"0.5.1-Beta"},{"location":"changelog-maya/#fixes_2","text":"Removed duplicate formats in import settings Don\u2019t add selection to sets during scene setup Fixed publish with missing shaders","title":"Fixes"},{"location":"changelog-maya/#050-beta","text":"","title":"0.5.0-Beta"},{"location":"changelog-maya/#new","text":"Completely changed (and simplified) the server API to support syncing with clients. Warning: this update is not compatible with older versions. As we\u2019re moving from Alpha to Beta test, there\u2019s no way to migrate your data when updating this time, as we were just testing the framework. Now that we\u2019re in Beta test, this is fixed and future updates won\u2019t break compatibility anymore.","title":"New"},{"location":"changelog-maya/#030-alpha","text":"","title":"0.3.0-Alpha"},{"location":"changelog-maya/#new_1","text":"Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password \u201cpassword\u201d and you\u2019ll have to update all passwords for all users from that account to re-enable their accounts. The schedule now has a dedicated line to add notes/comments. Added publish settings to steps, to be used with add-ons.","title":"New"},{"location":"changelog-server/","text":"Ramses Server Changelog 0.6.0-Beta New We now provide tested Docker configurations to easily install and run Ramses Docker containers . Each instance of a Ramses Server now had a unique universal identifier (UUID) to make sure a client won\u2019t connect to a wrong server by mistake. Added new server-side logs. The login requests now returns details (data) about the connected user (if login is successful). Ability to deactivate the session timeout. Fixes Fixed the user table in case a (removed) username already exists when creating a new user. Fixed installation issues when using SQLite . 0.5.1-Beta New Added (debug) logs to the replies which can be shown by clients. Fixes Fixed issues when table prefixes start with a number. Fixed connection issues when the URL ends with a / Ignore some sync errors when not in Dev mode 0.5.0-Beta New Changed and simplified data exchange. Added step general settings 0.3.0-Alpha New The Rubika Flavor is merged into the official add-on. Added update command Added publish settings Added import and update settings","title":"Server"},{"location":"changelog-server/#ramses-server-changelog","text":"","title":"Ramses Server Changelog"},{"location":"changelog-server/#060-beta","text":"","title":"0.6.0-Beta"},{"location":"changelog-server/#new","text":"We now provide tested Docker configurations to easily install and run Ramses Docker containers . Each instance of a Ramses Server now had a unique universal identifier (UUID) to make sure a client won\u2019t connect to a wrong server by mistake. Added new server-side logs. The login requests now returns details (data) about the connected user (if login is successful). Ability to deactivate the session timeout.","title":"New"},{"location":"changelog-server/#fixes","text":"Fixed the user table in case a (removed) username already exists when creating a new user. Fixed installation issues when using SQLite .","title":"Fixes"},{"location":"changelog-server/#051-beta","text":"","title":"0.5.1-Beta"},{"location":"changelog-server/#new_1","text":"Added (debug) logs to the replies which can be shown by clients.","title":"New"},{"location":"changelog-server/#fixes_1","text":"Fixed issues when table prefixes start with a number. Fixed connection issues when the URL ends with a / Ignore some sync errors when not in Dev mode","title":"Fixes"},{"location":"changelog-server/#050-beta","text":"","title":"0.5.0-Beta"},{"location":"changelog-server/#new_2","text":"Changed and simplified data exchange. Added step general settings","title":"New"},{"location":"changelog-server/#030-alpha","text":"","title":"0.3.0-Alpha"},{"location":"changelog-server/#new_3","text":"The Rubika Flavor is merged into the official add-on. Added update command Added publish settings Added import and update settings","title":"New"},{"location":"changelog/","text":"Ramses Changelog By component \u25b9 Ramses Application \u25b9 Ramses Maya Add-on \u25b9 Ramses Server \u25b9 Ramses API Versions Ramses uses semantic versionning to keep track of changes and versions. Versions numbers always have this form: M.m.p where M is the major version number, m is the minor version number and p is the patch number. Ramses Components should be considered compatible together if and only if they share the same major and minor version numbers , although if only the minor version number differs everything should still work. That means if you update a component to a new major or minor version, all other components should be updated too. For example, a 0.6.0 application will work perfectly with a 0.6.2 server, but it may have minor issues with a 0.7.0 server and it will not work with a 1.1.0 server. Note Versions ending with -Alpha or -Beta are released for testing purposes only and should not be used in production, unless you know what you\u2019re doing. In versions labeled Alpha , the APIs may still vary a lot, especially for versions still in 0.x . Changes are mentionned in this changelog. Planned Features The detailed list of planned features and enhancements is available on Github . The Dashboard will be an area where each user accesses all its important data and schedule. It comes with notifications so you won\u2019t miss any change concerning your assets, shots and steps. Project Planning : a simple but indispensable tool to easily plan the production of the project, at the very beginning of the production. With this planning tool you will be able to set the important dates of the production, the deadlines for each step, all in an easy-to-use and visual panel. Status automation : when a character is rigged, it means it\u2019s ready to be animated. Status automation will automatically update the states of all the items according to the pipeline design, and your custom rules. Data export and import : if you\u2019re planning important software update, or for your backups at the end of a production, it may be useful to export and re-import your data. File tools will provide automatic ways to manage your files, create new assets and shots from already existing files, clean the tree, backup, remove temporary data, batch rename files and folders\u2026 Video Editing tools to manage your shots from your edits. Automatically set shot duration, order and other metadata by just importing your edit from a Final Cut XML , EDL or CSV file. A lot of UI improvements and tweaks are planned too, and work will be done to improve the performance of the Ramses Client Application even further. Folder monitoring will provide a way to handle versionning and production tracking even if there\u2019s no Ramses Add-on available for the application being used. Syncthing integration will provide a free, open, and secure way to synchronize all files and data of your production accross multiple workstations, servers, NAS, etc.","title":"General"},{"location":"changelog/#ramses-changelog","text":"","title":"Ramses Changelog"},{"location":"changelog/#by-component","text":"\u25b9 Ramses Application \u25b9 Ramses Maya Add-on \u25b9 Ramses Server \u25b9 Ramses API","title":"By component"},{"location":"changelog/#versions","text":"Ramses uses semantic versionning to keep track of changes and versions. Versions numbers always have this form: M.m.p where M is the major version number, m is the minor version number and p is the patch number. Ramses Components should be considered compatible together if and only if they share the same major and minor version numbers , although if only the minor version number differs everything should still work. That means if you update a component to a new major or minor version, all other components should be updated too. For example, a 0.6.0 application will work perfectly with a 0.6.2 server, but it may have minor issues with a 0.7.0 server and it will not work with a 1.1.0 server. Note Versions ending with -Alpha or -Beta are released for testing purposes only and should not be used in production, unless you know what you\u2019re doing. In versions labeled Alpha , the APIs may still vary a lot, especially for versions still in 0.x . Changes are mentionned in this changelog.","title":"Versions"},{"location":"changelog/#planned-features","text":"The detailed list of planned features and enhancements is available on Github . The Dashboard will be an area where each user accesses all its important data and schedule. It comes with notifications so you won\u2019t miss any change concerning your assets, shots and steps. Project Planning : a simple but indispensable tool to easily plan the production of the project, at the very beginning of the production. With this planning tool you will be able to set the important dates of the production, the deadlines for each step, all in an easy-to-use and visual panel. Status automation : when a character is rigged, it means it\u2019s ready to be animated. Status automation will automatically update the states of all the items according to the pipeline design, and your custom rules. Data export and import : if you\u2019re planning important software update, or for your backups at the end of a production, it may be useful to export and re-import your data. File tools will provide automatic ways to manage your files, create new assets and shots from already existing files, clean the tree, backup, remove temporary data, batch rename files and folders\u2026 Video Editing tools to manage your shots from your edits. Automatically set shot duration, order and other metadata by just importing your edit from a Final Cut XML , EDL or CSV file. A lot of UI improvements and tweaks are planned too, and work will be done to improve the performance of the Ramses Client Application even further. Folder monitoring will provide a way to handle versionning and production tracking even if there\u2019s no Ramses Add-on available for the application being used. Syncthing integration will provide a free, open, and secure way to synchronize all files and data of your production accross multiple workstations, servers, NAS, etc.","title":"Planned Features"},{"location":"credits/","text":"Credits Ramses, which is and stays free, could not exist without your support and contributions . Many thanks to all people who made this possible . Copyright \u00a9 2021-2022 Nicolas Dufresne, RxLaboratory and Contributors. All Rights Reserved - https://rxlaboratory.org Special thanks to all the supporters of Duduf on Patreon . Development Lead developper Nicolas \u201cDuduf\u201d Dufresne Developpers and code contributors Lisa Lain\u00e9 (Python API) Jean-Philippe Luchez (Python API) Testers Juan David Almanza Ana Arce Daniel Arce Fran\u00e7ois Bonni\u00e8re Micka\u00ebl Gantois Philippe Meis Camilo Jos\u00e9 Rivera Varona Rubika - Supinfocom, the Promotheus & the Promhub Translations Third-party libraries and other code Qt licensed under the GNU GPLv3 OpenSSL licensed under the OpenSSL License and the SSLeay License Documentation Text Nicolas Dufresne Pictures and Media Files Funding Rainbox Productions All the 583 backers from the RxOT Crowdfunding Campaign and especially: Adam Aguirre, Adam Buritsch, Adam Knight, Adrien Boutin, Adrien du Repaire, aembury, aescripts + aeplugins , A\u00efda del Solar, Alejandro R. Gonzalez, Aleksander Saharovsky, Alex Beekman, Alexandre FAVRE, alietout, Amit Gicelter, Ana Arce, Ana\u00efs Guigue, Andreas Tanner, andrewrakestraw, Anez Florez Corpus, Anne Frumin, ANTOINE BIEBER, Antoine Dueso, Antonis Petroulias, Antony Pastor, Archita Ghosh, Armelle Renac, Atelier Graphoui, audrey sysaykeo, Aur\u00e9lien Delamare, aur\u00e9lien malagoli, Autret Claude, Baptiste Cochard, Bartosz B\u0105k, basimabu, Bastien Bironneau, Bastien Delmare, Ben Fligans, Benjamin Cohen-Jonathan, Benjamin Trancart, benoit jodry, Bethany Vaughan, Breece Kelsey, Brent N Walker, Brian Kolm, Bruno Quintin, Busson Remy, Calinski julien, Cam Hayduk, Cameron Gough, Carlos Arandia, Caroline Maire, Cedric Layrac, C\u00e9dric Serres, C\u00e9lia Tocco, Celine Sanno, Ching Mok, Chlo\u00e9 Chatellier, chris kieffer, Christophe \u2018IKESU\u2019 Clarey, Claire Dejoie, cl\u00e9ment Laporte, Cl\u00e9ment Vernet, Coleen Lochabay, Colin Brain, Com\u2019of design, damien.bracciotti , Dan Hollacher, Daniel Arce, Daniel Budka, David Hoizey, David Polizelli Hoffmann, david.baril, Davide Bedocchi, Derek Lau, djstep1, Dmitry Abdeev, Ebube Onyema, Elen Le Tannou, Elisabeth Springer, Emiliano Martinez, Emilien Gillet, Eric Bardot, Eric Beaup\u00e8re, Eric Paoli Infanzon, Eriks Lapins, eva.lacuskova, eva.lacuskova, Fabien Nowak, Fanny Moulin, Fernando Ferreira da Costa Junior, Florent Bonneviale, Florent Guilbaud, Francis Banguet, Fran\u00e7ois QUILLARD, Fred Luzet, fuerst.pascal, George Bowler, Germain Cauvy, Giedrius Budrys, gil, Gilles Pfeiffer, Giz Beardon, greg.araya, GRELIER Florentine, Guave Studios GmbH Guave Motion, GU\u00c9RET Matthieu, Guido Mariano, Guilbert Sylvain, Guillaume Mariotti, Guillaume Marrou, Guillaume Polveche, Guillaume Rousseau, Gustavo Almenara, Gustavo Miaciro, Gwendal Le Naour, gyom h, H Robert Marquet \u201cBob\u201d, H\u00e5kon Lundvall, Harlem Harl, Herv\u00e9 Dumont, Hiromi Ishibashi, Hristina Braykova, Ilya Gusinski, INSITE SCOP, Jacek Jefimiuk, Jack Kasprzak, Jakub Adam Makowski, Jared Mark Graham, Jason Jantzen, Javier Villalba, Jean-Baptiste Quaghebeur, Jean-Baptiste Sanno, Jean-Damien Gros, Jean-Philippe Albaret, Jean-Philippe Jambert, Jeff Cooney, Jeremi Picard, Jeremy Pluvinage, Jesse Kerman, Joachim Schwarz, Joakim Ottosson, Joe Brooks, Joel PiTrel, Johannes Krohn, John Nelson, Jonas Hummelstrand, jonasgreulich, Jose Carlos Conde Acuaviva, jose gerardo arce lopez, joshua.gslaby, Juan David Almanza Lamo, Juanca Flores, Julie Faussard, Julien Brugi\u00e8re, Julien Gouz, Julien Pilarski, Julien Pilipczuk, Karyl GAUTIER, Kate Jessop, Keizo Abe, kim nari, Kirby Conn, Kris Bosmans, Krista van der Wilk, Lars , Latham Arnott, Laura Marchant, Laura Palmer, Laurent Kanadiou Freyre, Lea Str, Lemesre Julien Erase-studio, Lenny Pomerantz, LES FILMS DU NORD, Liguori Nicolas, Luca Pecori, Luigi De Frenza, Maeva Pensivy, Manuel Viqueira Carballal, Marc Messiaen, Marco Oggero, Maresch & Sturm, Mario Burbach, Mario Hounkanrin, Marion PATIN, Martial Coulon, Martin Pageot, Martine Carton, matanarbel, Mathieu Faure, Mathieu JACOULET, Mathieu Travi, Mathilde Boudet, Matt Lloyd, Matthew Fernandez, matthewacarrick, Matthias Jach, Matthieu Fremeaux, megamonkees , Merlin Pardo, Michael Gorbachev, Michael Helmrich, Mickael Carton, Micka\u00ebl Hernandez, morgan, Motion Caf\u00e9, Motion Design Studio BRUSSOBAUM, MrGlox , muftix, Mysteropodes Drouin, Neil Ingle, Nic Dean, nicolas bougere, Nicolas Castelli, Nicolas Chaunu, Nicolas Dehaut, Nicolas DIDION, Nicolas Dufresne, Nicolas Grandry, nicolas matelot, nicolas.palmier, nicole alman, nirl28, Norbert Radvanyi, Nothing to Hide, Nuno Trindade, Nycolas Gorizian, Oana Nechifor, Olivier Escher, Olivier Jean, Olivier Patt\u00e9, onillon.thierry, P Yalaoui, Pauline DE, Payage Mickael, pdicamillo12, Philip P Betts, Philipp Reinhardt, Philippe Mignot, Philippe VECI, Pierre Cornille, Pierre Jond, pierre marteel, Pierre Munier, Pierre W. Borne, Pierre-Alain L\u00e9croart, Pierre-Baptiste Harrivelle, QingRu Yu, Rapha\u00eblle Prud\u2019homme, R\u00e9mi Rongier, Renaud DANIEL, Renaud Mazotti, Ren\u00e9 Andritsch, Ricardo Abraham Ibarra Duarte, Ricardo Arce, Robin CARLO, Rodrigo Dominguez Salazar, Romy Tokic, Ronald Anzenberger, Ronny Andr\u00e4, Ronny Andr\u00e4, Roth Fr\u00e9d\u00e9ric, Roxana Rodriguez, Ruben Alejandro Trejo Segura, Ruben Gim\u00e9nez, ruldewuold, Ryan Sears, SAINT RAYMOND, Sam Burkardt, Samuel Van Ingen, samy tichadou, Saul Yance Echegaray, S\u00e9bastien GAETTA, Sebastien Mesnage, Sebastien Vincent, Sergey Vodianov, Shao H, shirley natasha pinto, Simon Hervieu, Simon Stojanovski, Songz Meng, Sonya Robine, Sorrentino Ana\u00efs, Spenser Williams, Stein WILD, Stephane Neau, St\u00e9phane Zissu, Stephanie Leonard, Stephen Richard, Steve Pratt, Sylvain Kauffmann, Tao Mao, THAN TRONG Frederic, Thiago Maia, Thomas Crausaz, Thomas Duphil, Thomas Prinzivalli, thrawn, Tiago Castro, Tim Martyn, Tom Conner, Tomas \u00c4rlemo, Tom\u00e1\u0161 Hon\u011bk, Tomas Spokauskas, traffic.in.the.skies, Trebalag Ludovic, Ty Bardi, Vadim Luks, Valentin Nozahic, Val\u00e9rie WINTZ, Valleron Nicolas, vendu, Veronica Delgado, Vicidomini Lionel, Viliam Snirc, Viliam Snirc, Villain Cedric, Vitaliy Movsha, Voignier lisa, Warren D M Reed, wlazinski matthieu, Xavier Golfier, Yan-Ali Tabarand, Yavor Popov, Yaya Gadon, Yohan Le Diraison, Yohann GAMBA, Yoran Legemble, Zach Prichard, Zden\u011bk Dovole, Z\u00e9t\u00e9ny V\u00f6r\u00f6s. Thank you! Without your generous support, Ramses would not exist.","title":"Credits"},{"location":"credits/#credits","text":"Ramses, which is and stays free, could not exist without your support and contributions . Many thanks to all people who made this possible . Copyright \u00a9 2021-2022 Nicolas Dufresne, RxLaboratory and Contributors. All Rights Reserved - https://rxlaboratory.org Special thanks to all the supporters of Duduf on Patreon .","title":"Credits"},{"location":"credits/#development","text":"","title":"Development"},{"location":"credits/#lead-developper","text":"Nicolas \u201cDuduf\u201d Dufresne","title":"Lead developper"},{"location":"credits/#developpers-and-code-contributors","text":"Lisa Lain\u00e9 (Python API) Jean-Philippe Luchez (Python API)","title":"Developpers and code contributors"},{"location":"credits/#testers","text":"Juan David Almanza Ana Arce Daniel Arce Fran\u00e7ois Bonni\u00e8re Micka\u00ebl Gantois Philippe Meis Camilo Jos\u00e9 Rivera Varona Rubika - Supinfocom, the Promotheus & the Promhub","title":"Testers"},{"location":"credits/#translations","text":"","title":"Translations"},{"location":"credits/#third-party-libraries-and-other-code","text":"Qt licensed under the GNU GPLv3 OpenSSL licensed under the OpenSSL License and the SSLeay License","title":"Third-party libraries and other code"},{"location":"credits/#documentation","text":"","title":"Documentation"},{"location":"credits/#text","text":"Nicolas Dufresne","title":"Text"},{"location":"credits/#pictures-and-media-files","text":"","title":"Pictures and Media Files"},{"location":"credits/#funding","text":"Rainbox Productions All the 583 backers from the RxOT Crowdfunding Campaign and especially: Adam Aguirre, Adam Buritsch, Adam Knight, Adrien Boutin, Adrien du Repaire, aembury, aescripts + aeplugins , A\u00efda del Solar, Alejandro R. Gonzalez, Aleksander Saharovsky, Alex Beekman, Alexandre FAVRE, alietout, Amit Gicelter, Ana Arce, Ana\u00efs Guigue, Andreas Tanner, andrewrakestraw, Anez Florez Corpus, Anne Frumin, ANTOINE BIEBER, Antoine Dueso, Antonis Petroulias, Antony Pastor, Archita Ghosh, Armelle Renac, Atelier Graphoui, audrey sysaykeo, Aur\u00e9lien Delamare, aur\u00e9lien malagoli, Autret Claude, Baptiste Cochard, Bartosz B\u0105k, basimabu, Bastien Bironneau, Bastien Delmare, Ben Fligans, Benjamin Cohen-Jonathan, Benjamin Trancart, benoit jodry, Bethany Vaughan, Breece Kelsey, Brent N Walker, Brian Kolm, Bruno Quintin, Busson Remy, Calinski julien, Cam Hayduk, Cameron Gough, Carlos Arandia, Caroline Maire, Cedric Layrac, C\u00e9dric Serres, C\u00e9lia Tocco, Celine Sanno, Ching Mok, Chlo\u00e9 Chatellier, chris kieffer, Christophe \u2018IKESU\u2019 Clarey, Claire Dejoie, cl\u00e9ment Laporte, Cl\u00e9ment Vernet, Coleen Lochabay, Colin Brain, Com\u2019of design, damien.bracciotti , Dan Hollacher, Daniel Arce, Daniel Budka, David Hoizey, David Polizelli Hoffmann, david.baril, Davide Bedocchi, Derek Lau, djstep1, Dmitry Abdeev, Ebube Onyema, Elen Le Tannou, Elisabeth Springer, Emiliano Martinez, Emilien Gillet, Eric Bardot, Eric Beaup\u00e8re, Eric Paoli Infanzon, Eriks Lapins, eva.lacuskova, eva.lacuskova, Fabien Nowak, Fanny Moulin, Fernando Ferreira da Costa Junior, Florent Bonneviale, Florent Guilbaud, Francis Banguet, Fran\u00e7ois QUILLARD, Fred Luzet, fuerst.pascal, George Bowler, Germain Cauvy, Giedrius Budrys, gil, Gilles Pfeiffer, Giz Beardon, greg.araya, GRELIER Florentine, Guave Studios GmbH Guave Motion, GU\u00c9RET Matthieu, Guido Mariano, Guilbert Sylvain, Guillaume Mariotti, Guillaume Marrou, Guillaume Polveche, Guillaume Rousseau, Gustavo Almenara, Gustavo Miaciro, Gwendal Le Naour, gyom h, H Robert Marquet \u201cBob\u201d, H\u00e5kon Lundvall, Harlem Harl, Herv\u00e9 Dumont, Hiromi Ishibashi, Hristina Braykova, Ilya Gusinski, INSITE SCOP, Jacek Jefimiuk, Jack Kasprzak, Jakub Adam Makowski, Jared Mark Graham, Jason Jantzen, Javier Villalba, Jean-Baptiste Quaghebeur, Jean-Baptiste Sanno, Jean-Damien Gros, Jean-Philippe Albaret, Jean-Philippe Jambert, Jeff Cooney, Jeremi Picard, Jeremy Pluvinage, Jesse Kerman, Joachim Schwarz, Joakim Ottosson, Joe Brooks, Joel PiTrel, Johannes Krohn, John Nelson, Jonas Hummelstrand, jonasgreulich, Jose Carlos Conde Acuaviva, jose gerardo arce lopez, joshua.gslaby, Juan David Almanza Lamo, Juanca Flores, Julie Faussard, Julien Brugi\u00e8re, Julien Gouz, Julien Pilarski, Julien Pilipczuk, Karyl GAUTIER, Kate Jessop, Keizo Abe, kim nari, Kirby Conn, Kris Bosmans, Krista van der Wilk, Lars , Latham Arnott, Laura Marchant, Laura Palmer, Laurent Kanadiou Freyre, Lea Str, Lemesre Julien Erase-studio, Lenny Pomerantz, LES FILMS DU NORD, Liguori Nicolas, Luca Pecori, Luigi De Frenza, Maeva Pensivy, Manuel Viqueira Carballal, Marc Messiaen, Marco Oggero, Maresch & Sturm, Mario Burbach, Mario Hounkanrin, Marion PATIN, Martial Coulon, Martin Pageot, Martine Carton, matanarbel, Mathieu Faure, Mathieu JACOULET, Mathieu Travi, Mathilde Boudet, Matt Lloyd, Matthew Fernandez, matthewacarrick, Matthias Jach, Matthieu Fremeaux, megamonkees , Merlin Pardo, Michael Gorbachev, Michael Helmrich, Mickael Carton, Micka\u00ebl Hernandez, morgan, Motion Caf\u00e9, Motion Design Studio BRUSSOBAUM, MrGlox , muftix, Mysteropodes Drouin, Neil Ingle, Nic Dean, nicolas bougere, Nicolas Castelli, Nicolas Chaunu, Nicolas Dehaut, Nicolas DIDION, Nicolas Dufresne, Nicolas Grandry, nicolas matelot, nicolas.palmier, nicole alman, nirl28, Norbert Radvanyi, Nothing to Hide, Nuno Trindade, Nycolas Gorizian, Oana Nechifor, Olivier Escher, Olivier Jean, Olivier Patt\u00e9, onillon.thierry, P Yalaoui, Pauline DE, Payage Mickael, pdicamillo12, Philip P Betts, Philipp Reinhardt, Philippe Mignot, Philippe VECI, Pierre Cornille, Pierre Jond, pierre marteel, Pierre Munier, Pierre W. Borne, Pierre-Alain L\u00e9croart, Pierre-Baptiste Harrivelle, QingRu Yu, Rapha\u00eblle Prud\u2019homme, R\u00e9mi Rongier, Renaud DANIEL, Renaud Mazotti, Ren\u00e9 Andritsch, Ricardo Abraham Ibarra Duarte, Ricardo Arce, Robin CARLO, Rodrigo Dominguez Salazar, Romy Tokic, Ronald Anzenberger, Ronny Andr\u00e4, Ronny Andr\u00e4, Roth Fr\u00e9d\u00e9ric, Roxana Rodriguez, Ruben Alejandro Trejo Segura, Ruben Gim\u00e9nez, ruldewuold, Ryan Sears, SAINT RAYMOND, Sam Burkardt, Samuel Van Ingen, samy tichadou, Saul Yance Echegaray, S\u00e9bastien GAETTA, Sebastien Mesnage, Sebastien Vincent, Sergey Vodianov, Shao H, shirley natasha pinto, Simon Hervieu, Simon Stojanovski, Songz Meng, Sonya Robine, Sorrentino Ana\u00efs, Spenser Williams, Stein WILD, Stephane Neau, St\u00e9phane Zissu, Stephanie Leonard, Stephen Richard, Steve Pratt, Sylvain Kauffmann, Tao Mao, THAN TRONG Frederic, Thiago Maia, Thomas Crausaz, Thomas Duphil, Thomas Prinzivalli, thrawn, Tiago Castro, Tim Martyn, Tom Conner, Tomas \u00c4rlemo, Tom\u00e1\u0161 Hon\u011bk, Tomas Spokauskas, traffic.in.the.skies, Trebalag Ludovic, Ty Bardi, Vadim Luks, Valentin Nozahic, Val\u00e9rie WINTZ, Valleron Nicolas, vendu, Veronica Delgado, Vicidomini Lionel, Viliam Snirc, Viliam Snirc, Villain Cedric, Vitaliy Movsha, Voignier lisa, Warren D M Reed, wlazinski matthieu, Xavier Golfier, Yan-Ali Tabarand, Yavor Popov, Yaya Gadon, Yohan Le Diraison, Yohann GAMBA, Yoran Legemble, Zach Prichard, Zden\u011bk Dovole, Z\u00e9t\u00e9ny V\u00f6r\u00f6s. Thank you! Without your generous support, Ramses would not exist.","title":"Funding"},{"location":"components/","text":"Documentation Ramses is a complete framework made of different components interacting together. This makes it very modular and scalable to any kind of production, from the freelancer working at home to the biggest studios.","title":"Introduction"},{"location":"components/#documentation","text":"Ramses is a complete framework made of different components interacting together. This makes it very modular and scalable to any kind of production, from the freelancer working at home to the biggest studios.","title":"Documentation"},{"location":"components/addons/","text":"Add-ons Warning Ramses is still under active development , and this documentation is still being written. For now, the only Add-on available 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 \u2026). 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\u2019re welcome to contribute with your own! Available Add-ons Host Application Language Status Details \u25ba API Python A Beta version is already available. \u25ba API ExtendScript For Adobe Creative Cloud API UXP For Adobe Creative Cloud UXP is a new scripting environment for Adobe Software. Ramses won\u2019t officially support it until it is mature enough, which is not the case as of September 2022. This being said, the ExtendScript API may be compatible with UXP . Adobe After Effects ExtendScript Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Adobe Illustrator ExtendScript Low-priority Adobe Photoshop ExtendScript Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets \u25ba Autodesk Maya Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Blender Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Cinema 4D ? Houdini ? Inkscape Python Low-priority Krita Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets The Foundry Nuke Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Legend: | Available | In development | Planned | Not supported yet, but you can develop your own add-on and contribute ! Introduction Here are some guidelines and descriptions about how these add-ons should work. We\u2019re 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 . 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 . Note To be written\u2026 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: Save : [Ctrl] + [S] Save new version : [Ctrl] + [Alt] + [S] Publish : [Ctrl] + [Shift] + [P] These shortcuts have been chosen to avoid conflicts in most host applications but can be changed to something else if they\u2019re 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 UI guidelines. The panel must display buttons for all available commands. Note To be improved and completed\u2026 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, at least: Location of the Ramses Client executable file ( .exe on Windows , .app on MacOS , .appimage or binary on Linux ) Listening port of the Ramses Daemon Whether to connect to the daemon or not. Ramses data path (the folder containing the files) Development options (verbosity/debug mode) Note: the settings are saved in a shared location (user documents folder ?) between all add-ons so that they\u2019re configured only once. They\u2019re in an easy-to-edit JSON text file.","title":"General Information"},{"location":"components/addons/#add-ons","text":"Warning Ramses is still under active development , and this documentation is still being written. For now, the only Add-on available 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 \u2026). 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\u2019re welcome to contribute with your own!","title":"Add-ons"},{"location":"components/addons/#available-add-ons","text":"Host Application Language Status Details \u25ba API Python A Beta version is already available. \u25ba API ExtendScript For Adobe Creative Cloud API UXP For Adobe Creative Cloud UXP is a new scripting environment for Adobe Software. Ramses won\u2019t officially support it until it is mature enough, which is not the case as of September 2022. This being said, the ExtendScript API may be compatible with UXP . Adobe After Effects ExtendScript Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Adobe Illustrator ExtendScript Low-priority Adobe Photoshop ExtendScript Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets \u25ba Autodesk Maya Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Blender Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Cinema 4D ? Houdini ? Inkscape Python Low-priority Krita Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets The Foundry Nuke Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Legend: | Available | In development | Planned | Not supported yet, but you can develop your own add-on and contribute !","title":"Available Add-ons"},{"location":"components/addons/#introduction","text":"Here are some guidelines and descriptions about how these add-ons should work. We\u2019re 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 . 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.","title":"Introduction"},{"location":"components/addons/#available-commands","text":"Some of these commands manage files in the Ramses Tree , see the corresponding documentation . Note To be written\u2026","title":"Available Commands"},{"location":"components/addons/#ui-ux","text":"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.","title":"UI / UX"},{"location":"components/addons/#integrated-commands","text":"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: Save : [Ctrl] + [S] Save new version : [Ctrl] + [Alt] + [S] Publish : [Ctrl] + [Shift] + [P] These shortcuts have been chosen to avoid conflicts in most host applications but can be changed to something else if they\u2019re still conflicting with something important.","title":"Integrated commands"},{"location":"components/addons/#ui-panel","text":"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 UI guidelines. The panel must display buttons for all available commands. Note To be improved and completed\u2026","title":"UI Panel"},{"location":"components/addons/#settings","text":"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, at least: Location of the Ramses Client executable file ( .exe on Windows , .app on MacOS , .appimage or binary on Linux ) Listening port of the Ramses Daemon Whether to connect to the daemon or not. Ramses data path (the folder containing the files) Development options (verbosity/debug mode) Note: the settings are saved in a shared location (user documents folder ?) between all add-ons so that they\u2019re configured only once. They\u2019re in an easy-to-edit JSON text file.","title":"Settings"},{"location":"components/addons/maya-extend/","text":"Extending the Ramses Maya Add-on You can easily add features to the Ramses Maya Add-On , especially by registering your own scripts/methods to be run when a status changes, when a scene is being published, or to import items. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Getting started Technically, the simplest and recommended way to extend the Ramses Maya Add-On is to add your own module(s) inside the Add-on iteself. It is very easy and this way you do not need to register your script or plug-in with Maya , Ramses takes care of that for you. Install the Add-On First, install the Ramses Maya Add-On as described here . These folders should be available: icons : The icons used by the Add-On plug-ins : The actual Python code dumaf : Some useful Python code for Maya ramses : The Ramses Scripting API as a Python module ramses_maya : The Add-On itself shelves : The Ramses Maya shelf Create your module All you need to do to easily extend the Ramses Maya Add-On is to create your own module in the plug-ins folder. Create a subfolder in the plug-ins folder, containing an empty __init__.py file. You can also optionally add your own shelf in the shelves folder. The new tree should look like this: icons plug-ins dumaf ramses ramses_maya your_new_module : contains __init__.py shelves : optionally add shelf_YourModule.mel In the new your_new_module/__init__.py file, you will import or code all the methods you want to expose and make available in Maya, for example to be used in a shelf or any other Python script. You can also register your Ramses callbacks there (read below for more information about Ramses callbacks). Here is an example of such an __init__.py file, assuming you have two other files ( anotherFile.py and aSecondFile.py ) in the same folder, containing the actual code and methods to import: from .anotherFile import aPublicMethod from .aSecondFile import aPublishMethod, anImportMethod # Now, 'aPublicMethod' can be called from everyhwere in Maya # And we can register the publish and import method as callbacks for Ramses. # For this, we need to import the Ramses Module (API) from ramses import Ramses # Now we just have to add the callbacks: ramses = Ramses.instance() # The publish method ramses.publishScripts.append( aPublishMethod ) # The import method ramses.importScripts.append( anImportMethod ) Import the module Finally, you just have to import your new module in the ramses_maya module: add a simple import at the end of the ramses_maya/__init__.py file, which should look like this: from .ram_cmds import cmds_classes from ramses import log, LogLevel import your_new_module Both the new module and the shelf will be automatically registered by the Ramses Maya Add-On when it\u2019s loaded in Maya . Callbacks Ramses stores three lists of callbacks you can extend. Ramses.publishScripts contains the functions to be called when a scene is being published. When Ramses publishes a scene, it calls all the scripts listed there. There already is a script which provides the default implementation; you can either remove it to disable it completely, or just add your own which will be run after (or before if you insert it at the beginning of the list). Each callback you add to this list must take a few arguments. Read the Scripting API Reference for more information. Ramses.statusScripts contains the functions to be called when a scene status changes. When Ramses updates a status, it first copies the scene file to the version folder and calls the Daemon (if available) to notify the update, and then calls all the scripts listed there. Each callback you add to this list must take two arguments. Read the Scripting API Reference for more information. Ramses.importScripts contains the functions to be called when the user selects an item (shot or asset) to import. There already is a script which provides the default implementation for importing items; you can either remove it to disable it completely, or just add your own which will be run after (or before if you insert it at the beginning of the list). . Each callback you add to this list must take a few arguments. Read the Scripting API Reference for more information. There are two ways to register your methods: by using a Maya command, or by forking the provided Add-On to add your functions. Once the callbacks have been registered, they are automatically called when the user interacts with the add-on and wants to update/import/publish an item. You can also explicitly call them by calling these three methods: Ramses.updateStatus( item, status, stepShortName ) Ramses.importItem( item, filePath, stepShortName ) Ramses.publish( item, filePath, stepShortName ) Read the Scripting API Reference for more information. Adding your custom callbacks To register your callbacks, you just have to append them in the corresponding Ramses lists: # We need to import the Ramses Module (API) from ramses import Ramses # Now we just have to add the callbacks ramses = Ramses.instance() # First, remove callbacks provided by the Ramses addon, # to replace them with our own ramses.publishScripts = [] ramses.importScripts = [] ramses.statusScripts = [] # A publish method ramses.publishScripts.append( aPublishMethod ) # An import method ramses.importScripts.append( anImportMethod ) # A status method ramses.statusScripts.append( aStatusMethod ) Now, all these methods will be automatically called each time a status changes, an item is published, or an item is imported. Detailed Example In this example, three files are added, with the import, status, and publish methods. The file plug-ins/your_new_module/myPublishCallbacks.py creates the callbacks used to publish shots and assets. # myPublishCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def publishAsset(item, filePath, step): \"\"\"Callback used to publish Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the filePath and the Step doSomething( item.shortName(), item.group(), filePath, step.shortName()) # etc. def publishShot(item, filePath, step): \"\"\"Callback used to publish Shots only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.SHOT: return # Now we can do what we need using the RamShot object, the filePath and the Step doSomething( item.shortName(), item.duration(), filePath, step.shortName()) # etc. The file plug-ins/your_new_module/myStatusCallbacks.py creates the callbacks used when a status changes. # myStatusCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def updateAsset(item, status, step): \"\"\"Callback used to update Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the RamStatus object and the RamStep object doSomething( item.shortName(), item.group(), status.completionRatio, status.user, step.shortName()) # etc. def updateShot(item, filePath, publishFolderPath): \"\"\"Callback used to update Shots only\"\"\" # The item must be a RamShot if item.itemType() != ram.ItemType.SHOT: return # Now we can do what we need using the RamAsset object, the RamStatus object and the RamStep object doSomething( item.shortName(), item.group(), status.completionRatio, status.user, step.shortName()) # etc. The file plug-ins/your_new_module/myImportCallbacks.py creates the callbacks used to import items. # myImportCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def importAsset(item, filePath, step): \"\"\"Callback used to import Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the RamStep object and the file path doSomething( item.shortName(), item.group(), step.shortName(), filePath) # etc. The file plug-ins/your_new_module/otherMethods.py creates a few other methods, for example to be used in a Maya shelf . # otherMethods.py def methodForAShelf(): doSomething() Finally, we just need to import these files in the plug-ins/your_new_module/__init__.py file of our custom module. We can register them here. # __init__.py from myImportCallbacks import importAsset from myStatusCallbacks import updateAsset, updateShot from myPublishCallbacks import publishAsset, publishShot from otherMethods import methodForAShelf from ramses import Ramses # Get the ramses instance ramses = Ramses.instance() # First, remove callbacks provided by the Ramses addon, # to replace them with our own ramses.publishScripts = [] ramses.importScripts = [] ramses.statusScripts = [] # Add the callbacks to the publish list ramses.publishScripts.append( publishAsset ) ramses.publishScripts.append( publishShot ) # Add the callbacks to the status list ramses.statusScripts.append( updateAsset ) ramses.statusScripts.append( updateShot ) # Add the callbacks to the status list ramses.importScripts.append( importAsset ) And don\u2019t forget to import your new module in plug-ins/ramses_maya/__init__.py : # plug-ins/ramses_maya/__init__.py from .ram_cmds import cmds_classes from ramses import log, LogLevel import your_new_module Don\u2019t change anything else in the file! Now you can also use methodForAShelf() in an existing or new shelf , which can be stored in the shelves folder if you want it to be deployed with your extension.","title":"Extensibility"},{"location":"components/addons/maya-extend/#extending-the-ramses-maya-add-on","text":"You can easily add features to the Ramses Maya Add-On , especially by registering your own scripts/methods to be run when a status changes, when a scene is being published, or to import items. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions.","title":"Extending the Ramses Maya Add-on"},{"location":"components/addons/maya-extend/#getting-started","text":"Technically, the simplest and recommended way to extend the Ramses Maya Add-On is to add your own module(s) inside the Add-on iteself. It is very easy and this way you do not need to register your script or plug-in with Maya , Ramses takes care of that for you.","title":"Getting started"},{"location":"components/addons/maya-extend/#install-the-add-on","text":"First, install the Ramses Maya Add-On as described here . These folders should be available: icons : The icons used by the Add-On plug-ins : The actual Python code dumaf : Some useful Python code for Maya ramses : The Ramses Scripting API as a Python module ramses_maya : The Add-On itself shelves : The Ramses Maya shelf","title":"Install the Add-On"},{"location":"components/addons/maya-extend/#create-your-module","text":"All you need to do to easily extend the Ramses Maya Add-On is to create your own module in the plug-ins folder. Create a subfolder in the plug-ins folder, containing an empty __init__.py file. You can also optionally add your own shelf in the shelves folder. The new tree should look like this: icons plug-ins dumaf ramses ramses_maya your_new_module : contains __init__.py shelves : optionally add shelf_YourModule.mel In the new your_new_module/__init__.py file, you will import or code all the methods you want to expose and make available in Maya, for example to be used in a shelf or any other Python script. You can also register your Ramses callbacks there (read below for more information about Ramses callbacks). Here is an example of such an __init__.py file, assuming you have two other files ( anotherFile.py and aSecondFile.py ) in the same folder, containing the actual code and methods to import: from .anotherFile import aPublicMethod from .aSecondFile import aPublishMethod, anImportMethod # Now, 'aPublicMethod' can be called from everyhwere in Maya # And we can register the publish and import method as callbacks for Ramses. # For this, we need to import the Ramses Module (API) from ramses import Ramses # Now we just have to add the callbacks: ramses = Ramses.instance() # The publish method ramses.publishScripts.append( aPublishMethod ) # The import method ramses.importScripts.append( anImportMethod )","title":"Create your module"},{"location":"components/addons/maya-extend/#import-the-module","text":"Finally, you just have to import your new module in the ramses_maya module: add a simple import at the end of the ramses_maya/__init__.py file, which should look like this: from .ram_cmds import cmds_classes from ramses import log, LogLevel import your_new_module Both the new module and the shelf will be automatically registered by the Ramses Maya Add-On when it\u2019s loaded in Maya .","title":"Import the module"},{"location":"components/addons/maya-extend/#callbacks","text":"Ramses stores three lists of callbacks you can extend. Ramses.publishScripts contains the functions to be called when a scene is being published. When Ramses publishes a scene, it calls all the scripts listed there. There already is a script which provides the default implementation; you can either remove it to disable it completely, or just add your own which will be run after (or before if you insert it at the beginning of the list). Each callback you add to this list must take a few arguments. Read the Scripting API Reference for more information. Ramses.statusScripts contains the functions to be called when a scene status changes. When Ramses updates a status, it first copies the scene file to the version folder and calls the Daemon (if available) to notify the update, and then calls all the scripts listed there. Each callback you add to this list must take two arguments. Read the Scripting API Reference for more information. Ramses.importScripts contains the functions to be called when the user selects an item (shot or asset) to import. There already is a script which provides the default implementation for importing items; you can either remove it to disable it completely, or just add your own which will be run after (or before if you insert it at the beginning of the list). . Each callback you add to this list must take a few arguments. Read the Scripting API Reference for more information. There are two ways to register your methods: by using a Maya command, or by forking the provided Add-On to add your functions. Once the callbacks have been registered, they are automatically called when the user interacts with the add-on and wants to update/import/publish an item. You can also explicitly call them by calling these three methods: Ramses.updateStatus( item, status, stepShortName ) Ramses.importItem( item, filePath, stepShortName ) Ramses.publish( item, filePath, stepShortName ) Read the Scripting API Reference for more information.","title":"Callbacks"},{"location":"components/addons/maya-extend/#adding-your-custom-callbacks","text":"To register your callbacks, you just have to append them in the corresponding Ramses lists: # We need to import the Ramses Module (API) from ramses import Ramses # Now we just have to add the callbacks ramses = Ramses.instance() # First, remove callbacks provided by the Ramses addon, # to replace them with our own ramses.publishScripts = [] ramses.importScripts = [] ramses.statusScripts = [] # A publish method ramses.publishScripts.append( aPublishMethod ) # An import method ramses.importScripts.append( anImportMethod ) # A status method ramses.statusScripts.append( aStatusMethod ) Now, all these methods will be automatically called each time a status changes, an item is published, or an item is imported.","title":"Adding your custom callbacks"},{"location":"components/addons/maya-extend/#detailed-example","text":"In this example, three files are added, with the import, status, and publish methods. The file plug-ins/your_new_module/myPublishCallbacks.py creates the callbacks used to publish shots and assets. # myPublishCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def publishAsset(item, filePath, step): \"\"\"Callback used to publish Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the filePath and the Step doSomething( item.shortName(), item.group(), filePath, step.shortName()) # etc. def publishShot(item, filePath, step): \"\"\"Callback used to publish Shots only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.SHOT: return # Now we can do what we need using the RamShot object, the filePath and the Step doSomething( item.shortName(), item.duration(), filePath, step.shortName()) # etc. The file plug-ins/your_new_module/myStatusCallbacks.py creates the callbacks used when a status changes. # myStatusCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def updateAsset(item, status, step): \"\"\"Callback used to update Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the RamStatus object and the RamStep object doSomething( item.shortName(), item.group(), status.completionRatio, status.user, step.shortName()) # etc. def updateShot(item, filePath, publishFolderPath): \"\"\"Callback used to update Shots only\"\"\" # The item must be a RamShot if item.itemType() != ram.ItemType.SHOT: return # Now we can do what we need using the RamAsset object, the RamStatus object and the RamStep object doSomething( item.shortName(), item.group(), status.completionRatio, status.user, step.shortName()) # etc. The file plug-ins/your_new_module/myImportCallbacks.py creates the callbacks used to import items. # myImportCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def importAsset(item, filePath, step): \"\"\"Callback used to import Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the RamStep object and the file path doSomething( item.shortName(), item.group(), step.shortName(), filePath) # etc. The file plug-ins/your_new_module/otherMethods.py creates a few other methods, for example to be used in a Maya shelf . # otherMethods.py def methodForAShelf(): doSomething() Finally, we just need to import these files in the plug-ins/your_new_module/__init__.py file of our custom module. We can register them here. # __init__.py from myImportCallbacks import importAsset from myStatusCallbacks import updateAsset, updateShot from myPublishCallbacks import publishAsset, publishShot from otherMethods import methodForAShelf from ramses import Ramses # Get the ramses instance ramses = Ramses.instance() # First, remove callbacks provided by the Ramses addon, # to replace them with our own ramses.publishScripts = [] ramses.importScripts = [] ramses.statusScripts = [] # Add the callbacks to the publish list ramses.publishScripts.append( publishAsset ) ramses.publishScripts.append( publishShot ) # Add the callbacks to the status list ramses.statusScripts.append( updateAsset ) ramses.statusScripts.append( updateShot ) # Add the callbacks to the status list ramses.importScripts.append( importAsset ) And don\u2019t forget to import your new module in plug-ins/ramses_maya/__init__.py : # plug-ins/ramses_maya/__init__.py from .ram_cmds import cmds_classes from ramses import log, LogLevel import your_new_module Don\u2019t change anything else in the file! Now you can also use methodForAShelf() in an existing or new shelf , which can be stored in the shelves folder if you want it to be deployed with your extension.","title":"Detailed Example"},{"location":"components/addons/maya-import/","text":"Importing assets When importing or replacing assets, there are a few options. The same way publish settings can use presets or be set directly in the Ramses Client Application , Ramses will look for presets and default settings when importing the assets. In the first tab, you can optionally select an existing preset. Presets are stored in a folder inside the Maya module folder. You can save or load a preset with Edit \u25ba Save preset... and Edit \u25ba Load preset... . When a preset is saved in the default folder, it is listed in the box in this tab. Ramses provides a few presets by default, they\u2019re good examples of what you can do. Alembic - Reference and shaders imports an alembic file as a reference, along with Maya shader libraries. Alembic and shaders imports an alembic file, and Maya shader libraries as a reference. Maya - Lock transform imports a Maya file, and locks the transformations of the imported asset. Maya - Reference references a Maya file. Maya simply imports a Maya file. You can safely delete these presets from the preset folder if you don\u2019t need them. Format settings For each format to import, you can set some settings. The text on the right can be copied to any pipe type in the Ramses Client Application . When importing an asset, Ramses will first look for these settings, and if they\u2019re found, it won\u2019t show the settings dialog unless the user checked the box Edit import options when importing the asset. Files can be imported as references . All transformations of all nodes can be locked . By default, a namespace is created to store the imported objects. This can be deactivated. Use with caution as name conflicts can generate errors on import/update! Imported objects are grouped in a transform node. By default, a shape (a square around the objects as a nurbsCurve ) is created to easily manipulate them in the viewport. When importing a shader library, shaders can automatically be applied on the selected nodes. Ramses will use the node names to apply the shaders: the selected nodes must have the exact same name as the nodes in the scene used to publish the shaders. Shaders When importing a shader library , as published with the publish method of the Add-On , Ramses will automatically assign these shaders to any mesh imported along with the shaders; this is a quick way to import both Alembic meshes and their shaders for example: just import both files at once. If you just want to assign the shaders to existing geometry, just select on or several nodes containing the meshes, and Ramses will try to assign the imported shaders to them, using the names of the transform nodes containing the meshes. If the shaders are not correctly assigned, check the names of the nodes. Namespaces are ignored when matching nodes with their shader. If you need to replace or reassign shaders already imported, the quick and easy way is to remove them from the scene, select the meshes, and import them again. All the shaders will be automatically re-assigned. All Settings These are all the available settings: format: '*' # The file format these settings apply to. Either a wildcard '*' or the file extension (without the leading \".\") apply_shaders: true as_reference: false lock_transformations: true create_namespace: true no_root_shape: false These settings can be set directly in the Ramses Application\u2019s pipeline editor , or directly using the pipe editor , in the settings field.","title":"Import settings"},{"location":"components/addons/maya-import/#importing-assets","text":"When importing or replacing assets, there are a few options. The same way publish settings can use presets or be set directly in the Ramses Client Application , Ramses will look for presets and default settings when importing the assets. In the first tab, you can optionally select an existing preset. Presets are stored in a folder inside the Maya module folder. You can save or load a preset with Edit \u25ba Save preset... and Edit \u25ba Load preset... . When a preset is saved in the default folder, it is listed in the box in this tab. Ramses provides a few presets by default, they\u2019re good examples of what you can do. Alembic - Reference and shaders imports an alembic file as a reference, along with Maya shader libraries. Alembic and shaders imports an alembic file, and Maya shader libraries as a reference. Maya - Lock transform imports a Maya file, and locks the transformations of the imported asset. Maya - Reference references a Maya file. Maya simply imports a Maya file. You can safely delete these presets from the preset folder if you don\u2019t need them.","title":"Importing assets"},{"location":"components/addons/maya-import/#format-settings","text":"For each format to import, you can set some settings. The text on the right can be copied to any pipe type in the Ramses Client Application . When importing an asset, Ramses will first look for these settings, and if they\u2019re found, it won\u2019t show the settings dialog unless the user checked the box Edit import options when importing the asset. Files can be imported as references . All transformations of all nodes can be locked . By default, a namespace is created to store the imported objects. This can be deactivated. Use with caution as name conflicts can generate errors on import/update! Imported objects are grouped in a transform node. By default, a shape (a square around the objects as a nurbsCurve ) is created to easily manipulate them in the viewport. When importing a shader library, shaders can automatically be applied on the selected nodes. Ramses will use the node names to apply the shaders: the selected nodes must have the exact same name as the nodes in the scene used to publish the shaders.","title":"Format settings"},{"location":"components/addons/maya-import/#shaders","text":"When importing a shader library , as published with the publish method of the Add-On , Ramses will automatically assign these shaders to any mesh imported along with the shaders; this is a quick way to import both Alembic meshes and their shaders for example: just import both files at once. If you just want to assign the shaders to existing geometry, just select on or several nodes containing the meshes, and Ramses will try to assign the imported shaders to them, using the names of the transform nodes containing the meshes. If the shaders are not correctly assigned, check the names of the nodes. Namespaces are ignored when matching nodes with their shader. If you need to replace or reassign shaders already imported, the quick and easy way is to remove them from the scene, select the meshes, and import them again. All the shaders will be automatically re-assigned.","title":"Shaders"},{"location":"components/addons/maya-import/#all-settings","text":"These are all the available settings: format: '*' # The file format these settings apply to. Either a wildcard '*' or the file extension (without the leading \".\") apply_shaders: true as_reference: false lock_transformations: true create_namespace: true no_root_shape: false These settings can be set directly in the Ramses Application\u2019s pipeline editor , or directly using the pipe editor , in the settings field.","title":"All Settings"},{"location":"components/addons/maya-pipeline/","text":"The Maya pipeline With Ramses and its Maya Add-on, the Maya pipeline is easy-to-use but you have access to all parameters when publishing and importing files. Using presets and/or the Ramses Client Application you can completely automate the pipeline according to your specific needs. \u25b9 Read more about the pipeline . \u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"Maya pipeline"},{"location":"components/addons/maya-pipeline/#the-maya-pipeline","text":"With Ramses and its Maya Add-on, the Maya pipeline is easy-to-use but you have access to all parameters when publishing and importing files. Using presets and/or the Ramses Client Application you can completely automate the pipeline according to your specific needs. \u25b9 Read more about the pipeline . \u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"The Maya pipeline"},{"location":"components/addons/maya-publish/","text":"Setting the publishing parameters Use the Publish settings button from the Add-on \u2018s shelf to access all available parameters for publishing in Maya. From this dialog, you can build your own presets, or set some settings as defaults for any specific step in your pipeline . In the first tab, select the step for which your setting the publishing parameters, and optionally select an existing preset. Presets are stored in a folder inside the Maya module folder. You can save or load a preset with Edit \u25ba Save preset... and Edit \u25ba Load preset... . When a preset is saved in the default folder, it is listed in the box in this tab. Ramses provides a few presets by default, they\u2019re good examples of what you can do. Animation.abc can be used for publishing animation and cameras as a lightweight alembic file. Arnold.ass is a simple preset to publish the selected nodes as an Arnold Scene Source . Geometry.abc is meant for publishing mesh nodes without animation. Shaders are automatically published separately as a Maya Binary . Rig.ma can be used to publish rigged characters and props, and more generally any kind of Maya scene, as a Maya ASCII file. Shaders.mb publishes only the shaders from the selected nodes. Simple.mb is a general preset which can be used with any kind of scene. You can safely delete these presets from the preset folder if you don\u2019t need them. The text area on the right shows the preset as a text. This text can be saved or used directly in the publish settings of any step in the Ramses Client Application , to be automatically used when publishing files for the given step. In this case, this settings window will not be shown anymore when publishing files, unless the user checks the Edit publish settings box when saving the scene. If the Ramses Client Application is running, you don\u2019t necessarily need to use presets; clicking on the Save settings button will set the current settings to the selected step. They can then also be edited directly in the Ramses Client Application . This text uses the Yaml syntax, which can easily be edited manually. Pre-Publish settings Before publishing, Ramses can run some checks and clean the scene. Import all references , to avoid nested references Remove namespaces , to simplify node names when importing Remove all hidden nodes Delete all histories Leave only a single shape per transform node . Extra shapes should not be needed. Remove all empty groups Remove all keyframes and animation Types : you can choose to keep (white list) or remove (black list) specific node types. To check the types of the nodes to complete the list, use the Mel/Python command nodeType . Freeze transformations of all the nodes , except those containing specific strings in their name. Maya scene Select either Binary or ASCII file . All hidden node visibilities can be automatically locked . All transformations can be locked . You can select how joints will be displayed in the published file. Maya scene - Shader library Select either Binary or ASCII file . When publishing a shader library, Ramses keeps the list of nodes the shaders are applied to, and is able to re-assign them when importing the library in any scene. Alembic You can choose to keep only renderable nodes and remove all other shapes. Use the handles control to add some time before and after the scene\u2019s time range. You can change the frame step to make the exported file lighter or more detailed (e.g. for precise motion blur). You can automatically filter Euler rotations . Arnold Scene Source There are no options for this format. All Settings These are all the available settings: delete_history: false formats: # Format specific options - mb: # Maya Binary options joints: disable # one of \"disable\", \"hide\", \"lock\", \"keep\" lock_hidden_nodes: true lock_transformations: false only_shaders: true - abc: # Alembic options animation: frame_step: 1.0 handle_in: 0 # in frames handle_out: 0 filter_euler_rotations: true renderable_only: true - ass # Arnold secne source options (emtpy, no options) freeze_transform: case_sensitive: false whitelist: - _eye_ - _eyes_ import_references: true remove_animation: false remove_empty_groups: true remove_extra_shapes: false remove_hidden_nodes: false remove_namespaces: true types: list: - bezierCurve - nurbsCurve - nurbsSurface - locator mode: remove # either \"remove\" or \"keep\" These settings can be set directly in the Ramses Application\u2019s step editor , in the Publish settings tab.","title":"Publish settings"},{"location":"components/addons/maya-publish/#setting-the-publishing-parameters","text":"Use the Publish settings button from the Add-on \u2018s shelf to access all available parameters for publishing in Maya. From this dialog, you can build your own presets, or set some settings as defaults for any specific step in your pipeline . In the first tab, select the step for which your setting the publishing parameters, and optionally select an existing preset. Presets are stored in a folder inside the Maya module folder. You can save or load a preset with Edit \u25ba Save preset... and Edit \u25ba Load preset... . When a preset is saved in the default folder, it is listed in the box in this tab. Ramses provides a few presets by default, they\u2019re good examples of what you can do. Animation.abc can be used for publishing animation and cameras as a lightweight alembic file. Arnold.ass is a simple preset to publish the selected nodes as an Arnold Scene Source . Geometry.abc is meant for publishing mesh nodes without animation. Shaders are automatically published separately as a Maya Binary . Rig.ma can be used to publish rigged characters and props, and more generally any kind of Maya scene, as a Maya ASCII file. Shaders.mb publishes only the shaders from the selected nodes. Simple.mb is a general preset which can be used with any kind of scene. You can safely delete these presets from the preset folder if you don\u2019t need them. The text area on the right shows the preset as a text. This text can be saved or used directly in the publish settings of any step in the Ramses Client Application , to be automatically used when publishing files for the given step. In this case, this settings window will not be shown anymore when publishing files, unless the user checks the Edit publish settings box when saving the scene. If the Ramses Client Application is running, you don\u2019t necessarily need to use presets; clicking on the Save settings button will set the current settings to the selected step. They can then also be edited directly in the Ramses Client Application . This text uses the Yaml syntax, which can easily be edited manually.","title":"Setting the publishing parameters"},{"location":"components/addons/maya-publish/#pre-publish-settings","text":"Before publishing, Ramses can run some checks and clean the scene. Import all references , to avoid nested references Remove namespaces , to simplify node names when importing Remove all hidden nodes Delete all histories Leave only a single shape per transform node . Extra shapes should not be needed. Remove all empty groups Remove all keyframes and animation Types : you can choose to keep (white list) or remove (black list) specific node types. To check the types of the nodes to complete the list, use the Mel/Python command nodeType . Freeze transformations of all the nodes , except those containing specific strings in their name.","title":"Pre-Publish settings"},{"location":"components/addons/maya-publish/#maya-scene","text":"Select either Binary or ASCII file . All hidden node visibilities can be automatically locked . All transformations can be locked . You can select how joints will be displayed in the published file.","title":"Maya scene"},{"location":"components/addons/maya-publish/#maya-scene-shader-library","text":"Select either Binary or ASCII file . When publishing a shader library, Ramses keeps the list of nodes the shaders are applied to, and is able to re-assign them when importing the library in any scene.","title":"Maya scene - Shader library"},{"location":"components/addons/maya-publish/#alembic","text":"You can choose to keep only renderable nodes and remove all other shapes. Use the handles control to add some time before and after the scene\u2019s time range. You can change the frame step to make the exported file lighter or more detailed (e.g. for precise motion blur). You can automatically filter Euler rotations .","title":"Alembic"},{"location":"components/addons/maya-publish/#arnold-scene-source","text":"There are no options for this format.","title":"Arnold Scene Source"},{"location":"components/addons/maya-publish/#all-settings","text":"These are all the available settings: delete_history: false formats: # Format specific options - mb: # Maya Binary options joints: disable # one of \"disable\", \"hide\", \"lock\", \"keep\" lock_hidden_nodes: true lock_transformations: false only_shaders: true - abc: # Alembic options animation: frame_step: 1.0 handle_in: 0 # in frames handle_out: 0 filter_euler_rotations: true renderable_only: true - ass # Arnold secne source options (emtpy, no options) freeze_transform: case_sensitive: false whitelist: - _eye_ - _eyes_ import_references: true remove_animation: false remove_empty_groups: true remove_extra_shapes: false remove_hidden_nodes: false remove_namespaces: true types: list: - bezierCurve - nurbsCurve - nurbsSurface - locator mode: remove # either \"remove\" or \"keep\" These settings can be set directly in the Ramses Application\u2019s step editor , in the Publish settings tab.","title":"All Settings"},{"location":"components/addons/maya-scenesetup/","text":"Scene setup / General parameters The Maya Add-on is able to automatically setup the maya scenes for the assets and the shots, to select the right camera, set the correct rendering resolution, set the correct timeline start and end time\u2026 Click the Scene Setup button to setup the scene. These parameters are retrieved from the shot or asset and project data; you can also customize these settings for each step. You can add these settings via the Ramses Application, using the step editor \u2018s general settings, like in this example: This text uses the Yaml syntax. These are the available settings: shot: handle_in: 24 # The handle to add before the shot start time, in frames handle_out: 24 # The handle to add after the shot end time, in frames first_image_number: 101 # The number of the first frame in the timeline (including the handle_in)","title":"Scene setup"},{"location":"components/addons/maya-scenesetup/#scene-setup-general-parameters","text":"The Maya Add-on is able to automatically setup the maya scenes for the assets and the shots, to select the right camera, set the correct rendering resolution, set the correct timeline start and end time\u2026 Click the Scene Setup button to setup the scene. These parameters are retrieved from the shot or asset and project data; you can also customize these settings for each step. You can add these settings via the Ramses Application, using the step editor \u2018s general settings, like in this example: This text uses the Yaml syntax. These are the available settings: shot: handle_in: 24 # The handle to add before the shot start time, in frames handle_out: 24 # The handle to add after the shot end time, in frames first_image_number: 101 # The number of the first frame in the timeline (including the handle_in)","title":"Scene setup / General parameters"},{"location":"components/addons/maya/","text":"Ramses Maya Add-on Ramses comes with an official add-on for Autodesk Maya , which actually consists in a Python plug-in and a custom shelf packaged in a simple single module. It is an example of an implementation of an add-on using the Ramses Python API but it is already well suited for use in production. As well as all other Ramses Add-ons , the Ramses Maya Add-on includes the main features like versionning, publishing and production tracking with Ramses , but it can be extended to automate your workflow . This Add-on can be used with or without being connected to the Ramses Daemon (and the Ramses Client Application ). If it is connected to the Daemon , it will automatically update the production tracking data. Installation Download and unzip the module. To quickly deploy the module on several workstations, choose a shared location; the module can then be shared with all workstations and updated at once. Edit Ramses.mod with a text editor, and replace the path in the first line with the absolute path where you\u2019ve unzipped the module. This is how the content of this file looks like: + Ramses 0.0.1-dev D:\\your\\path\\to\\the\\module PYTHONPATH+:=plug-ins MAYA_SHELF_PATH+:=shelves Do not change anything else in the file. In order to prevent unintended modifications to the Ramses shelf, you can set its read-only attribute: Right click on the shelves/shelf_Ramses.mel file and select Properties . Check the Read only box. Copy Ramses.mod in one of your modules paths e.g. C:\\Users\\User\\Documents\\Maya\\modules . You may need to create the modules folder if it does not exist yet. Repeat this operation on all workstations where you need the module. Restart Maya . Activate the Ramses plug-in from Maya \u2018s plug-in manager. You may need to restart Maya again so that the Ramses shelf is loaded. Features All features of the Ramses add-on are available through the new shelf. They are also registered as Mel and Python Maya commands. All these features are detailed in the next sections. To handle all file naming and sorting, Ramses includes commands to replace all the default Save , Save As and Open functions. Using (almost) only the Ramses commands ensures your files will always be correctly named and in the right location. It also helps Ramses track the production. Feature Maya Command Description Open the Ramses App ramOpenRamses Launches the Ramses Client Application (if its path is correctly set in the settings). Save ramSave Saves and backups the current scene; this save command is also used for production tracking. Comment ramSave Associates a comment wit the current scene file. Incremental Save ramSaveVersion Saves and increments the version of the current scene. Update Status / Publish ramSaveVersion Saves and increments the version of the current scene, while updating its current production tracking status. Optionally publishes the asset/shot. Create Preview ramPreview Creates a preview (thumbnail or playblast) of the current scene. Save as ramSaveAs Saves the scene as a new Asset, Shot or General item. Template ramPublishTemplate Saves the current scene as a new template for the current step. Setup scene ramSetupScene Setups the scene to make it Ramses-friendly. Open ramOpen Opens an Asset, Shot or Template. Import ramOpen Imports an Asset, Shot or Template. Replace ramOpen Replaces selected nodes with another Asset, Shot or Template. Update ramUpdate Updates assets and shots included in the scene. Retrieve Version ramRetrieveVersion Retrieves and restores a previous version of the current scene. Publish settings ramPublishSettings Sets the default publish settings for steps. Settings ramSettings Opens the settings dialog for the Ramses Add-on . Save The Ramses Save command starts by saving the current scene, and then runs a few checks before backuping the file into the _versions subfolder: Naming Scheme : checks if the file is correctly named and located. If not, Ramses will run the Save as command instead to ensure the name is correct. Version : checks if the version has to be incremented. That\u2019s the case if the current scene is a restored previous version, or if the latest increment occured before the timeout set in the settings. Depending on these checks, Ramses will automatically associate a comment with the corresponding version to warn of any changes. The Mel and Python corresponding command is: ramSave . It can take two parameters: -set_comment or -sc : boolean used to set a comment associated to the current version file. -comment or -c : string is the comment to be associated if -sc is True . # Python import maya.cmds as cmds # Save the current file cmds.ramSave() # Save the file with a comment (show the comment dialog) cmds.ramSave(set_comment = True) # Save the file with a custom comment cmds.ramSave(sc = True, comment = \"A new comment!\") Comment The Comment command saves the current scene the same way as the Save command, and adds a comment associated with the current version. This comment is displayed with the corresponding version in all version selection dialogs, both in the add-on itself and in the Ramses Client Application , as shown below. A list of versions with a few comments, as shown in the Ramses Maya Add-on . A list of versions with a few comments, as shown in the Ramses Client Application . The Mel and Python corresponding command is: ramSave with its two parameters -sc and c . Read the Save section for details. # Python import maya.cmds as cmds # Save the file with a custom comment cmds.ramSave(sc = True, comment = \"A new comment!\") Incremental Save The Incremental Save runs the save command and forces it to increment to a new version. The Mel and Python corresponding command is: ramSaveVersion with the parameter updateStatus set to False . Read the Update Status section for details. # Python import maya.cmds as cmds # Incremental save cmds.ramSaveVersion( updateStatus=False ) Update Status and Publish The Update Status runs the Incremental Save command and updates the current production status of the current Asset or Shot. A dialog is shown with a few options to update the status, and to choose to also publish the scene, and create a preview for it. This dialog may differ depending on the use of the Ramses Client Application or not. This is the status dialog when connected to the Ramses Client Application . You can set the new State with the drop down list at the top left; the list of the states is retrieved from the Ramses Daemon . The slider and percentage is used to set a new Completion Ratio . The Comment field is used to update the comment displayed in the production tracking tools and tables of Ramses . All this information is automatically fed to the Ramses Daemon which updates the information for everyone. This is the status dialog when the Ramses Client Application isn't available. When not connected to the Daemon , there is still an option to set a State from a default limited list. Check the Publication button to publish the current scene. Check the Preview button to create a preview (thumbnail or playblast) for the current scene. Read the Preview section for more details. The Update Status and Save button updates the status, publishes the scene, and creates the preview, while the Skip and Just Save button just increments the version and saves. The Mel and Python corresponding command is: ramSaveVersion . It can take three parameters: -updateStatus or -us : boolean . When True (default), the status dialog is shown to let the user update the status. -publish or -p : boolean activates the publication of the scene. -preview or -pv : boolean activates the creation of a preview. # Python import maya.cmds as cmds # Shows the update status dialog cmds.ramSaveVersion() # Incremental save cmds.ramSaveVersion(updateStatus = False) # Publishes the file without showing the status dialog cmds.ramSaveVersion(publish = True, us = False) # Publishes and creates a preview without showing the status dialog cmds.ramSaveVersion(publish = True, preview = True, us = False) Publish The publication of the scene is done in several steps: If the Ramses Daemon is available, Ramses checks if there are publish settings available. If no settings were found, or if the user checked the box to edit the settings, a dialog window is shown to let the user adjust the publish settings. The Scene is saved in the _published subfolder. This is the folder from which the scene and published files can be imported or referenced into other Assets and Shots. One or several files are published, according to the settings. Ramses then calls any potential publish function registered by the pipeline tools or an extension of the Add-On. \u25b9 Read the publishing guide for Maya for more information about the Maya pipeline. Preview The Preview command allows you to quickly create either an image (thumbnail) or a video (playblast) preview of the current scene, automatically saved in the _preview subfolder. There are a few options to adjust how the image or video are rendered. Ramses auto-selects the first renderable camera in the scene. To always automatically use the right camera, either add it in the render settings (and remove any other unneeded camera), or check the renderable option in the Ouput Settings section of its attributes. The size is a percentage of the resolution of the render settings of the scene. You can then adjust all the render options; checking both Only Polygons and Show Motion Trails allows to hide all animation controllers (if they\u2019re curves as usual) but keep the motion trails. By default, Ramses overwrites any previous image or video for the current scene, except if you set a new comment when making the preview. Note that the Ramses Client Application uses the preview with an empty comment as a thumbnail to display the asset or the shot in the user interface. Ramses also automatically burns useful meta-data in the image, like the frame number, the focal length, the comment, etc. The Mel and Python corresponding command is: ramPreview . # Python import maya.cmds as cmds # Shows the preview dialog cmds.ramPreview() Playblasts When rendering the playblasts, Ramses does not only renders them as usual Maya playblasts: you don\u2019t need to install Quicktime on windows anymore to export videos. Ramses automatically renders the playblasts in a very lightweight MP4 video, crafted especially for reviewing animations, with an intra-frame encoding setting which enables frame by frame playblack on every video player, with great performance. Ramses will also automatically play the video as soon as it\u2019s encoded using ffplay , a very efficient and lightweight video player. It may seem complicated at first as it does not have any User Interface, but it is easily controlled with a few shortcuts: To scroll in the video, [Right Click] anywhere on the video and drag the mouse horizontally. The left border of the frame represents the beginning of the video, while the right border represents the end. You can go forwards and backwards with the [\u2190] and [\u2192] keys of your keyboard by a few frames. Use [\u2191] and [\u2193] to go to the start or the end of the video. Use [Space] to play and pause the video. Use [S] for frame-by-frame playing. Hit [Q] to quickly quit the player. Save As The Save As command can be used to create a new Asset or Shot, or save any other new file, while automatically naming and locating it. Ramses automatically selects the current Project . Select the type of item to save; either an Asset , a Shot or another general item. The list of Steps , Asset Groups and Items is automatically built either by asking the Ramses Daemon if the add-on is used with the Ramses Client Application or by looking into the folder structure, but it is possible to create a new one by just entering a new name. The Resource is used to differenciate several files for the same Asset or Shot. An empty Resource is considered the main and default working file for the item, but you can add any other file by just adding a small resource name. When selecting Other as type, the file will be saved in the main folder of the corresponding step. Read the section about the Ramses Tree for more information. The Mel and Python corresponding command is: ramSaveAs . # Python import maya.cmds as cmds # Shows the save as dialog cmds.ramSaveAs() Template Use the Template command to create a new template file to be used with a specific step. Use the Name to have several templates for the same step. Hint This command just creates the new template, but does not publish it. You still have to publish it using the Update Status command afterwards. Templates can then be used to create new scenes for specific Shots or Assets from the Ramses Client Application . Templates are also available with the Open / Import command of the add-on. The Mel and Python corresponding command is: ramPublishTemplate . # Python import maya.cmds as cmds # Shows the publish template dialog cmds.ramPublishTemplate() Setup scene The Setup scene command runs some checks on the current scene and makes sure everything works according to the current project. Ramses will automatically add the Ramses_Publish and Ramses_DelOnPublish sets if they\u2019re missing, and checks these values to optionally fix them: The frame rate (if the current scene is a Shot) The duration (if the current scene is a Shot) The rendering resolution The camera used in the render settings The name of the selected camera These checks are automatically run when the scene is saved. The Mel and Python corresponding command is: ramSetupScene . # Python import maya.cmds as cmds # Checks the scene settings and shows a dialog if something is wrong cmds.ramSetupScene() Open, Import, Replace The Open and Import command automatically finds available scenes from your projects. It is not needed to go down all the hierarchy to select a file to open; if you just select an item and a step, Ramses will automatically open or import the corresponding latest version of the main resource. It works the same way when importing items: you don\u2019t need to go all the way down to select the files you want to import; by selecting just the main file, Ramses will import everything available, or, if you\u2019re using an extension of the Add-on , it will pass all the files to the extension so it can automatically manage the import for you. When importing an item, Ramses will also trigger custom import scripts registered by the pipeline tools or an extension of the Maya Add-on . This is one way of automating your workflow, by just registering scripts to be called when publishing and importing items. The Mel and Python corresponding command is: ramOpen . It can take two parameters: import or -i : boolean. When True , the dialog is opened in import mode. replace or -r : boolean. When True , the dialog is opened in replace mode. # Python import maya.cmds as cmds # Shows the open dialog cmds.ramOpen() # Shows the import dialog cmds.ramOpen(i=true) # Shows the replace dialog cmds.ramOpen(r=true) Update Use the Update command to update (or downgrade) the assets included in the scene. For each asset, you can select which version to use in the scene and automatically replace it. The update command is able to update to a newer or downgrade to a previous version. The Mel and Python corresponding command is: ramUpdate . # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() Retrieve Version The Retrieve version command can be used to check and restore a previous version of the current scene. The Mel and Python corresponding command is: ramRetrieveVersion . # Python import maya.cmds as cmds # Shows the retrieve version dialog cmds.ramRetrieveVersion() Publish Settings \u25b9 Read the publishing guide for Maya for more information about the Maya pipeline. Settings Versionning The Auto-Increment option sets how many time can be spent before Ramses automatically increments the version of the file when saving. Use this option to be sure you can get back to an earlier version of your work even if you forget to increment the version. the Save hotkey option replaces the default \u201c Save Scene \u201d [Ctrl + S] hotkey from Maya by the Save command from Ramses . This is recommended to enable all production tracking features of Ramses and ensure an automatic backup of your work. Note that checking this box does not replace the File/Save menu entry so you can still use the default Maya Save command. the Save as hotkey option replaces the default \u201c Save Scene As \u201d [Ctrl + Shift + S] hotkey from Maya by the Save As command from Ramses . Note that checking this box does not replace the File/Save as... menu entry so you can still use the default Maya Save as command. the Open hotkey option replaces the default \u201c Open Scene\u2026 \u201d [Ctrl + O] hotkey from Maya by the Open command from Ramses . Note that checking this box does not replace the File/Open Scene... menu entry so you can still use the default Maya Open* command. Folders Set the main Ramses folder location . This is mandatory if you\u2019re using the add-on without the Ramses Client Application . Ramses Application Check the Connected box so that the Ramses Add-on will work with the Ramses Client Application for production tracking features. In order for this to work, you\u2019ll need to set the path to the Ramses.exe file inside the installation folder of the Ramses Client Application . The Ramses Daemon Port is the local networking port used by the Ramses Daemon to communicate with the add-ons. It must be the same value as the one set in the Ramses Client Application ; the default value is the birthdate of Karl Marx : 18185 (May, 5th 1818). Development Change the Log Level to adjust how many information is printed in the console to help you debug your scripts when you\u2019re developping using the Ramses Python API or if you\u2019re extending the add-on .","title":"Maya Add-on"},{"location":"components/addons/maya/#ramses-maya-add-on","text":"Ramses comes with an official add-on for Autodesk Maya , which actually consists in a Python plug-in and a custom shelf packaged in a simple single module. It is an example of an implementation of an add-on using the Ramses Python API but it is already well suited for use in production. As well as all other Ramses Add-ons , the Ramses Maya Add-on includes the main features like versionning, publishing and production tracking with Ramses , but it can be extended to automate your workflow . This Add-on can be used with or without being connected to the Ramses Daemon (and the Ramses Client Application ). If it is connected to the Daemon , it will automatically update the production tracking data.","title":"Ramses Maya Add-on"},{"location":"components/addons/maya/#installation","text":"Download and unzip the module. To quickly deploy the module on several workstations, choose a shared location; the module can then be shared with all workstations and updated at once. Edit Ramses.mod with a text editor, and replace the path in the first line with the absolute path where you\u2019ve unzipped the module. This is how the content of this file looks like: + Ramses 0.0.1-dev D:\\your\\path\\to\\the\\module PYTHONPATH+:=plug-ins MAYA_SHELF_PATH+:=shelves Do not change anything else in the file. In order to prevent unintended modifications to the Ramses shelf, you can set its read-only attribute: Right click on the shelves/shelf_Ramses.mel file and select Properties . Check the Read only box. Copy Ramses.mod in one of your modules paths e.g. C:\\Users\\User\\Documents\\Maya\\modules . You may need to create the modules folder if it does not exist yet. Repeat this operation on all workstations where you need the module. Restart Maya . Activate the Ramses plug-in from Maya \u2018s plug-in manager. You may need to restart Maya again so that the Ramses shelf is loaded.","title":"Installation"},{"location":"components/addons/maya/#features","text":"All features of the Ramses add-on are available through the new shelf. They are also registered as Mel and Python Maya commands. All these features are detailed in the next sections. To handle all file naming and sorting, Ramses includes commands to replace all the default Save , Save As and Open functions. Using (almost) only the Ramses commands ensures your files will always be correctly named and in the right location. It also helps Ramses track the production. Feature Maya Command Description Open the Ramses App ramOpenRamses Launches the Ramses Client Application (if its path is correctly set in the settings). Save ramSave Saves and backups the current scene; this save command is also used for production tracking. Comment ramSave Associates a comment wit the current scene file. Incremental Save ramSaveVersion Saves and increments the version of the current scene. Update Status / Publish ramSaveVersion Saves and increments the version of the current scene, while updating its current production tracking status. Optionally publishes the asset/shot. Create Preview ramPreview Creates a preview (thumbnail or playblast) of the current scene. Save as ramSaveAs Saves the scene as a new Asset, Shot or General item. Template ramPublishTemplate Saves the current scene as a new template for the current step. Setup scene ramSetupScene Setups the scene to make it Ramses-friendly. Open ramOpen Opens an Asset, Shot or Template. Import ramOpen Imports an Asset, Shot or Template. Replace ramOpen Replaces selected nodes with another Asset, Shot or Template. Update ramUpdate Updates assets and shots included in the scene. Retrieve Version ramRetrieveVersion Retrieves and restores a previous version of the current scene. Publish settings ramPublishSettings Sets the default publish settings for steps. Settings ramSettings Opens the settings dialog for the Ramses Add-on .","title":"Features"},{"location":"components/addons/maya/#save","text":"The Ramses Save command starts by saving the current scene, and then runs a few checks before backuping the file into the _versions subfolder: Naming Scheme : checks if the file is correctly named and located. If not, Ramses will run the Save as command instead to ensure the name is correct. Version : checks if the version has to be incremented. That\u2019s the case if the current scene is a restored previous version, or if the latest increment occured before the timeout set in the settings. Depending on these checks, Ramses will automatically associate a comment with the corresponding version to warn of any changes. The Mel and Python corresponding command is: ramSave . It can take two parameters: -set_comment or -sc : boolean used to set a comment associated to the current version file. -comment or -c : string is the comment to be associated if -sc is True . # Python import maya.cmds as cmds # Save the current file cmds.ramSave() # Save the file with a comment (show the comment dialog) cmds.ramSave(set_comment = True) # Save the file with a custom comment cmds.ramSave(sc = True, comment = \"A new comment!\")","title":"Save"},{"location":"components/addons/maya/#comment","text":"The Comment command saves the current scene the same way as the Save command, and adds a comment associated with the current version. This comment is displayed with the corresponding version in all version selection dialogs, both in the add-on itself and in the Ramses Client Application , as shown below. A list of versions with a few comments, as shown in the Ramses Maya Add-on . A list of versions with a few comments, as shown in the Ramses Client Application . The Mel and Python corresponding command is: ramSave with its two parameters -sc and c . Read the Save section for details. # Python import maya.cmds as cmds # Save the file with a custom comment cmds.ramSave(sc = True, comment = \"A new comment!\")","title":"Comment"},{"location":"components/addons/maya/#incremental-save","text":"The Incremental Save runs the save command and forces it to increment to a new version. The Mel and Python corresponding command is: ramSaveVersion with the parameter updateStatus set to False . Read the Update Status section for details. # Python import maya.cmds as cmds # Incremental save cmds.ramSaveVersion( updateStatus=False )","title":"Incremental Save"},{"location":"components/addons/maya/#update-status-and-publish","text":"The Update Status runs the Incremental Save command and updates the current production status of the current Asset or Shot. A dialog is shown with a few options to update the status, and to choose to also publish the scene, and create a preview for it. This dialog may differ depending on the use of the Ramses Client Application or not. This is the status dialog when connected to the Ramses Client Application . You can set the new State with the drop down list at the top left; the list of the states is retrieved from the Ramses Daemon . The slider and percentage is used to set a new Completion Ratio . The Comment field is used to update the comment displayed in the production tracking tools and tables of Ramses . All this information is automatically fed to the Ramses Daemon which updates the information for everyone. This is the status dialog when the Ramses Client Application isn't available. When not connected to the Daemon , there is still an option to set a State from a default limited list. Check the Publication button to publish the current scene. Check the Preview button to create a preview (thumbnail or playblast) for the current scene. Read the Preview section for more details. The Update Status and Save button updates the status, publishes the scene, and creates the preview, while the Skip and Just Save button just increments the version and saves. The Mel and Python corresponding command is: ramSaveVersion . It can take three parameters: -updateStatus or -us : boolean . When True (default), the status dialog is shown to let the user update the status. -publish or -p : boolean activates the publication of the scene. -preview or -pv : boolean activates the creation of a preview. # Python import maya.cmds as cmds # Shows the update status dialog cmds.ramSaveVersion() # Incremental save cmds.ramSaveVersion(updateStatus = False) # Publishes the file without showing the status dialog cmds.ramSaveVersion(publish = True, us = False) # Publishes and creates a preview without showing the status dialog cmds.ramSaveVersion(publish = True, preview = True, us = False)","title":"Update Status and Publish"},{"location":"components/addons/maya/#publish","text":"The publication of the scene is done in several steps: If the Ramses Daemon is available, Ramses checks if there are publish settings available. If no settings were found, or if the user checked the box to edit the settings, a dialog window is shown to let the user adjust the publish settings. The Scene is saved in the _published subfolder. This is the folder from which the scene and published files can be imported or referenced into other Assets and Shots. One or several files are published, according to the settings. Ramses then calls any potential publish function registered by the pipeline tools or an extension of the Add-On. \u25b9 Read the publishing guide for Maya for more information about the Maya pipeline.","title":"Publish"},{"location":"components/addons/maya/#preview","text":"The Preview command allows you to quickly create either an image (thumbnail) or a video (playblast) preview of the current scene, automatically saved in the _preview subfolder. There are a few options to adjust how the image or video are rendered. Ramses auto-selects the first renderable camera in the scene. To always automatically use the right camera, either add it in the render settings (and remove any other unneeded camera), or check the renderable option in the Ouput Settings section of its attributes. The size is a percentage of the resolution of the render settings of the scene. You can then adjust all the render options; checking both Only Polygons and Show Motion Trails allows to hide all animation controllers (if they\u2019re curves as usual) but keep the motion trails. By default, Ramses overwrites any previous image or video for the current scene, except if you set a new comment when making the preview. Note that the Ramses Client Application uses the preview with an empty comment as a thumbnail to display the asset or the shot in the user interface. Ramses also automatically burns useful meta-data in the image, like the frame number, the focal length, the comment, etc. The Mel and Python corresponding command is: ramPreview . # Python import maya.cmds as cmds # Shows the preview dialog cmds.ramPreview()","title":"Preview"},{"location":"components/addons/maya/#playblasts","text":"When rendering the playblasts, Ramses does not only renders them as usual Maya playblasts: you don\u2019t need to install Quicktime on windows anymore to export videos. Ramses automatically renders the playblasts in a very lightweight MP4 video, crafted especially for reviewing animations, with an intra-frame encoding setting which enables frame by frame playblack on every video player, with great performance. Ramses will also automatically play the video as soon as it\u2019s encoded using ffplay , a very efficient and lightweight video player. It may seem complicated at first as it does not have any User Interface, but it is easily controlled with a few shortcuts: To scroll in the video, [Right Click] anywhere on the video and drag the mouse horizontally. The left border of the frame represents the beginning of the video, while the right border represents the end. You can go forwards and backwards with the [\u2190] and [\u2192] keys of your keyboard by a few frames. Use [\u2191] and [\u2193] to go to the start or the end of the video. Use [Space] to play and pause the video. Use [S] for frame-by-frame playing. Hit [Q] to quickly quit the player.","title":"Playblasts"},{"location":"components/addons/maya/#save-as","text":"The Save As command can be used to create a new Asset or Shot, or save any other new file, while automatically naming and locating it. Ramses automatically selects the current Project . Select the type of item to save; either an Asset , a Shot or another general item. The list of Steps , Asset Groups and Items is automatically built either by asking the Ramses Daemon if the add-on is used with the Ramses Client Application or by looking into the folder structure, but it is possible to create a new one by just entering a new name. The Resource is used to differenciate several files for the same Asset or Shot. An empty Resource is considered the main and default working file for the item, but you can add any other file by just adding a small resource name. When selecting Other as type, the file will be saved in the main folder of the corresponding step. Read the section about the Ramses Tree for more information. The Mel and Python corresponding command is: ramSaveAs . # Python import maya.cmds as cmds # Shows the save as dialog cmds.ramSaveAs()","title":"Save As"},{"location":"components/addons/maya/#template","text":"Use the Template command to create a new template file to be used with a specific step. Use the Name to have several templates for the same step. Hint This command just creates the new template, but does not publish it. You still have to publish it using the Update Status command afterwards. Templates can then be used to create new scenes for specific Shots or Assets from the Ramses Client Application . Templates are also available with the Open / Import command of the add-on. The Mel and Python corresponding command is: ramPublishTemplate . # Python import maya.cmds as cmds # Shows the publish template dialog cmds.ramPublishTemplate()","title":"Template"},{"location":"components/addons/maya/#setup-scene","text":"The Setup scene command runs some checks on the current scene and makes sure everything works according to the current project. Ramses will automatically add the Ramses_Publish and Ramses_DelOnPublish sets if they\u2019re missing, and checks these values to optionally fix them: The frame rate (if the current scene is a Shot) The duration (if the current scene is a Shot) The rendering resolution The camera used in the render settings The name of the selected camera These checks are automatically run when the scene is saved. The Mel and Python corresponding command is: ramSetupScene . # Python import maya.cmds as cmds # Checks the scene settings and shows a dialog if something is wrong cmds.ramSetupScene()","title":"Setup scene"},{"location":"components/addons/maya/#open-import-replace","text":"The Open and Import command automatically finds available scenes from your projects. It is not needed to go down all the hierarchy to select a file to open; if you just select an item and a step, Ramses will automatically open or import the corresponding latest version of the main resource. It works the same way when importing items: you don\u2019t need to go all the way down to select the files you want to import; by selecting just the main file, Ramses will import everything available, or, if you\u2019re using an extension of the Add-on , it will pass all the files to the extension so it can automatically manage the import for you. When importing an item, Ramses will also trigger custom import scripts registered by the pipeline tools or an extension of the Maya Add-on . This is one way of automating your workflow, by just registering scripts to be called when publishing and importing items. The Mel and Python corresponding command is: ramOpen . It can take two parameters: import or -i : boolean. When True , the dialog is opened in import mode. replace or -r : boolean. When True , the dialog is opened in replace mode. # Python import maya.cmds as cmds # Shows the open dialog cmds.ramOpen() # Shows the import dialog cmds.ramOpen(i=true) # Shows the replace dialog cmds.ramOpen(r=true)","title":"Open,  Import,  Replace"},{"location":"components/addons/maya/#update","text":"Use the Update command to update (or downgrade) the assets included in the scene. For each asset, you can select which version to use in the scene and automatically replace it. The update command is able to update to a newer or downgrade to a previous version. The Mel and Python corresponding command is: ramUpdate . # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate()","title":"Update"},{"location":"components/addons/maya/#retrieve-version","text":"The Retrieve version command can be used to check and restore a previous version of the current scene. The Mel and Python corresponding command is: ramRetrieveVersion . # Python import maya.cmds as cmds # Shows the retrieve version dialog cmds.ramRetrieveVersion()","title":"Retrieve Version"},{"location":"components/addons/maya/#publish-settings","text":"\u25b9 Read the publishing guide for Maya for more information about the Maya pipeline.","title":"Publish Settings"},{"location":"components/addons/maya/#settings","text":"","title":"Settings"},{"location":"components/addons/maya/#versionning","text":"The Auto-Increment option sets how many time can be spent before Ramses automatically increments the version of the file when saving. Use this option to be sure you can get back to an earlier version of your work even if you forget to increment the version. the Save hotkey option replaces the default \u201c Save Scene \u201d [Ctrl + S] hotkey from Maya by the Save command from Ramses . This is recommended to enable all production tracking features of Ramses and ensure an automatic backup of your work. Note that checking this box does not replace the File/Save menu entry so you can still use the default Maya Save command. the Save as hotkey option replaces the default \u201c Save Scene As \u201d [Ctrl + Shift + S] hotkey from Maya by the Save As command from Ramses . Note that checking this box does not replace the File/Save as... menu entry so you can still use the default Maya Save as command. the Open hotkey option replaces the default \u201c Open Scene\u2026 \u201d [Ctrl + O] hotkey from Maya by the Open command from Ramses . Note that checking this box does not replace the File/Open Scene... menu entry so you can still use the default Maya Open* command.","title":"Versionning"},{"location":"components/addons/maya/#folders","text":"Set the main Ramses folder location . This is mandatory if you\u2019re using the add-on without the Ramses Client Application .","title":"Folders"},{"location":"components/addons/maya/#ramses-application","text":"Check the Connected box so that the Ramses Add-on will work with the Ramses Client Application for production tracking features. In order for this to work, you\u2019ll need to set the path to the Ramses.exe file inside the installation folder of the Ramses Client Application . The Ramses Daemon Port is the local networking port used by the Ramses Daemon to communicate with the add-ons. It must be the same value as the one set in the Ramses Client Application ; the default value is the birthdate of Karl Marx : 18185 (May, 5th 1818).","title":"Ramses Application"},{"location":"components/addons/maya/#development","text":"Change the Log Level to adjust how many information is printed in the console to help you debug your scripts when you\u2019re developping using the Ramses Python API or if you\u2019re extending the add-on .","title":"Development"},{"location":"components/client/","text":"Ramses Client Application The Ramses Client Application is the heart of the Ramses framework - which has actually many hearts, one per workstation. It is the application which gets and displays data from all other components , the Ramses Add-ons , the Ramses Server and the Ramses Tree It is especially in charge of global administration , project administration , pipeline creation , production tracking and planning . \u25b9 Installation . \u25b9 Settings and overview . \u25b9 Administration . \u25b9 Project administration . \u25b9 Pipeline creation . \u25b9 Production tracking . \u25b9 Planning and schedule .","title":"Introduction"},{"location":"components/client/#ramses-client-application","text":"The Ramses Client Application is the heart of the Ramses framework - which has actually many hearts, one per workstation. It is the application which gets and displays data from all other components , the Ramses Add-ons , the Ramses Server and the Ramses Tree It is especially in charge of global administration , project administration , pipeline creation , production tracking and planning . \u25b9 Installation . \u25b9 Settings and overview . \u25b9 Administration . \u25b9 Project administration . \u25b9 Pipeline creation . \u25b9 Production tracking . \u25b9 Planning and schedule .","title":"Ramses Client Application"},{"location":"components/client/admin/","text":"Administration panel The adminstration panel is accessible only to Administrator users . This is where the global settings of the Ramses framework can be adjusted, and where re-usable elements across all projects (templates, states, applications\u2026) can be managed. \u25b9 User management . \u25b9 Project management . \u25b9 Template step management . \u25b9 Template asset group management . \u25b9 State management . \u25b9 File type management . \u25b9 Application management .","title":"Introduction"},{"location":"components/client/admin/#administration-panel","text":"The adminstration panel is accessible only to Administrator users . This is where the global settings of the Ramses framework can be adjusted, and where re-usable elements across all projects (templates, states, applications\u2026) can be managed. \u25b9 User management . \u25b9 Project management . \u25b9 Template step management . \u25b9 Template asset group management . \u25b9 State management . \u25b9 File type management . \u25b9 Application management .","title":"Administration panel"},{"location":"components/client/applications/","text":"Application management This panel is used to list and manage all the applications Ramses needs to know for the pipeline management. Read the section about the Pipeline for more details about how applications are used. List The list on the left lists all the applications, and you can use the Search field to filter them by name or ID . Use the button to create a new application. The button removes the selected applications from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new applications. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected applications. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Ramses comes with a predefined list of applications, but this list is completely customizable: you can remove and add as many applications as you need. Edition Name is the state\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the application, describing it. Executable file is the path to the executable binary used to launch the application. The blue button opens a file selector to change the file path. The Native , Import and Export buttons display three lists of file types to be associated with the application: Native file types are the ones which can be edited (read and written while keeping them editable) with the application. Import file types are files which can be read by the application. Export file types are files which can be written by the application, but losing the ability to edit it later. The button contains a list of available file types, and an entry to quickly create a new file type without having to switch to the file types tab. The button unassigns the selected file types from the application but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the edit button to edit them in a side docked panel. Read the file type management section for more details about file type edition. Tip The executable file field is optional. To open a specific file, if this field is left empty, Ramses will use the default application from the system instead, so it may be quicker and easier to set the file association at the system level. Using this field can be handy in case you\u2019re using different versions of the same software, or if you want to override default file association, in which case Ramses needs the actual executable file path. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Applications"},{"location":"components/client/applications/#application-management","text":"This panel is used to list and manage all the applications Ramses needs to know for the pipeline management. Read the section about the Pipeline for more details about how applications are used.","title":"Application management"},{"location":"components/client/applications/#list","text":"The list on the left lists all the applications, and you can use the Search field to filter them by name or ID . Use the button to create a new application. The button removes the selected applications from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new applications. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected applications. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Ramses comes with a predefined list of applications, but this list is completely customizable: you can remove and add as many applications as you need.","title":"List"},{"location":"components/client/applications/#edition","text":"Name is the state\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the application, describing it. Executable file is the path to the executable binary used to launch the application. The blue button opens a file selector to change the file path. The Native , Import and Export buttons display three lists of file types to be associated with the application: Native file types are the ones which can be edited (read and written while keeping them editable) with the application. Import file types are files which can be read by the application. Export file types are files which can be written by the application, but losing the ability to edit it later. The button contains a list of available file types, and an entry to quickly create a new file type without having to switch to the file types tab. The button unassigns the selected file types from the application but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the edit button to edit them in a side docked panel. Read the file type management section for more details about file type edition. Tip The executable file field is optional. To open a specific file, if this field is left empty, Ramses will use the default application from the system instead, so it may be quicker and easier to set the file association at the system level. Using this field can be handy in case you\u2019re using different versions of the same software, or if you want to override default file association, in which case Ramses needs the actual executable file path. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/assetgroups/","text":"Asset group settings This panel is used to list and manage all the asset groups of the project. Asset groups are used to help you sort and filter the assets of the project . They\u2019re also used in the Ramses Tree . List The list on the left lists all the asset groups of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each asset group can be displayed. The folder button on the top right corner for each asset group in the list opens the asset group folder in your file explorer. Use the button to create a new asset group (either from scratch or using a template). The button removes the selected asset groups from the project 1 . You can use the [Shift + A] shortcut key to quickly add new asset groups. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected asset groups. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Name is the asset group\u2019s display name. It can\u2019t be changed after the asset group folder has been created . ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the asset group and describing it. The button opens the asset group folder in your file explorer. This folder contains the individual asset folders. Assets contained in the group are listed in the bottom section. The button instantly creates a new asset contained in the current group. The button removes the selected assets from the project 1 . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific asset folder, and the edit button to edit them in a side docked panel. Read the asset settings section for more details about asset edition. Tip To change the name of the asset group, you can temporarilly rename its corresponding folder, change the name in Ramses , and finally rename the folder after the new name. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9","title":"Asset Groups"},{"location":"components/client/assetgroups/#asset-group-settings","text":"This panel is used to list and manage all the asset groups of the project. Asset groups are used to help you sort and filter the assets of the project . They\u2019re also used in the Ramses Tree .","title":"Asset group settings"},{"location":"components/client/assetgroups/#list","text":"The list on the left lists all the asset groups of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each asset group can be displayed. The folder button on the top right corner for each asset group in the list opens the asset group folder in your file explorer. Use the button to create a new asset group (either from scratch or using a template). The button removes the selected asset groups from the project 1 . You can use the [Shift + A] shortcut key to quickly add new asset groups. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected asset groups. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/assetgroups/#edition","text":"Name is the asset group\u2019s display name. It can\u2019t be changed after the asset group folder has been created . ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the asset group and describing it. The button opens the asset group folder in your file explorer. This folder contains the individual asset folders. Assets contained in the group are listed in the bottom section. The button instantly creates a new asset contained in the current group. The button removes the selected assets from the project 1 . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific asset folder, and the edit button to edit them in a side docked panel. Read the asset settings section for more details about asset edition. Tip To change the name of the asset group, you can temporarilly rename its corresponding folder, change the name in Ramses , and finally rename the folder after the new name. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9","title":"Edition"},{"location":"components/client/assets/","text":"Asset settings This panel is used to list and manage all the assets of the project . There is no production tracking from this panel, as it is used only to edit asset settings. List The list on the left lists all the assets of the project, and you can use the Search field to filter them by name or ID . The top selector filters the assets according to their containing group . When changing the size of the rows in the list, more details about each asset can be displayed. The folder button on the top right corner for each asset in the list opens the asset folder in your file explorer. Use the button to create a new asset in the current group. The button removes the selected asset from the project 1 . You can use the [Shift + A] shortcut key to quickly add new assets. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected assets. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Name is the asset\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the asset folder has been created . Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the asset and describing it. Tags can be used later to search for specific assets. It is a comma separated list of any text. You can change the Asset group which contains this asset. The button opens the asset folder in your file explorer. This folder contains the individual working files, each in its step subfolder. For more details, read the Ramses Tree section. Hint In the current version of Ramses , when changing the asset group, the asset folder won\u2019t be automatically moved. This may change in a future version. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Assets"},{"location":"components/client/assets/#asset-settings","text":"This panel is used to list and manage all the assets of the project . There is no production tracking from this panel, as it is used only to edit asset settings.","title":"Asset settings"},{"location":"components/client/assets/#list","text":"The list on the left lists all the assets of the project, and you can use the Search field to filter them by name or ID . The top selector filters the assets according to their containing group . When changing the size of the rows in the list, more details about each asset can be displayed. The folder button on the top right corner for each asset in the list opens the asset folder in your file explorer. Use the button to create a new asset in the current group. The button removes the selected asset from the project 1 . You can use the [Shift + A] shortcut key to quickly add new assets. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected assets. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/assets/#edition","text":"Name is the asset\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the asset folder has been created . Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the asset and describing it. Tags can be used later to search for specific assets. It is a comma separated list of any text. You can change the Asset group which contains this asset. The button opens the asset folder in your file explorer. This folder contains the individual working files, each in its step subfolder. For more details, read the Ramses Tree section. Hint In the current version of Ramses , when changing the asset group, the asset folder won\u2019t be automatically moved. This may change in a future version. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/filetypes/","text":"File type management This panel is used to list and manage all the file types Ramses needs to know for the pipeline management. Read the section about the Pipeline for more details about how file types are used. List The list on the left lists all the file types, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each file type can be displayed. The file types are sorted by main extension. Use the button to create a new file type. The button removes the selected file types from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new file types. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected file types. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Ramses comes with a predefined list of file types, but this list is completely customizable: you can remove and add as many types as you need. Edition Name is the file type\u2019s display name. Main extension is the extension used by default for the file type. You must not include the leading dot . . Comment can be any text associated to the file type, describing it. All extensions is a comma separated list of all the extensions this file can use. You don\u2019t need to include the leading dot. The main extension must be repeated in this field . Previewable can be checked to let Ramses know that the file can be used for previews (it is lightweight and can be displayed by standard players/image viewers). Note A file can have multiple extensions, like JPEG for example which can use jpg , jpeg , or jpe . When it has multiple extensions, this means a specific file can be renamed to change the extension and it will still work exactly the same way. On the contrary, even if two files can be opened with the same software they may not be the same type with different extensions; for example, both .ma and .mb files are Maya files, but they\u2019re two different types anyway; renaming an ma file to mb will break it. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"File Types"},{"location":"components/client/filetypes/#file-type-management","text":"This panel is used to list and manage all the file types Ramses needs to know for the pipeline management. Read the section about the Pipeline for more details about how file types are used.","title":"File type management"},{"location":"components/client/filetypes/#list","text":"The list on the left lists all the file types, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each file type can be displayed. The file types are sorted by main extension. Use the button to create a new file type. The button removes the selected file types from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new file types. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected file types. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Ramses comes with a predefined list of file types, but this list is completely customizable: you can remove and add as many types as you need.","title":"List"},{"location":"components/client/filetypes/#edition","text":"Name is the file type\u2019s display name. Main extension is the extension used by default for the file type. You must not include the leading dot . . Comment can be any text associated to the file type, describing it. All extensions is a comma separated list of all the extensions this file can use. You don\u2019t need to include the leading dot. The main extension must be repeated in this field . Previewable can be checked to let Ramses know that the file can be used for previews (it is lightweight and can be displayed by standard players/image viewers). Note A file can have multiple extensions, like JPEG for example which can use jpg , jpeg , or jpe . When it has multiple extensions, this means a specific file can be renamed to change the extension and it will still work exactly the same way. On the contrary, even if two files can be opened with the same software they may not be the same type with different extensions; for example, both .ma and .mb files are Maya files, but they\u2019re two different types anyway; renaming an ma file to mb will break it. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/install/","text":"Application installation The method to install Ramses depends on your operating system; no matter what, it is installed as any other standard application. As soon as the application is installed and running, go to the settings to configure it. Linux On Debian -based distributions , like Ubuntu for example, the easiest way to install the Ramses Client Application is to download and install the .deb package, which will also install all dependencies, using your usual package manager / installer. Tip The quickest way to install a deb package is using a terminal: sudo apt-get install ./ramses-client_x.x.x.deb . For other distributions or if you have any issues with the .deb package, you can just download and run the .appImage package. Warning When using the .appImage package, openSSL will not be automatically installed; if you need a secure connexion to the server you will have to install it with your usual package manager. Windows There\u2019s no installer for Windows (yet). To install Ramses , you can just unzip the files in a folder of your choice. If you want Ramses to start with the system, you can just copy a shortcut to Ramses.exe in the startup folder. You can access this startup folder with the shortcut [Win] + [R] and typing shell:startup . Mac OS Ramses is available as a .dmg file. Just open the archive, and drop the Ramses app in your Applications folder (or anywhere else).","title":"Installation"},{"location":"components/client/install/#application-installation","text":"The method to install Ramses depends on your operating system; no matter what, it is installed as any other standard application. As soon as the application is installed and running, go to the settings to configure it.","title":"Application installation"},{"location":"components/client/install/#linux","text":"On Debian -based distributions , like Ubuntu for example, the easiest way to install the Ramses Client Application is to download and install the .deb package, which will also install all dependencies, using your usual package manager / installer. Tip The quickest way to install a deb package is using a terminal: sudo apt-get install ./ramses-client_x.x.x.deb . For other distributions or if you have any issues with the .deb package, you can just download and run the .appImage package. Warning When using the .appImage package, openSSL will not be automatically installed; if you need a secure connexion to the server you will have to install it with your usual package manager.","title":"Linux"},{"location":"components/client/install/#windows","text":"There\u2019s no installer for Windows (yet). To install Ramses , you can just unzip the files in a folder of your choice. If you want Ramses to start with the system, you can just copy a shortcut to Ramses.exe in the startup folder. You can access this startup folder with the shortcut [Win] + [R] and typing shell:startup .","title":"Windows"},{"location":"components/client/install/#mac-os","text":"Ramses is available as a .dmg file. Just open the archive, and drop the Ramses app in your Applications folder (or anywhere else).","title":"Mac OS"},{"location":"components/client/pipeline/","text":"Pipeline editor The pipeline panel is accessible only to Administrator and Project administrator users . This is where the project pipeline can be created and edited. \u25b9 More details about the pipeline . Overview The pipeline editor has three main areas: the toolbar on top contains a few useful menus and tools, the nodal view is where steps and pipes are connected, and the dock shows the editors (on the right side of the nocal view by default). All docked panels can be undocked (as shown on the picture below) or docked on the other side of the nodal view, by dragging their title bar at the top of the panel. Toolbar On its left side, the toolbar displays a few menus. View Center view resets the zoom of the nodal view to 100% and centers it. Shortcut: [Home] Center selection centers the selected nodes and zooms in on them. Shortcuts: [F] or [.] on the numpad. Select Select all steps selects all the steps in the nodal view. Shortcut: [A] Select children steps selects all the steps following the currently selected one(s). Repeat the command to expand the selection on the child side. Shortcut: [Ctrl + A] Select parent steps selects all the steps preceding the currently selected one(s). Repeat the command to expand the selection on the parent side. Shortcut: [Alt + A] Layout Layout all steps automatically arranges all the nodes using a smart (or not) algorithm to (try to) make the layout clearer. Shortcut: [Shift + L] Layout selected steps will use the same smart (or not) algorithm to (try to) make the layout clearer for the selected nodes. Shortcut: [Alt + L] Reload project layout will load the default layout for this project. Shorcut: [Shift + R] Save project layout saves (overwrite) the default layout for this project. Shorcut: [Shift + S] Step Create new step creates a new step from scratch in the project, and opens a side docked editor to edit its details. Shortcut: [Shift + A] The list of Template steps can be used to quickly create a new step from an template. Remove selected steps removes the selected steps from the project 1 . Shortcut: [Shift + X] Delete selection removes everything selected (steps and pipes) from the project 1 . Shortcut: [Del] Pipe Remove selected pipes removes the selected pipes from the project 1 , disconnected corresponding steps. Shortcut: [Alt + X] On its right side, the toolbar has a few settings available. Center view , Shortcut: [Home] Center selection , Shortcuts: [F] or [.] on the numpad Zoom changes the zoom of the nodal view. Minimum zoom is 25%. The Grid size is used when snapping nodes and defines the snap precision. It is displayed as small crosses in the nodal view when it has focus. Snap to grid will snap the nodes to the grid when moving them, allowing you to perfectly align them, you maniac. Node view In the node view, you can move around all the nodes (steps) by just clicking and dragging them. To select multiple nodes, just click on the background and drag the mouse to use a box selection. You can select both nodes (steps) and connections (pipes); when a node or a pipe is selected, its corresponding editor is shown in the right dock area to let you edit its details. To manipulate the view, use the following shortcuts: [middle click] to pan . [Ctrl + middle click] to zoom . When opening a project from the first time, the nodes may be stacked all together, and you\u2019ll have to sort the spaghettis. To do this quickly, start by using the automatic layout! Select Layout \u25b8 Layout all steps or use the [Shift + L] shortcut. Pipeline edition To create and edit your pipeline, you just have to follow these simple steps: Create new steps , either from a template using the Step menu or from scratch ( [Shift + A] ). When a step is created, it is automatically selected and its editor panel is docked on the right area. Read the project step settings documentation for details about the settings in the step editor. You can also edit the applications (and their file types ) assigned to the steps with the edit button. Connect the steps together: click on the green dot on the right of a step and drag to the blue dot on the left of another step to connect them. The connections goes from left to right (the step on the right is the child). Select the connection (the pipe) to edit it. In the pipe editor, you can check the steps from and to which the connections goes. The Files list contains the file types this pipe can accept. The button contains a list of available types you can assign to the pipe, and an entry to quickly create a pipe type without having to switch to the project pipe types settings panel. The button unassigns the selected pipe types from the pipe but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the edit button to edit them in another side docked panel. Read the project pipe types settings section for more details about pipe types edition. This list is what is passed to the Ramses Add-Ons when they\u2019re exporting or importing items to and from the connected steps to let them know which kind of data and files they need to use. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9 \u21a9","title":"Pipeline editor"},{"location":"components/client/pipeline/#pipeline-editor","text":"The pipeline panel is accessible only to Administrator and Project administrator users . This is where the project pipeline can be created and edited. \u25b9 More details about the pipeline .","title":"Pipeline editor"},{"location":"components/client/pipeline/#overview","text":"The pipeline editor has three main areas: the toolbar on top contains a few useful menus and tools, the nodal view is where steps and pipes are connected, and the dock shows the editors (on the right side of the nocal view by default). All docked panels can be undocked (as shown on the picture below) or docked on the other side of the nodal view, by dragging their title bar at the top of the panel.","title":"Overview"},{"location":"components/client/pipeline/#toolbar","text":"On its left side, the toolbar displays a few menus. View Center view resets the zoom of the nodal view to 100% and centers it. Shortcut: [Home] Center selection centers the selected nodes and zooms in on them. Shortcuts: [F] or [.] on the numpad. Select Select all steps selects all the steps in the nodal view. Shortcut: [A] Select children steps selects all the steps following the currently selected one(s). Repeat the command to expand the selection on the child side. Shortcut: [Ctrl + A] Select parent steps selects all the steps preceding the currently selected one(s). Repeat the command to expand the selection on the parent side. Shortcut: [Alt + A] Layout Layout all steps automatically arranges all the nodes using a smart (or not) algorithm to (try to) make the layout clearer. Shortcut: [Shift + L] Layout selected steps will use the same smart (or not) algorithm to (try to) make the layout clearer for the selected nodes. Shortcut: [Alt + L] Reload project layout will load the default layout for this project. Shorcut: [Shift + R] Save project layout saves (overwrite) the default layout for this project. Shorcut: [Shift + S] Step Create new step creates a new step from scratch in the project, and opens a side docked editor to edit its details. Shortcut: [Shift + A] The list of Template steps can be used to quickly create a new step from an template. Remove selected steps removes the selected steps from the project 1 . Shortcut: [Shift + X] Delete selection removes everything selected (steps and pipes) from the project 1 . Shortcut: [Del] Pipe Remove selected pipes removes the selected pipes from the project 1 , disconnected corresponding steps. Shortcut: [Alt + X] On its right side, the toolbar has a few settings available. Center view , Shortcut: [Home] Center selection , Shortcuts: [F] or [.] on the numpad Zoom changes the zoom of the nodal view. Minimum zoom is 25%. The Grid size is used when snapping nodes and defines the snap precision. It is displayed as small crosses in the nodal view when it has focus. Snap to grid will snap the nodes to the grid when moving them, allowing you to perfectly align them, you maniac.","title":"Toolbar"},{"location":"components/client/pipeline/#node-view","text":"In the node view, you can move around all the nodes (steps) by just clicking and dragging them. To select multiple nodes, just click on the background and drag the mouse to use a box selection. You can select both nodes (steps) and connections (pipes); when a node or a pipe is selected, its corresponding editor is shown in the right dock area to let you edit its details. To manipulate the view, use the following shortcuts: [middle click] to pan . [Ctrl + middle click] to zoom . When opening a project from the first time, the nodes may be stacked all together, and you\u2019ll have to sort the spaghettis. To do this quickly, start by using the automatic layout! Select Layout \u25b8 Layout all steps or use the [Shift + L] shortcut.","title":"Node view"},{"location":"components/client/pipeline/#pipeline-edition","text":"To create and edit your pipeline, you just have to follow these simple steps: Create new steps , either from a template using the Step menu or from scratch ( [Shift + A] ). When a step is created, it is automatically selected and its editor panel is docked on the right area. Read the project step settings documentation for details about the settings in the step editor. You can also edit the applications (and their file types ) assigned to the steps with the edit button. Connect the steps together: click on the green dot on the right of a step and drag to the blue dot on the left of another step to connect them. The connections goes from left to right (the step on the right is the child). Select the connection (the pipe) to edit it. In the pipe editor, you can check the steps from and to which the connections goes. The Files list contains the file types this pipe can accept. The button contains a list of available types you can assign to the pipe, and an entry to quickly create a pipe type without having to switch to the project pipe types settings panel. The button unassigns the selected pipe types from the pipe but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the edit button to edit them in another side docked panel. Read the project pipe types settings section for more details about pipe types edition. This list is what is passed to the Ramses Add-Ons when they\u2019re exporting or importing items to and from the connected steps to let them know which kind of data and files they need to use. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9 \u21a9","title":"Pipeline edition"},{"location":"components/client/pipetypes/","text":"Pipe settings This panel is used to list and manage all the different types of pipes of the project which are used by the pipeline . Pipes can also be more easily created, edited and connected from the pipeline editor . Pipe types define the type of files and data which can be used through the pipes between steps . \u25b9 More details about the pipeline . Edition ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It\u2019s this ID which is passed to the Ramses Add-ons to let them know what they need to export or import, along with the other information from the pipe. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the pipe and describing it. Use the Type list to set the type of the step. Read this for more information about step types. You can select one File type to be used through this pipe; if you need several different types, you can use multiple pipes between steps. Read the Pipeline Editor section for more information. You can select one Color space to be used through this pipe; if you need several different color spaces, you can use multiple pipes between steps. Read the Pipeline Editor section for more information. Use the Custom Settings to set default settings to be used by Ramses Add-ons to automate the pipeline. These settings will be read when importing this specific file type, if it is assigned to a incoming pipe of the corresponding steps. Using the official Ramses Add-ons , these settings should be formatted using the Yaml syntax. Read the Add-ons section for more information about the settings you can use. \u25b9 More details about the pipeline . Warning Color spaces are not implemented yet! The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Pipe Types"},{"location":"components/client/pipetypes/#pipe-settings","text":"This panel is used to list and manage all the different types of pipes of the project which are used by the pipeline . Pipes can also be more easily created, edited and connected from the pipeline editor . Pipe types define the type of files and data which can be used through the pipes between steps . \u25b9 More details about the pipeline .","title":"Pipe settings"},{"location":"components/client/pipetypes/#edition","text":"ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It\u2019s this ID which is passed to the Ramses Add-ons to let them know what they need to export or import, along with the other information from the pipe. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the pipe and describing it. Use the Type list to set the type of the step. Read this for more information about step types. You can select one File type to be used through this pipe; if you need several different types, you can use multiple pipes between steps. Read the Pipeline Editor section for more information. You can select one Color space to be used through this pipe; if you need several different color spaces, you can use multiple pipes between steps. Read the Pipeline Editor section for more information. Use the Custom Settings to set default settings to be used by Ramses Add-ons to automate the pipeline. These settings will be read when importing this specific file type, if it is assigned to a incoming pipe of the corresponding steps. Using the official Ramses Add-ons , these settings should be formatted using the Yaml syntax. Read the Add-ons section for more information about the settings you can use. \u25b9 More details about the pipeline . Warning Color spaces are not implemented yet! The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/production/","text":"Asset and shot production tracking There are two panels to track the production of the shots and of the assets . From these tables, you can manage the status of all the assets and all the shots of the project, check their completion ratio , how much time was spent for each of them, check the estimation , and finally how late (or not) you are \u2026 \u25b9 More details about production tracking . Overview The production tables have three main areas: the toolbar on top contains a few useful menus and tools, the main table is where shots or assets are listed, and the dock shows the editors (on the right side of the main table by default). Toolbar On its left side, the toolbar displays a few menus and tools. The first button is a selector to let you filter the displayed asset by asset group, or the shots by sequence. Use the Search field to filter the shots or assets according to their names or IDS . View Show details : when checked, the default height of the cells is adjusted to show all details and information. Sort Use the sort menu to sort the rows either by: ID, name, difficulty, time spent, estimation or completion ratio. Steps Select all shows all the steps in the table. Select none hides all the steps from the table. Select my steps shows only the steps where the current user has some tasks assigned. Use the list of steps to select the ones you want to be shown in the main table. Status Assign User assigns a user to all selected tasks. Change state changes the state of all selected tasks. Changer difficulty changes the difficulty of all selected tasks. Set completion changes the completion ratio of all selected tasks. If the current user is at least a project adminstrator , the toolbar also displays an entry to let you quickly create new items (shots or assets) or remove selected items. Hint To sort rows, click on the sort button on the top left part of the column you want to use for sorting. Tip The Status menu is also availabe as a context menu with the [right click] . Main table From the main table, you can have a look at all the status of all shots or assets, and a summary for steps on the column headers. You can use the [Middle Click] to quickly scroll/pan in the table. The progress bar in the step headers goes from red to green when the completion ratio raises. The first column contains all the information about the shots or the assets (duration, tags, etc.). For all cells, you can open the corresponding folder with the folder button, and if you have enough rights you can click the corresponding cell to edit the details on the side panel. 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). The title of the cell shows the ID of the asset or shot, of the step, and of the current state. The current version of the working file is shown in parenthesis. The button shows the status history of the task. The progress bar can show multiple information. Its color corresponds to the current state color . It shows the completion ratio. Click on any cell to edit its details in a side panel: Use the colored state box on the top left to change the current state. Use the completion slider on the top right to change completion ratio. Just click the slider without dragging to precisely edit the value. You can add a comment just below the completion ratio. Changing the difficulty will change the automatic estimation, according to the settings of the corresponding step . Uncheck the Auto checkbox to manually estimate the time you need to finish the task. Once unchecked, the estimation will not be automatically changed anymore if you change the difficulty or if the step settings change. The time spent is automatically updated by Ramses when you edit the status, according to the information it gets from the Ramses Add-ons and the data it gathers from the files if they\u2019re correctly named and located. You can manually override this value. The current version should be automatically set by Ramses if you\u2019re using the Ramses Add-ons ; otherwise you can set it manually. If the task is published and ready to be used and imported in the next step, check the Published box. Again, Ramses should check it automatically if you\u2019ve published the task using the Ramses Add-ons . The bottom box is used to Assign a user to the task. Leave it to All Users to unassign the task. All these settings can be set precisely by the Ramses Add-ons thanks to pipeline automations, and the resulting data can be used for production tracking and planning \u25b9 More details about the pipeline . \u25b9 More details about production tracking . \u25b9 More details about planning . The bottom part of the status editor shows the available working , published and preview files. From these three lists, you can open any file by just double-clicking it. You can restore previous versions of working and published files, and the create from template button in the Work tab can create a new file from a step template (if any template has been published). Files must respect the Ramses naming scheme and folders to be detected and listed here, but you don\u2019t necessarily have to use the Ramses Add-ons , all files will be detected and handled by Ramses . Statistics The Statistics button on the title bar of the application opens a summary of the progress of all steps and the whole project. The top part shows the statistics for the whole project. Remaining time is the count of actual days before reaching the deadline of the project. Completion is the global completion of the project, both as a percentage, and a number of work-days completed (compared to the total estimated work-day count). Estimated Lateness is an estimation of the lateness for all steps; 0% means all is well, a negative lateness means there\u2019s some advance (no, this never happens), a positive value means the production is late. 100% means it took twice the time originally estimated to get to the current completion ratio! For each step, Ramses also compares the remaining work to the schedule, to warn you if you need to plan more days to complete the given step (or if there are extra days). If you pull the row to make it bigger, you can get more details. Assigned shows how many days are assigned in the schedule for the given step, including past and future dates. Extra / Missing shows how many more days are needed to be assigned to the given step, or how many extra days are assigned, compared to the estimation. To the contrary of the extra or missing days shown above, this value does not take into account how much actual work was already done. Timelime The Timeline button on the title bar of the application opens a timeline panel showing all the shots of the project. From this timeline, you can reorder shots, open their folder, or edit their details by just clicking on the corresponding cell. The width of each row depends on the duration of the corresponding shot. You can Use [Middle Click] to quickly scroll in the timeline, and you can use the slider on the left to zoom in and out. You can also control the zoom with [Ctrl] + [Middle Click] or with the [Mouse Wheel] . When selecting a shot on the timeline, it is also selected in the shot table, and vice versa.","title":"Asset and shot production tracking"},{"location":"components/client/production/#asset-and-shot-production-tracking","text":"There are two panels to track the production of the shots and of the assets . From these tables, you can manage the status of all the assets and all the shots of the project, check their completion ratio , how much time was spent for each of them, check the estimation , and finally how late (or not) you are \u2026 \u25b9 More details about production tracking .","title":"Asset and shot production tracking"},{"location":"components/client/production/#overview","text":"The production tables have three main areas: the toolbar on top contains a few useful menus and tools, the main table is where shots or assets are listed, and the dock shows the editors (on the right side of the main table by default).","title":"Overview"},{"location":"components/client/production/#toolbar","text":"On its left side, the toolbar displays a few menus and tools. The first button is a selector to let you filter the displayed asset by asset group, or the shots by sequence. Use the Search field to filter the shots or assets according to their names or IDS . View Show details : when checked, the default height of the cells is adjusted to show all details and information. Sort Use the sort menu to sort the rows either by: ID, name, difficulty, time spent, estimation or completion ratio. Steps Select all shows all the steps in the table. Select none hides all the steps from the table. Select my steps shows only the steps where the current user has some tasks assigned. Use the list of steps to select the ones you want to be shown in the main table. Status Assign User assigns a user to all selected tasks. Change state changes the state of all selected tasks. Changer difficulty changes the difficulty of all selected tasks. Set completion changes the completion ratio of all selected tasks. If the current user is at least a project adminstrator , the toolbar also displays an entry to let you quickly create new items (shots or assets) or remove selected items. Hint To sort rows, click on the sort button on the top left part of the column you want to use for sorting. Tip The Status menu is also availabe as a context menu with the [right click] .","title":"Toolbar"},{"location":"components/client/production/#main-table","text":"From the main table, you can have a look at all the status of all shots or assets, and a summary for steps on the column headers. You can use the [Middle Click] to quickly scroll/pan in the table. The progress bar in the step headers goes from red to green when the completion ratio raises. The first column contains all the information about the shots or the assets (duration, tags, etc.). For all cells, you can open the corresponding folder with the folder button, and if you have enough rights you can click the corresponding cell to edit the details on the side panel. 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). The title of the cell shows the ID of the asset or shot, of the step, and of the current state. The current version of the working file is shown in parenthesis. The button shows the status history of the task. The progress bar can show multiple information. Its color corresponds to the current state color . It shows the completion ratio. Click on any cell to edit its details in a side panel: Use the colored state box on the top left to change the current state. Use the completion slider on the top right to change completion ratio. Just click the slider without dragging to precisely edit the value. You can add a comment just below the completion ratio. Changing the difficulty will change the automatic estimation, according to the settings of the corresponding step . Uncheck the Auto checkbox to manually estimate the time you need to finish the task. Once unchecked, the estimation will not be automatically changed anymore if you change the difficulty or if the step settings change. The time spent is automatically updated by Ramses when you edit the status, according to the information it gets from the Ramses Add-ons and the data it gathers from the files if they\u2019re correctly named and located. You can manually override this value. The current version should be automatically set by Ramses if you\u2019re using the Ramses Add-ons ; otherwise you can set it manually. If the task is published and ready to be used and imported in the next step, check the Published box. Again, Ramses should check it automatically if you\u2019ve published the task using the Ramses Add-ons . The bottom box is used to Assign a user to the task. Leave it to All Users to unassign the task. All these settings can be set precisely by the Ramses Add-ons thanks to pipeline automations, and the resulting data can be used for production tracking and planning \u25b9 More details about the pipeline . \u25b9 More details about production tracking . \u25b9 More details about planning . The bottom part of the status editor shows the available working , published and preview files. From these three lists, you can open any file by just double-clicking it. You can restore previous versions of working and published files, and the create from template button in the Work tab can create a new file from a step template (if any template has been published). Files must respect the Ramses naming scheme and folders to be detected and listed here, but you don\u2019t necessarily have to use the Ramses Add-ons , all files will be detected and handled by Ramses .","title":"Main table"},{"location":"components/client/production/#statistics","text":"The Statistics button on the title bar of the application opens a summary of the progress of all steps and the whole project. The top part shows the statistics for the whole project. Remaining time is the count of actual days before reaching the deadline of the project. Completion is the global completion of the project, both as a percentage, and a number of work-days completed (compared to the total estimated work-day count). Estimated Lateness is an estimation of the lateness for all steps; 0% means all is well, a negative lateness means there\u2019s some advance (no, this never happens), a positive value means the production is late. 100% means it took twice the time originally estimated to get to the current completion ratio! For each step, Ramses also compares the remaining work to the schedule, to warn you if you need to plan more days to complete the given step (or if there are extra days). If you pull the row to make it bigger, you can get more details. Assigned shows how many days are assigned in the schedule for the given step, including past and future dates. Extra / Missing shows how many more days are needed to be assigned to the given step, or how many extra days are assigned, compared to the estimation. To the contrary of the extra or missing days shown above, this value does not take into account how much actual work was already done.","title":"Statistics"},{"location":"components/client/production/#timelime","text":"The Timeline button on the title bar of the application opens a timeline panel showing all the shots of the project. From this timeline, you can reorder shots, open their folder, or edit their details by just clicking on the corresponding cell. The width of each row depends on the duration of the corresponding shot. You can Use [Middle Click] to quickly scroll in the timeline, and you can use the slider on the left to zoom in and out. You can also control the zoom with [Ctrl] + [Middle Click] or with the [Mouse Wheel] . When selecting a shot on the timeline, it is also selected in the shot table, and vice versa.","title":"Timelime"},{"location":"components/client/project/","text":"Project settings panel The project panel is accessible only to Administrator and Project administrator users . This is where the global settings of the current project can be adjusted. The project configured there is the one set with the selector on the title bar . \u25b9 The first tab shows the project settings; the options are described in the Project management section. \u25b9 Steps . \u25b9 Pipe Types . \u25b9 Asset groups . \u25b9 Assets . \u25b9 Sequences . \u25b9 Shots .","title":"Introduction"},{"location":"components/client/project/#project-settings-panel","text":"The project panel is accessible only to Administrator and Project administrator users . This is where the global settings of the current project can be adjusted. The project configured there is the one set with the selector on the title bar . \u25b9 The first tab shows the project settings; the options are described in the Project management section. \u25b9 Steps . \u25b9 Pipe Types . \u25b9 Asset groups . \u25b9 Assets . \u25b9 Sequences . \u25b9 Shots .","title":"Project settings panel"},{"location":"components/client/projects/","text":"Project management This panel is used to list and manage all projects of Ramses . List The list on the left lists all the projects, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each project can be displayed. The folder button on the top right corner for each project in the list opens the project folder in your file explorer. Use the button to create a new project. The button removes the selected projects from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new projects. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected projects. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Name is the project\u2019s display name and can be changed any time. ID is the unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed after the project folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the project. Resolution is the width and height of the final video, in pixels. The first button allows you to quickly select from a list of common resolutions. Framerate is the framerate of the final video, in frames per second. Use the first button to quickly select it from a list of common framerates. Deadline is the date at which the project must be finished and delivered. You can change the folder where the project files are stored. Leave the field empty to set back the default folder inside the Ramses Tree . The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Use the Users list to assign and unassign users to the project. The button contains a list of available users, and an entry to quickly create a new user without having to switch to the users tab. The button unassigns the selected users from the project but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific user folder, and the edit button to edit them in a side docked panel. Read the user management section for more details about user edition. \u25b9 More details about Projects and Ramses . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Projects"},{"location":"components/client/projects/#project-management","text":"This panel is used to list and manage all projects of Ramses .","title":"Project management"},{"location":"components/client/projects/#list","text":"The list on the left lists all the projects, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each project can be displayed. The folder button on the top right corner for each project in the list opens the project folder in your file explorer. Use the button to create a new project. The button removes the selected projects from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new projects. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected projects. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/projects/#edition","text":"Name is the project\u2019s display name and can be changed any time. ID is the unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed after the project folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the project. Resolution is the width and height of the final video, in pixels. The first button allows you to quickly select from a list of common resolutions. Framerate is the framerate of the final video, in frames per second. Use the first button to quickly select it from a list of common framerates. Deadline is the date at which the project must be finished and delivered. You can change the folder where the project files are stored. Leave the field empty to set back the default folder inside the Ramses Tree . The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Use the Users list to assign and unassign users to the project. The button contains a list of available users, and an entry to quickly create a new user without having to switch to the users tab. The button unassigns the selected users from the project but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific user folder, and the edit button to edit them in a side docked panel. Read the user management section for more details about user edition. \u25b9 More details about Projects and Ramses . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/schedule/","text":"Schedule and planning You can use the schedule panel to plan the production, per user and per step. \u25b9 More details about production planning . Note A future version of the application will include a more general schedule, to let you quickly select time ranges for each step, defining a starting and ending date for each, without having to assign tasks to individual users. Overview The schedule table has two main areas: the toolbar on top contains a few useful menus and tools, and the main table is where you plan the production. It is useful to keep the statistics side panel at hand when planning the production. Toolbar On its left side, the toolbar displays a few menus and tools. Users Me : shows only the current user in the table. Select all : shows all the users assigned to this project in the table. Select none : hides all the users from the table. The User list can be used to select the users to show in the table. Days Select the days of the week to be shown in the table. This setting is kept across sessions, but it is a local setting, it is not shared with other workstations. Step Comment\u2026 adds a comment to the selected table cells (schedule entries). Assign (un)assigns a step to the selected celles (schedule entries). Go to date scrolls the table to a specific date. Today scrolls the table to the current date. Deadline scrolls the table to the deadline of the current project. \u25c0 Previous month scrolls the table to the previous month. Next month \u25b6 : I think you can guess what this button does. The right side of the toolbar shows the time remaining before reaching the deadline of the project and lets you define the time range of the table. Tip The Step menu, to assign steps and set comments, is also availabe as a context menu with the [right click] on the table cells. Main table Each column represents a day, lines represent users. There are two lines per user to allow you to assign tasks only to half of a day. The first line can be used to add any comment to the given day (column), for example to show deadlines, holidays, etc. Columns in the past are darker than columns in the future, the current day is shown in purple in the header; the project deadline is shown in red. To help you differenciate weeks, an alternate grey is used for to separate them. You can hide the days of the week which are not working days (a.k.a. Weekends) using the Days menu. Planning the project with the table is very quick and easy: Click on any cell to assign a step to the corresponding user and date. Use the context menu with [Right click] to assign steps to multiple users and multiple days at once. You can also add a comment to selected schedule entries; comments are shown when changing the size of the rows. There are a lot of different ways to select multiple cells in the table: [Left click + Drag] to quickly select contiguous cells. [Shift + Left click] to select the range between the active (last selected) cell and another cell. [Ctrl + Left click] to select individual cells. These three methods can be combined: for example, [Ctrl + Left click + Drag] to quickly select different groups of cells. To check how many days you have to assign (or how many extra days you have already assigned) according to the estimations, use the Statistics panel. Statistics The Statistics button on the title bar of the application opens a summary of the progress of all steps and the whole project. The top part shows the statistics for the whole project. Remaining time is the count of actual days before reaching the deadline of the project. Completion is the global completion of the project, both as a percentage, and a number of work-days completed (compared to the total estimated work-day count). Estimated Lateness is an estimation of the lateness for all steps; 0% means all is well, a negative lateness means there\u2019s some advance (no, this never happens), a positive value means the production is late. 100% means it took twice the time originally estimated to get to the current completion ratio! For each step, Ramses also compares the remaining work to the schedule, to warn you if you need to plan more days to complete the given step (or if there are extra days). If you pull the row to make it bigger, you can get more details. Assigned shows how many days are assigned in the schedule for the given step, including past and future dates. Extra / Missing shows how many more days are needed to be assigned to the given step, or how many extra days are assigned, compared to the estimation. To the contrary of the extra or missing days shown above, this value does not take into account how much actual work was already done.","title":"Schedule and planning"},{"location":"components/client/schedule/#schedule-and-planning","text":"You can use the schedule panel to plan the production, per user and per step. \u25b9 More details about production planning . Note A future version of the application will include a more general schedule, to let you quickly select time ranges for each step, defining a starting and ending date for each, without having to assign tasks to individual users.","title":"Schedule and planning"},{"location":"components/client/schedule/#overview","text":"The schedule table has two main areas: the toolbar on top contains a few useful menus and tools, and the main table is where you plan the production. It is useful to keep the statistics side panel at hand when planning the production.","title":"Overview"},{"location":"components/client/schedule/#toolbar","text":"On its left side, the toolbar displays a few menus and tools. Users Me : shows only the current user in the table. Select all : shows all the users assigned to this project in the table. Select none : hides all the users from the table. The User list can be used to select the users to show in the table. Days Select the days of the week to be shown in the table. This setting is kept across sessions, but it is a local setting, it is not shared with other workstations. Step Comment\u2026 adds a comment to the selected table cells (schedule entries). Assign (un)assigns a step to the selected celles (schedule entries). Go to date scrolls the table to a specific date. Today scrolls the table to the current date. Deadline scrolls the table to the deadline of the current project. \u25c0 Previous month scrolls the table to the previous month. Next month \u25b6 : I think you can guess what this button does. The right side of the toolbar shows the time remaining before reaching the deadline of the project and lets you define the time range of the table. Tip The Step menu, to assign steps and set comments, is also availabe as a context menu with the [right click] on the table cells.","title":"Toolbar"},{"location":"components/client/schedule/#main-table","text":"Each column represents a day, lines represent users. There are two lines per user to allow you to assign tasks only to half of a day. The first line can be used to add any comment to the given day (column), for example to show deadlines, holidays, etc. Columns in the past are darker than columns in the future, the current day is shown in purple in the header; the project deadline is shown in red. To help you differenciate weeks, an alternate grey is used for to separate them. You can hide the days of the week which are not working days (a.k.a. Weekends) using the Days menu. Planning the project with the table is very quick and easy: Click on any cell to assign a step to the corresponding user and date. Use the context menu with [Right click] to assign steps to multiple users and multiple days at once. You can also add a comment to selected schedule entries; comments are shown when changing the size of the rows. There are a lot of different ways to select multiple cells in the table: [Left click + Drag] to quickly select contiguous cells. [Shift + Left click] to select the range between the active (last selected) cell and another cell. [Ctrl + Left click] to select individual cells. These three methods can be combined: for example, [Ctrl + Left click + Drag] to quickly select different groups of cells. To check how many days you have to assign (or how many extra days you have already assigned) according to the estimations, use the Statistics panel.","title":"Main table"},{"location":"components/client/schedule/#statistics","text":"The Statistics button on the title bar of the application opens a summary of the progress of all steps and the whole project. The top part shows the statistics for the whole project. Remaining time is the count of actual days before reaching the deadline of the project. Completion is the global completion of the project, both as a percentage, and a number of work-days completed (compared to the total estimated work-day count). Estimated Lateness is an estimation of the lateness for all steps; 0% means all is well, a negative lateness means there\u2019s some advance (no, this never happens), a positive value means the production is late. 100% means it took twice the time originally estimated to get to the current completion ratio! For each step, Ramses also compares the remaining work to the schedule, to warn you if you need to plan more days to complete the given step (or if there are extra days). If you pull the row to make it bigger, you can get more details. Assigned shows how many days are assigned in the schedule for the given step, including past and future dates. Extra / Missing shows how many more days are needed to be assigned to the given step, or how many extra days are assigned, compared to the estimation. To the contrary of the extra or missing days shown above, this value does not take into account how much actual work was already done.","title":"Statistics"},{"location":"components/client/sequences/","text":"Sequence settings This panel is used to list and manage all the sequences of the project. Sequences are used to help you sort and filter the shots of the project . They\u2019re not used in the Ramses Tree . List The list on the left lists all the sequences of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each sequence can be displayed. Use the button to create a new sequence. The button removes the selected sequences from the project 1 . You can use the [Shift + A] shortcut key to quickly add new sequences. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected sequences. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Name is the sequence\u2019s display name. ID is the unique identifier. It is usually just a number, possibily with a simple prefix. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated with the sequence and describing it. Shots contained in the sequence are listed in the bottom section. The button instantly creates a new shot contained in the current sequence. The button removes the selected shots from the project 1 . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific shot folder, and the edit button to edit them in a side docked panel. Read the shot settings section for more details about shot edition. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9","title":"Sequences"},{"location":"components/client/sequences/#sequence-settings","text":"This panel is used to list and manage all the sequences of the project. Sequences are used to help you sort and filter the shots of the project . They\u2019re not used in the Ramses Tree .","title":"Sequence settings"},{"location":"components/client/sequences/#list","text":"The list on the left lists all the sequences of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each sequence can be displayed. Use the button to create a new sequence. The button removes the selected sequences from the project 1 . You can use the [Shift + A] shortcut key to quickly add new sequences. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected sequences. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/sequences/#edition","text":"Name is the sequence\u2019s display name. ID is the unique identifier. It is usually just a number, possibily with a simple prefix. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated with the sequence and describing it. Shots contained in the sequence are listed in the bottom section. The button instantly creates a new shot contained in the current sequence. The button removes the selected shots from the project 1 . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific shot folder, and the edit button to edit them in a side docked panel. Read the shot settings section for more details about shot edition. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9","title":"Edition"},{"location":"components/client/settings/","text":"Application settings and overview The home screen, shown when starting the application. When running the application for the first time, you need to go to the settings first to configure it. Overview General shortcuts and behaviour In all the application, a few shortcuts are always the same, in addition to your system\u2019s usual shortcuts for copy , paste , undo etc. [Middle Click] : scroll/pan in lists, tables, timeline\u2026 [Ctrl] + [Middle Click] or [Mouse Wheel] : zoom in or out in views which can be zoomed. [Shift] + [A] : add/create something. [Del] or [Shift] + [X] : remove/delete selection. All side panels (docks) can be moved around and docked to the sides or undocked by clicking on their titles. Menu bars can also be moved to all sides of the application. Title bar The title bar show the main buttons to switch the panels on the left, and the visibility buttons on the right. Click and drag an empty space of the title bar to move the whole window. In the middle of the title bar is the selector where you can select the project you\u2019re currently working on. Hide. The application will not close but sit in the system tray. Which panels and buttons are available depends on the role of the current user , and there may be fewer buttons than on the picture above. Administration panel ( Administrators only). Project settings panel ( Project administrators and Administrators only). Pipeline editor panel ( Project administrators and Administrators only). Assets table panel. Shots table panel. Schedule panel. Statistics panel. Status bar The status bar at the bottom of the window displays temporary feedback, useful messages and help on its left section. On the right section, there are a few secondary buttons. The reload button updates all data from the server. You should not need to click this button too often as the data is automatically and regularly pulled from the server. The console button shows the console panel (see the next section) where Ramses logs useful information for debugging or for developpers. Errors and warnings are also logged there. | A warning or an error button may be shown next, when there are some issues. Click on the button to show the latest logs and learn what\u2019s wrong; a clear button is available on the popup to remove the warning. The online / offline button can be used to switch between online and offline mode. Going online may need to input your password again. The user button (which shows your user name, or Guest if you\u2019re not logged in yet) gives access to a few user options (see below). The settings button leads you to the settings of the application. The help button shows a small menu with useful shortcuts. Console The console panel is where Ramses logs useful information for debugging or for developpers. Errors and warnings are also logged there, respectively in red and yellow. As many other Ramses panel, the console is a docked panel which can be undocked or docked both on the right and left side of Ramses by just clicking its title and moving it. User Profile Use the user menu at the bottom right of the window (the button with your ID) to access your profile settings. Except for the password, there\u2019s no need to validate any change; changes are saved instantly. Name is your display name and can be changed any time (although it\u2019s not really advisable). ID is your unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed once your user folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to your user. It is public. The Current role can never be changed by the user itself, and has to be changed by an administrator. To update your password, input your Current password and repeat your New password twice. Don\u2019t forget to click the Change password button to validate! You can change the folder where your personnal files are stored. Leave the field empty to set back the default folder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Lists There are a lot of lists in Ramses \u2026 In all lists, you can grab the bottom margin of any row to reveal more details. Clicking on a item opens the corresponding properties in a side panel. If you need to select several items, you can click and hold while dragging the mouse to select contiguous items, or you can hold [Ctrl] while clicking items to select individual items. The search bar uses both IDs and names to find items. In most of the lists, [Del] and [Shift] + [X] can be used to remove items. [Middle Click] can be used to scroll the list, as the [Mouse Wheel] does too. Comments In many places, you can add Comments in Ramses . These comments can be simple texts, but they can also be formatted using the Markdown syntax. Start by writing some text, and validate your input with [Enter] from the numpad. Ramses will interpret the text to display a nice rich text. You can get back to the source to edit the text in more details using the [F2] key. Use the [Right Click] context menu for other options. Settings To open the settings panel, click on the settings button at the bottom right corner of the window. Note These settings are local settings, and will not be shared with other workstations. Each workstation, (actually, each session on the system) has its own settings. The purple button will restore all default settings. Use the blue close button to close the settings. They are automatically saved. Appearance The first tab shows the appearance settings; you can change these as you wish. Ramses Data The second tab defines how Ramses will store the data on the filesystem, and has a few display option for the data. Ramses main folder defines the location of the main Ramses root folder, the one which will contain the Config , Projects and Users subfolders, as defined by the Ramses Tree . By default, this folder is located in your user folder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Note Project folders and user folders can be individually changed later to be outside of this main Ramses root folder, for example if you need to locate specific projects in other arbitrary specific folders. But Ramses still needs this main folder to be defined, at least to store some configuration files. Date format defines how dates will be displayed in the user interface. It does not change anything about how the data is actually stored in the database and files. Time format defines how times will be displayed in the user interface. It does not change anything about how the data is actually stored in the database and files. Server The third tab configures how the application will connect to the server. Server address must be the complete URL to the server. Secure connexion must be checked in case you want to encrypt the data sent to and recieved from the server. Your server must be compatible with SSL and have a valid certificate. Update every X minutes defines how often the application will automatically update all its data from the server. In order to keep the application very lightweight and the server very light and easy to install on all kind of computers, the local data is not updated in realtime (there\u2019s no pushing from the server), but the application will regularly pull changes from the server. This value does not need to be too low, as Ramses does not really need to be perfectly up-to-date every second. The default value is 2 minutes . Server timeout defines how long the application will wait for the server response when getting or posting data. If this timeout expires, the server will be considered not working correctly and the application will switch to offline mode. You may raise a bit this value if your server or your connexion are particularly slow. The default value is 3 seconds . Daemon The Daemon is a background service, a small local server, which is started with the application and is in charge of communications with the Ramses Add-ons . Listenning on port defines the local port used by the Daemon to receive connections and requests from the Ramses Add-ons and other services. You may change this value if it conflicts with other applications; in this case, you\u2019ll have to change it in the settings of all the Ramses Add-ons too. The default value is 18185 1 . Click the Restart Daemon button when changing the listenning port to apply the change. This value has been chosen after the birth date of Karl Marx , 5 May 1818. \u21a9","title":"Overview and settings"},{"location":"components/client/settings/#application-settings-and-overview","text":"The home screen, shown when starting the application. When running the application for the first time, you need to go to the settings first to configure it.","title":"Application settings and overview"},{"location":"components/client/settings/#overview","text":"","title":"Overview"},{"location":"components/client/settings/#general-shortcuts-and-behaviour","text":"In all the application, a few shortcuts are always the same, in addition to your system\u2019s usual shortcuts for copy , paste , undo etc. [Middle Click] : scroll/pan in lists, tables, timeline\u2026 [Ctrl] + [Middle Click] or [Mouse Wheel] : zoom in or out in views which can be zoomed. [Shift] + [A] : add/create something. [Del] or [Shift] + [X] : remove/delete selection. All side panels (docks) can be moved around and docked to the sides or undocked by clicking on their titles. Menu bars can also be moved to all sides of the application.","title":"General shortcuts and behaviour"},{"location":"components/client/settings/#title-bar","text":"The title bar show the main buttons to switch the panels on the left, and the visibility buttons on the right. Click and drag an empty space of the title bar to move the whole window. In the middle of the title bar is the selector where you can select the project you\u2019re currently working on. Hide. The application will not close but sit in the system tray. Which panels and buttons are available depends on the role of the current user , and there may be fewer buttons than on the picture above. Administration panel ( Administrators only). Project settings panel ( Project administrators and Administrators only). Pipeline editor panel ( Project administrators and Administrators only). Assets table panel. Shots table panel. Schedule panel. Statistics panel.","title":"Title bar"},{"location":"components/client/settings/#status-bar","text":"The status bar at the bottom of the window displays temporary feedback, useful messages and help on its left section. On the right section, there are a few secondary buttons. The reload button updates all data from the server. You should not need to click this button too often as the data is automatically and regularly pulled from the server. The console button shows the console panel (see the next section) where Ramses logs useful information for debugging or for developpers. Errors and warnings are also logged there. | A warning or an error button may be shown next, when there are some issues. Click on the button to show the latest logs and learn what\u2019s wrong; a clear button is available on the popup to remove the warning. The online / offline button can be used to switch between online and offline mode. Going online may need to input your password again. The user button (which shows your user name, or Guest if you\u2019re not logged in yet) gives access to a few user options (see below). The settings button leads you to the settings of the application. The help button shows a small menu with useful shortcuts.","title":"Status bar"},{"location":"components/client/settings/#console","text":"The console panel is where Ramses logs useful information for debugging or for developpers. Errors and warnings are also logged there, respectively in red and yellow. As many other Ramses panel, the console is a docked panel which can be undocked or docked both on the right and left side of Ramses by just clicking its title and moving it.","title":"Console"},{"location":"components/client/settings/#user-profile","text":"Use the user menu at the bottom right of the window (the button with your ID) to access your profile settings. Except for the password, there\u2019s no need to validate any change; changes are saved instantly. Name is your display name and can be changed any time (although it\u2019s not really advisable). ID is your unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed once your user folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to your user. It is public. The Current role can never be changed by the user itself, and has to be changed by an administrator. To update your password, input your Current password and repeat your New password twice. Don\u2019t forget to click the Change password button to validate! You can change the folder where your personnal files are stored. Leave the field empty to set back the default folder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer.","title":"User Profile"},{"location":"components/client/settings/#lists","text":"There are a lot of lists in Ramses \u2026 In all lists, you can grab the bottom margin of any row to reveal more details. Clicking on a item opens the corresponding properties in a side panel. If you need to select several items, you can click and hold while dragging the mouse to select contiguous items, or you can hold [Ctrl] while clicking items to select individual items. The search bar uses both IDs and names to find items. In most of the lists, [Del] and [Shift] + [X] can be used to remove items. [Middle Click] can be used to scroll the list, as the [Mouse Wheel] does too.","title":"Lists"},{"location":"components/client/settings/#comments","text":"In many places, you can add Comments in Ramses . These comments can be simple texts, but they can also be formatted using the Markdown syntax. Start by writing some text, and validate your input with [Enter] from the numpad. Ramses will interpret the text to display a nice rich text. You can get back to the source to edit the text in more details using the [F2] key. Use the [Right Click] context menu for other options.","title":"Comments"},{"location":"components/client/settings/#settings","text":"To open the settings panel, click on the settings button at the bottom right corner of the window. Note These settings are local settings, and will not be shared with other workstations. Each workstation, (actually, each session on the system) has its own settings. The purple button will restore all default settings. Use the blue close button to close the settings. They are automatically saved.","title":"Settings"},{"location":"components/client/settings/#appearance","text":"The first tab shows the appearance settings; you can change these as you wish.","title":"Appearance"},{"location":"components/client/settings/#ramses-data","text":"The second tab defines how Ramses will store the data on the filesystem, and has a few display option for the data. Ramses main folder defines the location of the main Ramses root folder, the one which will contain the Config , Projects and Users subfolders, as defined by the Ramses Tree . By default, this folder is located in your user folder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Note Project folders and user folders can be individually changed later to be outside of this main Ramses root folder, for example if you need to locate specific projects in other arbitrary specific folders. But Ramses still needs this main folder to be defined, at least to store some configuration files. Date format defines how dates will be displayed in the user interface. It does not change anything about how the data is actually stored in the database and files. Time format defines how times will be displayed in the user interface. It does not change anything about how the data is actually stored in the database and files.","title":"Ramses Data"},{"location":"components/client/settings/#server","text":"The third tab configures how the application will connect to the server. Server address must be the complete URL to the server. Secure connexion must be checked in case you want to encrypt the data sent to and recieved from the server. Your server must be compatible with SSL and have a valid certificate. Update every X minutes defines how often the application will automatically update all its data from the server. In order to keep the application very lightweight and the server very light and easy to install on all kind of computers, the local data is not updated in realtime (there\u2019s no pushing from the server), but the application will regularly pull changes from the server. This value does not need to be too low, as Ramses does not really need to be perfectly up-to-date every second. The default value is 2 minutes . Server timeout defines how long the application will wait for the server response when getting or posting data. If this timeout expires, the server will be considered not working correctly and the application will switch to offline mode. You may raise a bit this value if your server or your connexion are particularly slow. The default value is 3 seconds .","title":"Server"},{"location":"components/client/settings/#daemon","text":"The Daemon is a background service, a small local server, which is started with the application and is in charge of communications with the Ramses Add-ons . Listenning on port defines the local port used by the Daemon to receive connections and requests from the Ramses Add-ons and other services. You may change this value if it conflicts with other applications; in this case, you\u2019ll have to change it in the settings of all the Ramses Add-ons too. The default value is 18185 1 . Click the Restart Daemon button when changing the listenning port to apply the change. This value has been chosen after the birth date of Karl Marx , 5 May 1818. \u21a9","title":"Daemon"},{"location":"components/client/shots/","text":"Shot settings This panel is used to list and manage all the shots of the project . There is no production tracking from this panel, as it is used only to edit shot settings. List The list on the left lists all the shots of the project, and you can use the Search field to filter them by name or ID . The top selector filters the shots according to their containing sequence . When changing the size of the rows in the list, more details about each shot can be displayed. The folder button on the top right corner for each shot in the list opens the shot folder in your file explorer. Use the button to create a new shot in the current sequence. The button removes the selected shots from the project 1 . You can use the [Shift + A] shortcut key to quickly add new shots. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected shots. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . The creation button also allows you to create multiple shots at once and opens the following dialog: First, select the sequence where the shots will be added. If you need to add shots to several sequences, start again for each sequence. Choose the starting and end number. You can add leading zeroes, Ramses will keep them in the number, so that all shots have the same count of digits. Choose a name for the new shots. Include the % character at the location where you wish the number to be. For example, Shot % A will be translated as Shot 012 A . Choose an ID for the new shots. Again, you can use the % character to locate the shot number. If you omit it, the number is automatically appended to the ID. Edition Name is the shot\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the shot folder has been created . It usually is just a number. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the shot and describing it. The Duration of the shot can be set either in seconds or frames. Ramses uses the project framerate to update the other value. You can change the Sequence which contains this shot. The button opens the shot folder in your file explorer. This folder contains the individual working files, each in its step subfolder. For more details, read the Ramses Tree section. Use the Asset list to assign assets to the shots. The top selector filters the assets according to their containing group . The button contains the list of available assets for the current group. There\u2019s also an entry to quickly create a new asset without having to switch to the asset management panel . The button unassigns the selected assets from the shot, but they\u2019re not removed from the project. You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific asset folder, and the edit button to edit them in a side docked panel. Read the asset settings section for more details about asset edition. The list of assets as long as the duration can be used to automatically multiply the estimation of the shot. Read the planning section for more information about estimations, and the step management section to learn how to configure steps and automatic default estimations. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Shots"},{"location":"components/client/shots/#shot-settings","text":"This panel is used to list and manage all the shots of the project . There is no production tracking from this panel, as it is used only to edit shot settings.","title":"Shot settings"},{"location":"components/client/shots/#list","text":"The list on the left lists all the shots of the project, and you can use the Search field to filter them by name or ID . The top selector filters the shots according to their containing sequence . When changing the size of the rows in the list, more details about each shot can be displayed. The folder button on the top right corner for each shot in the list opens the shot folder in your file explorer. Use the button to create a new shot in the current sequence. The button removes the selected shots from the project 1 . You can use the [Shift + A] shortcut key to quickly add new shots. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected shots. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . The creation button also allows you to create multiple shots at once and opens the following dialog: First, select the sequence where the shots will be added. If you need to add shots to several sequences, start again for each sequence. Choose the starting and end number. You can add leading zeroes, Ramses will keep them in the number, so that all shots have the same count of digits. Choose a name for the new shots. Include the % character at the location where you wish the number to be. For example, Shot % A will be translated as Shot 012 A . Choose an ID for the new shots. Again, you can use the % character to locate the shot number. If you omit it, the number is automatically appended to the ID.","title":"List"},{"location":"components/client/shots/#edition","text":"Name is the shot\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the shot folder has been created . It usually is just a number. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the shot and describing it. The Duration of the shot can be set either in seconds or frames. Ramses uses the project framerate to update the other value. You can change the Sequence which contains this shot. The button opens the shot folder in your file explorer. This folder contains the individual working files, each in its step subfolder. For more details, read the Ramses Tree section. Use the Asset list to assign assets to the shots. The top selector filters the assets according to their containing group . The button contains the list of available assets for the current group. There\u2019s also an entry to quickly create a new asset without having to switch to the asset management panel . The button unassigns the selected assets from the shot, but they\u2019re not removed from the project. You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific asset folder, and the edit button to edit them in a side docked panel. Read the asset settings section for more details about asset edition. The list of assets as long as the duration can be used to automatically multiply the estimation of the shot. Read the planning section for more information about estimations, and the step management section to learn how to configure steps and automatic default estimations. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/states/","text":"State management This panel is used to list and manage all the states used by Ramses for production tracking. The states are shared by all projects . The list of available states can be completely customized. Read the section about Production tracking for more details about states and status. List The list on the left lists all the states, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each state can be displayed. Use the button to create a new state. The button removes the selected states from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new states. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected states. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . A few states can\u2019t be removed as they are needed by Ramses automations (but they can still be customized, only their ID can\u2019t change): NO, STB, TODO, WIP, OK . Edition Name is the state\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). It is also used in the user interface when there is too little room to use the name. Comment can be any text associated to the state. You can use it to describe the state and explain what it means. This comment has nothing to do with the actual production status of shots and assets, it is linked to the state itself and just describes it. The color is used to display the states in the user interface and easily differenciate them in lists. Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. The completion ratio is used to automatically set a default value to the completion of the tasks when their state changes. This task completion ratio can then be adjusted by the user for each individual task. \u25b9 More details about Production tracking and the states . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"States"},{"location":"components/client/states/#state-management","text":"This panel is used to list and manage all the states used by Ramses for production tracking. The states are shared by all projects . The list of available states can be completely customized. Read the section about Production tracking for more details about states and status.","title":"State management"},{"location":"components/client/states/#list","text":"The list on the left lists all the states, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each state can be displayed. Use the button to create a new state. The button removes the selected states from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new states. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected states. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . A few states can\u2019t be removed as they are needed by Ramses automations (but they can still be customized, only their ID can\u2019t change): NO, STB, TODO, WIP, OK .","title":"List"},{"location":"components/client/states/#edition","text":"Name is the state\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). It is also used in the user interface when there is too little room to use the name. Comment can be any text associated to the state. You can use it to describe the state and explain what it means. This comment has nothing to do with the actual production status of shots and assets, it is linked to the state itself and just describes it. The color is used to display the states in the user interface and easily differenciate them in lists. Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. The completion ratio is used to automatically set a default value to the completion of the tasks when their state changes. This task completion ratio can then be adjusted by the user for each individual task. \u25b9 More details about Production tracking and the states . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/steps/","text":"Step settings This panel is used to list and manage all the steps of the project which are used by the pipeline , production tracking and planning . Steps can also be directly created, edited and removed from the pipeline editor . List The list on the left lists all the steps of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each step can be displayed. The folder button on the top right corner for each user in the list opens the user folder in your file explorer. Use the button to create a new step (either completely new or using a template). The button removes the selected steps from the project 1 . You can use the [Shift + A] shortcut key to quickly add new steps. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected steps. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Steps can be re-order by dragging their ID in the column header of the list. Hint Ramses comes with a set of template steps, but they can be completely adjusted to any production needs; for example, if you consider Character Desgin to be a pre-production step instead of an asset production step, it\u2019s up to you to customize the templates. The list of template steps is available and can be managed in the administration panel by administrator users . Edition Name is the step\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the step has been created . Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the step and describing it. It can be formatted, using the Markdown syntax. Use the Type list to set the type of the step. Read this for more information about step types. The color is used to display the steps in the user interface and easily differenciate them in lists and the schedule . Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. There are a few tabs for other details: Applications can be assigned to each step; this information is used by the pipeline tools for automations and to open files. The button contains a list of available applications, and an entry to quickly create a new application without having to switch to the applications tab. The button unassigns the selected appplications from the project but does not remove them from Ramses . You can also use the [DEL] key. You can set the default estimation for the step. Read the section about Production Planning for more information. For Shot Production steps, you can select if the estimation has to be evaluated per shot (for a lighting step where the quantity of work does not depend on the duration of the shot for example) or on the duration, per second (better for the animation step for example). You can set a different default estimation for shots or assets depending on the difficulty . Estimation is made in days . For Shot Production steps, you can select an asset group to multiply the estimation by the number of corresponding assets in the shot. For example, you can multiply the estimation of the animation by the number of characters in the shot. Use the several Settings tabs to add some custom settings which can be used by Ramses add-ons to automate the pipeline. Using the official Ramses Add-ons , these settings should be formatted using the Yaml syntax. Read the Add-ons section for more information about the settings you can use. Finally, the button opens the step folder in your file explorer. This folder contains the step common files , especially the templates, but not the working files which are stored within their assets and shots. Tip To change the ID of the step, you\u2019ll need to create a new one with the new ID and remove the old one; it may be safe to do so at the beginning of a project, but existing data (if any) can\u2019t be transfered to the new step, be careful! \u25b9 More details about Steps and Ramses . \u25b9 More details about estimations and planning . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Steps"},{"location":"components/client/steps/#step-settings","text":"This panel is used to list and manage all the steps of the project which are used by the pipeline , production tracking and planning . Steps can also be directly created, edited and removed from the pipeline editor .","title":"Step settings"},{"location":"components/client/steps/#list","text":"The list on the left lists all the steps of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each step can be displayed. The folder button on the top right corner for each user in the list opens the user folder in your file explorer. Use the button to create a new step (either completely new or using a template). The button removes the selected steps from the project 1 . You can use the [Shift + A] shortcut key to quickly add new steps. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected steps. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Steps can be re-order by dragging their ID in the column header of the list. Hint Ramses comes with a set of template steps, but they can be completely adjusted to any production needs; for example, if you consider Character Desgin to be a pre-production step instead of an asset production step, it\u2019s up to you to customize the templates. The list of template steps is available and can be managed in the administration panel by administrator users .","title":"List"},{"location":"components/client/steps/#edition","text":"Name is the step\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the step has been created . Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the step and describing it. It can be formatted, using the Markdown syntax. Use the Type list to set the type of the step. Read this for more information about step types. The color is used to display the steps in the user interface and easily differenciate them in lists and the schedule . Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. There are a few tabs for other details: Applications can be assigned to each step; this information is used by the pipeline tools for automations and to open files. The button contains a list of available applications, and an entry to quickly create a new application without having to switch to the applications tab. The button unassigns the selected appplications from the project but does not remove them from Ramses . You can also use the [DEL] key. You can set the default estimation for the step. Read the section about Production Planning for more information. For Shot Production steps, you can select if the estimation has to be evaluated per shot (for a lighting step where the quantity of work does not depend on the duration of the shot for example) or on the duration, per second (better for the animation step for example). You can set a different default estimation for shots or assets depending on the difficulty . Estimation is made in days . For Shot Production steps, you can select an asset group to multiply the estimation by the number of corresponding assets in the shot. For example, you can multiply the estimation of the animation by the number of characters in the shot. Use the several Settings tabs to add some custom settings which can be used by Ramses add-ons to automate the pipeline. Using the official Ramses Add-ons , these settings should be formatted using the Yaml syntax. Read the Add-ons section for more information about the settings you can use. Finally, the button opens the step folder in your file explorer. This folder contains the step common files , especially the templates, but not the working files which are stored within their assets and shots. Tip To change the ID of the step, you\u2019ll need to create a new one with the new ID and remove the old one; it may be safe to do so at the beginning of a project, but existing data (if any) can\u2019t be transfered to the new step, be careful! \u25b9 More details about Steps and Ramses . \u25b9 More details about estimations and planning . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/templateassetgroups/","text":"Template Asset Group management This panel is used to list and manage all template asset groups of Ramses . Template assset groups can be used when configuring a project and its pipeline , to quickly create asset groups for the project. Read the section about Production tracking for more details about asset groups, and the section about the asset group management in the Ramses Client Application to learn how to create and manage asset groups inside projects. List The list on the left lists all the template asset groups, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each asset group can be displayed. Use the button to create a new template asset group. The button removes the selected template asset groups from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add template asset groups. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected template asset groups. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Hint All these settings can be safely changed at any time as this information is not actually used in Ramses but just read at the moment an asset group is created from a template. Name is the template asset group\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the template asset group. Note Asset groups are one of the only elements for which the name is used as a folder name as part of the Ramses Tree . \u25b9 More details about Assets and Ramses . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Template Asset Groups"},{"location":"components/client/templateassetgroups/#template-asset-group-management","text":"This panel is used to list and manage all template asset groups of Ramses . Template assset groups can be used when configuring a project and its pipeline , to quickly create asset groups for the project. Read the section about Production tracking for more details about asset groups, and the section about the asset group management in the Ramses Client Application to learn how to create and manage asset groups inside projects.","title":"Template Asset Group management"},{"location":"components/client/templateassetgroups/#list","text":"The list on the left lists all the template asset groups, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each asset group can be displayed. Use the button to create a new template asset group. The button removes the selected template asset groups from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add template asset groups. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected template asset groups. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/templateassetgroups/#edition","text":"Hint All these settings can be safely changed at any time as this information is not actually used in Ramses but just read at the moment an asset group is created from a template. Name is the template asset group\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the template asset group. Note Asset groups are one of the only elements for which the name is used as a folder name as part of the Ramses Tree . \u25b9 More details about Assets and Ramses . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/templatesteps/","text":"Template Step management This panel is used to list and manage all template steps of Ramses . Template steps can be used when configuring a project and its pipeline , to quickly create steps for the project. Read the section about Pipelines for more details about steps, and the section about the step management in the Ramses Client Application to learn how to create and manage steps inside projects. List The list on the left lists all the template steps, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each template step can be displayed. Use the button to create a new template step. The button removes the selected template steps from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add template steps. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected template steps. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Hint All these settings can be safely changed at any time as this information is not actually used in Ramses but just read at the moment a step is created from a template. Name is the template step\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the template step. Use the Type list to set the type of the step. Read this for more information about step types. The color is used to display the steps in the user interface and easily differenciate them in lists and the schedule . Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. You can set the default estimation for the step. Read the section about Production Planning for more information. For Shot Production steps, you can select if the estimation has to be evaluated per shot or on the duration, per second . You can set a different default estimation for shots or assets depending on the difficulty . Estimation is made in days . \u25b9 More details about Steps and Ramses . \u25b9 More details about estimations and planning . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Template Steps"},{"location":"components/client/templatesteps/#template-step-management","text":"This panel is used to list and manage all template steps of Ramses . Template steps can be used when configuring a project and its pipeline , to quickly create steps for the project. Read the section about Pipelines for more details about steps, and the section about the step management in the Ramses Client Application to learn how to create and manage steps inside projects.","title":"Template Step management"},{"location":"components/client/templatesteps/#list","text":"The list on the left lists all the template steps, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each template step can be displayed. Use the button to create a new template step. The button removes the selected template steps from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add template steps. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected template steps. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/templatesteps/#edition","text":"Hint All these settings can be safely changed at any time as this information is not actually used in Ramses but just read at the moment a step is created from a template. Name is the template step\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the template step. Use the Type list to set the type of the step. Read this for more information about step types. The color is used to display the steps in the user interface and easily differenciate them in lists and the schedule . Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. You can set the default estimation for the step. Read the section about Production Planning for more information. For Shot Production steps, you can select if the estimation has to be evaluated per shot or on the duration, per second . You can set a different default estimation for shots or assets depending on the difficulty . Estimation is made in days . \u25b9 More details about Steps and Ramses . \u25b9 More details about estimations and planning . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/users/","text":"User management This panel is used to list and manage all users of Ramses . List The list on the left lists all the users, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each user can be displayed. The folder button on the top right corner for each user in the list opens the user folder in your file explorer. Use the button to create a new user. The button removes the selected users from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new users. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected users. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Note The Ramses Daemon can\u2019t be removed: it is a default user needed by Ramses automations, but you can rename it if you wish. Warning The default Administrator user should be renamed and its password changed as soon as Ramses has been installed! Note With the default installation of Ramses , there\u2019s also an additionnal user: Nicolas \u201cDuduf\u201d Dufresne , who\u2019s the main developper of Ramses . This user is just a quick reminder that Ramses is free and that Duduf and RxLab really need your support . You can safely keep or remove it. Just. Donate. First. Please! Ramses relies only on your donations to exist. Edition Except for the password, there\u2019s no need to validate any change; changes are saved instantly. Name is the user\u2019s display name and can be changed any time (although it\u2019s not really advisable). ID is the unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed after the user folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the user. It is public. The Current role can never be changed by the user itself, and has to be changed by an administrator ( read this for more information about roles). To update your own password, input your Current password and repeat your New password twice. Don\u2019t forget to click the Change password button to validate! You can change any other user password, just set the New password twice and ignore the Current password field. Don\u2019t forget to click the Change password button to validate! You can change the folder where the user files are stored. Leave the field empty to set back the default folder inside the Ramses Tree . The red button moves the user\u2019s folder to a _trash subfolder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Passwords are stored encrypted in the Ramses Server and there\u2019s no way to retrieve them in case a user forgets it. In this case, an administrator has to set a new password for the user. \u25b9 More details about Users and Ramses . Note You cannot change your own role. Tip To change a user ID , you need to remove its folder. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Users"},{"location":"components/client/users/#user-management","text":"This panel is used to list and manage all users of Ramses .","title":"User management"},{"location":"components/client/users/#list","text":"The list on the left lists all the users, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each user can be displayed. The folder button on the top right corner for each user in the list opens the user folder in your file explorer. Use the button to create a new user. The button removes the selected users from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new users. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected users. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Note The Ramses Daemon can\u2019t be removed: it is a default user needed by Ramses automations, but you can rename it if you wish. Warning The default Administrator user should be renamed and its password changed as soon as Ramses has been installed! Note With the default installation of Ramses , there\u2019s also an additionnal user: Nicolas \u201cDuduf\u201d Dufresne , who\u2019s the main developper of Ramses . This user is just a quick reminder that Ramses is free and that Duduf and RxLab really need your support . You can safely keep or remove it. Just. Donate. First. Please! Ramses relies only on your donations to exist.","title":"List"},{"location":"components/client/users/#edition","text":"Except for the password, there\u2019s no need to validate any change; changes are saved instantly. Name is the user\u2019s display name and can be changed any time (although it\u2019s not really advisable). ID is the unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed after the user folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the user. It is public. The Current role can never be changed by the user itself, and has to be changed by an administrator ( read this for more information about roles). To update your own password, input your Current password and repeat your New password twice. Don\u2019t forget to click the Change password button to validate! You can change any other user password, just set the New password twice and ignore the Current password field. Don\u2019t forget to click the Change password button to validate! You can change the folder where the user files are stored. Leave the field empty to set back the default folder inside the Ramses Tree . The red button moves the user\u2019s folder to a _trash subfolder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Passwords are stored encrypted in the Ramses Server and there\u2019s no way to retrieve them in case a user forgets it. In this case, an administrator has to set a new password for the user. \u25b9 More details about Users and Ramses . Note You cannot change your own role. Tip To change a user ID , you need to remove its folder. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/files/","text":"The Ramses Tree Ramses is able to manage all the files associated with projects. To handle these, it uses a specific naming scheme which has been carefully crafted to be powerful (it contains all information Ramses needs to efficiently handle the files and folders), and easy to respect (it is simple to manually rename files and folders). Although one of the goal of Ramses is to enable you to work without ever having to use your system\u2019s file explorer but only Ramses tools, it is strongly advised to read this documentation about the naming conventions and folder structure to make sure all your files can be handled by Ramses . Every file and folder you create manually can be detected and managed by Ramses if it\u2019s correcly named and located. Read the Ramses naming conventions . Check out the Ramses Tree , the folder structure.","title":"Introduction"},{"location":"components/files/#the-ramses-tree","text":"Ramses is able to manage all the files associated with projects. To handle these, it uses a specific naming scheme which has been carefully crafted to be powerful (it contains all information Ramses needs to efficiently handle the files and folders), and easy to respect (it is simple to manually rename files and folders). Although one of the goal of Ramses is to enable you to work without ever having to use your system\u2019s file explorer but only Ramses tools, it is strongly advised to read this documentation about the naming conventions and folder structure to make sure all your files can be handled by Ramses . Every file and folder you create manually can be detected and managed by Ramses if it\u2019s correcly named and located. Read the Ramses naming conventions . Check out the Ramses Tree , the folder structure.","title":"The Ramses Tree"},{"location":"components/files/naming/","text":"File and folder naming scheme Ramses uses a strict and specific naming convention. This naming scheme is based on the ID s of the elements, which are defined by the administrator users in the Ramses Client . Extensibility We provide a set of regular expressions to help developpers manipulate this naming scheme. IDs (short names) In Ramses , all elements (users, assets, shots, projects\u2026) have two names: the actual name used in the user interface and displayed anywhere there is enough room, and an ID which is no longer than 10 characters (but which may be the same as the actual name). IDs are unique (while names may not be unique, although it\u2019s good practice to keep them unique too) and they are used as identifiers. While names can contain a lot of different characters, IDs can consist only of alphanumeric characters (without any special character or accent), and the minus - character. What How Where Name up to 256 characters in: [a-z] , [A-Z] , [0-9] , - , and space. Used in user interfaces where there is enough room. ID up to 10 characters in: [a-z] , [A-Z] , [0-9] , - . Used in file and folder names, and in user interfaces where there is limited room. Extensibility In the API , the IDs are called \u201cshort names\u201d. Naming scheme This is the complete naming scheme, for all files and folders: projectID_A|S|G(_assetID|shotID)_stepID(_resource name)(_stateVersion)(.extension) Explanations: The name is divided into blocks, separated by the underscore _ character. Optionnal blocks are shown in parenthesis () The vertical bar | characters means \u201cor\u201d and represents a choice in a list of possibilities. A file name must include at least 3 blocks : projectID , Type ( A , S or G ), and stepID and can include up to 6 blocks if adding the assetId or shotID , the resource name, and the version. Blocks projectID is the ID of the project. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. A|S|G tells if the file or folder refers to an Asset ( A ), a shot ( S ) or a general item ( G ). assetID is the ID of the asset, if the previous block is A . Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. shotID is the ID of the shot, if the previous block is S . Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. stepID is the ID of the production step. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. resource name describes the specific resource this file or folder refers to. Between 1 and 30 characters consisting only of a-z , 0-9 and - characters and may contain spaces. Resource names cannot start with a status ID followed by a number (e.g. v01 or wip2 ) nor a number alone. stateVersion contains the state and version number. The state is either the default v or the ID of the state (e.g. \u201cwip\u201d, \u201cok\u201d, etc.), and the version includes one or more numbers. No other character allowed. extension is the file extension. The extension may include multiple dots, for example: .tar.gz Examples TI_G_ADMIN_Budget estimation.xls TI_G_RIG_Template.blend TI_A_TRISTAN_RIG.blend TI_A_TRISTAN_RIG_WIP001.blend TI_A_TRISTAN_ANIM_walk cycle.blend TI_A_TRISTAN_ANIM_walk cycle_CHK011.blend Project media files Media files exported from the project have a specific naming scheme. projectID_codec(+colorspace)_widthxheight(p|i)_fps(_language)_(subtitlesst).ext Blocks projectID is the ID of the project. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. codec is the name of the codec. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. No dot allowed (e.g. h.264 must be named h264 ). colorspace represents the colorspace used if it\u2019s not the most common one for this codec. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. No dot allowed. Examples: YUV420 , sRGB , YUV444 , sRGBA , YUV420-REC709 \u2026 widthxheight is the resolution of the file. p|i tells if the video is interlaced or progressive. If omitted, the video is considered progressive. fps is the framerate. A number, which may contain a dot . character, and optionnaly the fps suffix. language is the spoken language. Omitted if there are no dialogs nor any written text. subtitlesst is the language code for the subtitles followed by the st suffix. Omitted if there are no subtitles. ext is the file extension. The extension may include multiple dots, for example: .tar.gz Examples TI_h264_1920x1080_24fps.mp4 TI_h264+YUV444-rec709_1920x1080p_24fps_fr_enst.mp4 TI_QtAnim+sRGB_1920x1080p_24fps_fr_enst.mp4","title":"Naming scheme"},{"location":"components/files/naming/#file-and-folder-naming-scheme","text":"Ramses uses a strict and specific naming convention. This naming scheme is based on the ID s of the elements, which are defined by the administrator users in the Ramses Client . Extensibility We provide a set of regular expressions to help developpers manipulate this naming scheme.","title":"File and folder naming scheme"},{"location":"components/files/naming/#ids-short-names","text":"In Ramses , all elements (users, assets, shots, projects\u2026) have two names: the actual name used in the user interface and displayed anywhere there is enough room, and an ID which is no longer than 10 characters (but which may be the same as the actual name). IDs are unique (while names may not be unique, although it\u2019s good practice to keep them unique too) and they are used as identifiers. While names can contain a lot of different characters, IDs can consist only of alphanumeric characters (without any special character or accent), and the minus - character. What How Where Name up to 256 characters in: [a-z] , [A-Z] , [0-9] , - , and space. Used in user interfaces where there is enough room. ID up to 10 characters in: [a-z] , [A-Z] , [0-9] , - . Used in file and folder names, and in user interfaces where there is limited room. Extensibility In the API , the IDs are called \u201cshort names\u201d.","title":"IDs (short names)"},{"location":"components/files/naming/#naming-scheme","text":"This is the complete naming scheme, for all files and folders: projectID_A|S|G(_assetID|shotID)_stepID(_resource name)(_stateVersion)(.extension) Explanations: The name is divided into blocks, separated by the underscore _ character. Optionnal blocks are shown in parenthesis () The vertical bar | characters means \u201cor\u201d and represents a choice in a list of possibilities. A file name must include at least 3 blocks : projectID , Type ( A , S or G ), and stepID and can include up to 6 blocks if adding the assetId or shotID , the resource name, and the version.","title":"Naming scheme"},{"location":"components/files/naming/#blocks","text":"projectID is the ID of the project. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. A|S|G tells if the file or folder refers to an Asset ( A ), a shot ( S ) or a general item ( G ). assetID is the ID of the asset, if the previous block is A . Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. shotID is the ID of the shot, if the previous block is S . Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. stepID is the ID of the production step. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. resource name describes the specific resource this file or folder refers to. Between 1 and 30 characters consisting only of a-z , 0-9 and - characters and may contain spaces. Resource names cannot start with a status ID followed by a number (e.g. v01 or wip2 ) nor a number alone. stateVersion contains the state and version number. The state is either the default v or the ID of the state (e.g. \u201cwip\u201d, \u201cok\u201d, etc.), and the version includes one or more numbers. No other character allowed. extension is the file extension. The extension may include multiple dots, for example: .tar.gz","title":"Blocks"},{"location":"components/files/naming/#examples","text":"TI_G_ADMIN_Budget estimation.xls TI_G_RIG_Template.blend TI_A_TRISTAN_RIG.blend TI_A_TRISTAN_RIG_WIP001.blend TI_A_TRISTAN_ANIM_walk cycle.blend TI_A_TRISTAN_ANIM_walk cycle_CHK011.blend","title":"Examples"},{"location":"components/files/naming/#project-media-files","text":"Media files exported from the project have a specific naming scheme. projectID_codec(+colorspace)_widthxheight(p|i)_fps(_language)_(subtitlesst).ext","title":"Project media files"},{"location":"components/files/naming/#blocks_1","text":"projectID is the ID of the project. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. codec is the name of the codec. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. No dot allowed (e.g. h.264 must be named h264 ). colorspace represents the colorspace used if it\u2019s not the most common one for this codec. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. No dot allowed. Examples: YUV420 , sRGB , YUV444 , sRGBA , YUV420-REC709 \u2026 widthxheight is the resolution of the file. p|i tells if the video is interlaced or progressive. If omitted, the video is considered progressive. fps is the framerate. A number, which may contain a dot . character, and optionnaly the fps suffix. language is the spoken language. Omitted if there are no dialogs nor any written text. subtitlesst is the language code for the subtitles followed by the st suffix. Omitted if there are no subtitles. ext is the file extension. The extension may include multiple dots, for example: .tar.gz","title":"Blocks"},{"location":"components/files/naming/#examples_1","text":"TI_h264_1920x1080_24fps.mp4 TI_h264+YUV444-rec709_1920x1080p_24fps_fr_enst.mp4 TI_QtAnim+sRGB_1920x1080p_24fps_fr_enst.mp4","title":"Examples"},{"location":"components/files/tree/","text":"Folder Structure: the Ramses Tree One of Ramses\u2019 goals is to manage all your files and folders; sometimes, you may still need to manually add, remove, or edit files and folders through your file explorer, in which case you should always try to respect the Ramses Tree described here. This document will also help you find your files should Ramses be unavailable for some reason. Introduction All folders inside the Ramses Tree follow the Ramses Naming Scheme . The folders used by Ramses can be located either locally or on remote computers and servers . The supported protocols ( SMB , FTP \u2026) may vary depending on the platform (read below for more information). Ramses includes a system of alternative trees , which means you can use different paths to folders used by Ramses, and that it is compatible with virtually all syncing applications (Dropbox, Syncthing, Synology\u2026), wether they are automatic or manual (like backup tools). If a specific file or folder is not found in the main tree , Ramses will automatically look for it in the alternative trees and try to sync (i.e. copy in the main tree ) them. Tip For best performance, it is advised to work with local files, and use remote locations only as alternative trees ; in conjunction with a syncing tool like Syncthing or the Synology Drive application for example, it is both easy, safe and powerful to keep a shared copy of the projects while working locally. Remote files on Windows Ramses should be able to access files located on remote locations using the Samba ( SMB ) protocol, using standard URL starting with \\\\server-name . Another way to access remote locations, which enables FTP and other protocols support, is to use Windows Network Drives to mount the remote locations. To make it easy to deploy Ramses on several devices, they should all use the same drive letter. Remote files on Unix-like Systems (Linux, Mac OS) The quickest and easiest way to use Ramses on remote folders on Unix-like systems is to automatically mount the remote locations in a specific folder. This can work for a lot of different protocols ( Samba , FTP(s) , SFTP , NFS \u2026) The Main Ramses Folder The easiest way to use Ramses to manage all your projects is to define a root folder for all Ramses projects, where Ramses will create a subfolder for each project. This Ramses folder is also used to store user specific files, some configuration files, etc. Nevertheless, you can always choose another folder to store a specific project, outside of the Ramses Folder. \u250c Ramses Folder \u2502 \u251c\u2500\u2500\u2500 Config # Configuration files \u2502 \u251c\u2500\u252c\u2500 Projects # All projects \u2502 \u251c\u2500\u2500\u2500 Project01 # First project \u2502 \u251c\u2500\u2500\u2500 Project02 # Second project \u2502 \u2514\u2500\u2500\u2500 ... \u2502 \u2514\u2500\u252c\u2500 Users # User files \u251c\u2500\u252c\u2500 User01 # Files for a single user \u2502 \u2514\u2500\u2500\u2500 Config # Configuration files for this user \u251c\u2500\u252c\u2500 User02 \u2502 \u2514\u2500\u2500\u2500 Config \u2514\u2500\u2500\u2500 ... Hint When using the Ramses Client , project folders can be located anywhere outside the Ramses Folder , it is not mandatory to keep them grouped together there. The Project Folder These are the contents of a Project folder: \u250c PROJECTID # Root \u251c\u2500\u2500\u2500 00-ADMIN # Project administration \u251c\u2500\u2500\u2500 01-PRE-PROD # Pre-production steps common files \u251c\u2500\u2500\u2500 02-PROD # Production steps common files \u251c\u2500\u2500\u2500 03-POST-PROD # Post-production steps common files \u251c\u2500\u2500\u2500 04-ASSETS # All the Assets \u251c\u2500\u2500\u2500 05-SHOTS # All the Shots \u2514\u2500\u2500\u2500 06-EXPORT # Media files The root folder of a project only contains other folders and no files. The subfolders in the root folder are numbered to help sorting them and quickly find them. Here is an example of a typical project tree, without showing the details in the working directories nor any file. \u250c PROJECTID # Root \u2502 \u251c\u2500\u2500\u2500 00-ADMIN \u2502 \u251c\u2500\u252c\u2500 01-PRE-PROD \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_SCRIPT # Pre production step \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_STORYBOARD \u2502 \u251c\u2500\u252c\u2500 02-PROD \u2502 \u251c\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the mod step \u2502 \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the mod step \u2502 \u2514\u2500\u252c\u2500 PROJECTID_G_RIG # Common files for the rig step \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the rig step \u2502 \u251c\u2500\u252c\u2500 03-POST-PROD \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_EDIT # Post production step \u2502 \u251c\u2500\u252c\u2500 04-ASSETS \u2502 \u251c\u2500\u252c\u2500 Characters # A Group of Assets \u2502 \u2502 \u251c\u2500\u252c\u2500 PROJECTID_A_TRISTAN # An Asset \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_DESIGN # An asset production step \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_RIG \u2502 \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_TEX \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_ISOLDE # An Asset \u2502 \u251c\u2500\u2500\u2500 Props # A Group of Assets \u2502 \u2514\u2500\u2500\u2500 Sets # A Group of Assets \u2502 \u251c\u2500\u252c\u2500 05-SHOTS \u2502 \u251c\u2500\u252c\u2500 PROJECTID_S_01-001 # A Shot \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_ANIM # A shot production step \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_LIGHT \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_01-001_COMP \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-002 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-003 # A Shot \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_02-001 # A Shot \u2502 \u2514\u2500\u2500\u2500 06-EXPORT A working folder A folder containing working files is always organised the same way. Here is an example for the modelling step of the asset called Tristan . \u250c PROJECTID_A_TRISTAN_MOD # The working folder, subfolder of the asset folder. \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The main file for modelling Tristan (on Blender) \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.blend # Another resource \u2502 \u251c\u2500\u252c\u2500 _versions # The versionning folder, handled by Ramses. \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_wip001.blend # A WIP version \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_wip002.blend \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_chk003.blend # The version which has to be reviewed \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_ok004.blend # The validated version \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_pub005.blend # The version which has been published \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt_v001.blend # The first version of a resource \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt_v002.blend # The second version of a resource \u2502 \u251c\u2500\u252c\u2500 _published \u2502 \u251c\u2500\u252c\u2500 001_WIP # The first published version \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The working file as it was when publishing \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.abc # The published export (an *Alembic* file) \u2502 \u2502 \u2502 \u251c\u2500\u252c\u2500 004_OK # The 4th version, which was published as ok \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The working file as it was when publishing \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.abc # The published export (an *Alembic* file) \u2502 \u2502 \u2502 \u2514\u2500\u252c\u2500 Sculpt_002_OK # The 2nd version of the \"Sculpt\" resource, which was published as ok \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.blend # The working file as it was when publishing \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.abc # The published export (an *Alembic* file) | \u2514\u2500\u252c\u2500 _preview \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.jpg # A file for previewing the modelling \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.mp4 # A file for previewing the modelling The _versions subfolder contains the versionning and history of the work. The _published subfolder contains the published and exported files to be used by other steps. The _preview subfolder contains the files for previewing the current work, like videos or images. These files may be used by Ramses to generate thumbnails. Ramses is also able to list, preview, and play these files (if their format is standard and supported). Warning The working file and published files do not include the version in their names, and the versionning and history are hidden in a _versions subfolder. This way, there can be no mistake about what file to open or import. Note Only Ramses should access the _versions subfolder and it should not be needed for the user to manipulate these files. Both the Ramses Client and Ramses Add-ons have a restore feature to retrieve previous versions. Tip When backuping a project, only the files in the published subfolder may be kept. Template folders Ramses can use template files to create new working files. You can use this feature with any application, even if there\u2019s no Ramses Add-on available for it (yet). The template files must be located in each step\u2019s Templates subfolder. As you can have multiple templates for a single step, each template must be located in its own subfolder, which itself must respect the working folder structure. Here is an example of a step folder and its templates: \u250c PROJECTID # Root \u2514\u2500\u252c\u2500 02-PROD \u2514\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the MOD step \u2514\u2500\u252c\u2500 Templates # Template files for the mod step \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template # A template \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Other # Another template A template folder should be organized the same way as any working folder . Typically, a template folder will look like this: \u250c PROJECTID_G_MOD_Template # The working folder for the template named \"Template\" \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The main template file \u2502 \u251c\u2500\u252c\u2500 _versions # The versionning folder \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template_wip001.blend \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template_wip002.blend \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template_ok003.blend \u2502 \u2514\u2500\u252c\u2500 _published \u251c\u2500\u252c\u2500 001_WIP # The first published version \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The working file as it was when publishing \u2502 \u2514\u2500\u252c\u2500 003_OK # The 3rd version, which was published as ok \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The working file as it was when publishing Note A template working folder may contain different resources, but even if they\u2019re published, Ramses will use only the main resource to create new files from templates and ignore other resources. Ramses special files and folders Ramses will also store some special files and folders it needs in the Ramses Tree . _trash Folder When Ramses needs to remove a file, it will automatically be moved in a _trash subfolder. If a file with the same name already exists in this _trash subfolder, it will be moved in the system trash so it\u2019s not overwritten. _ramses_data.json File Ramses may create a file named _ramses_data.json in any folder. This file is used to store some meta-data associated with the other files in the same folder. This file should stay small, and it should never be manually removed. *.ini Files Ramses stores its settings in files with the .ini extension. These are standard text files, and should remain only in folders named Config . If these files (or the Config folders) are removed, this re-initializes the corresponding settings in Ramses .","title":"Folder structure"},{"location":"components/files/tree/#folder-structure-the-ramses-tree","text":"One of Ramses\u2019 goals is to manage all your files and folders; sometimes, you may still need to manually add, remove, or edit files and folders through your file explorer, in which case you should always try to respect the Ramses Tree described here. This document will also help you find your files should Ramses be unavailable for some reason.","title":"Folder Structure: the Ramses Tree"},{"location":"components/files/tree/#introduction","text":"All folders inside the Ramses Tree follow the Ramses Naming Scheme . The folders used by Ramses can be located either locally or on remote computers and servers . The supported protocols ( SMB , FTP \u2026) may vary depending on the platform (read below for more information). Ramses includes a system of alternative trees , which means you can use different paths to folders used by Ramses, and that it is compatible with virtually all syncing applications (Dropbox, Syncthing, Synology\u2026), wether they are automatic or manual (like backup tools). If a specific file or folder is not found in the main tree , Ramses will automatically look for it in the alternative trees and try to sync (i.e. copy in the main tree ) them. Tip For best performance, it is advised to work with local files, and use remote locations only as alternative trees ; in conjunction with a syncing tool like Syncthing or the Synology Drive application for example, it is both easy, safe and powerful to keep a shared copy of the projects while working locally.","title":"Introduction"},{"location":"components/files/tree/#remote-files-on-windows","text":"Ramses should be able to access files located on remote locations using the Samba ( SMB ) protocol, using standard URL starting with \\\\server-name . Another way to access remote locations, which enables FTP and other protocols support, is to use Windows Network Drives to mount the remote locations. To make it easy to deploy Ramses on several devices, they should all use the same drive letter.","title":"Remote files on Windows"},{"location":"components/files/tree/#remote-files-on-unix-like-systems-linux-mac-os","text":"The quickest and easiest way to use Ramses on remote folders on Unix-like systems is to automatically mount the remote locations in a specific folder. This can work for a lot of different protocols ( Samba , FTP(s) , SFTP , NFS \u2026)","title":"Remote files on Unix-like Systems (Linux, Mac OS)"},{"location":"components/files/tree/#the-main-ramses-folder","text":"The easiest way to use Ramses to manage all your projects is to define a root folder for all Ramses projects, where Ramses will create a subfolder for each project. This Ramses folder is also used to store user specific files, some configuration files, etc. Nevertheless, you can always choose another folder to store a specific project, outside of the Ramses Folder. \u250c Ramses Folder \u2502 \u251c\u2500\u2500\u2500 Config # Configuration files \u2502 \u251c\u2500\u252c\u2500 Projects # All projects \u2502 \u251c\u2500\u2500\u2500 Project01 # First project \u2502 \u251c\u2500\u2500\u2500 Project02 # Second project \u2502 \u2514\u2500\u2500\u2500 ... \u2502 \u2514\u2500\u252c\u2500 Users # User files \u251c\u2500\u252c\u2500 User01 # Files for a single user \u2502 \u2514\u2500\u2500\u2500 Config # Configuration files for this user \u251c\u2500\u252c\u2500 User02 \u2502 \u2514\u2500\u2500\u2500 Config \u2514\u2500\u2500\u2500 ... Hint When using the Ramses Client , project folders can be located anywhere outside the Ramses Folder , it is not mandatory to keep them grouped together there.","title":"The Main Ramses Folder"},{"location":"components/files/tree/#the-project-folder","text":"These are the contents of a Project folder: \u250c PROJECTID # Root \u251c\u2500\u2500\u2500 00-ADMIN # Project administration \u251c\u2500\u2500\u2500 01-PRE-PROD # Pre-production steps common files \u251c\u2500\u2500\u2500 02-PROD # Production steps common files \u251c\u2500\u2500\u2500 03-POST-PROD # Post-production steps common files \u251c\u2500\u2500\u2500 04-ASSETS # All the Assets \u251c\u2500\u2500\u2500 05-SHOTS # All the Shots \u2514\u2500\u2500\u2500 06-EXPORT # Media files The root folder of a project only contains other folders and no files. The subfolders in the root folder are numbered to help sorting them and quickly find them. Here is an example of a typical project tree, without showing the details in the working directories nor any file. \u250c PROJECTID # Root \u2502 \u251c\u2500\u2500\u2500 00-ADMIN \u2502 \u251c\u2500\u252c\u2500 01-PRE-PROD \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_SCRIPT # Pre production step \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_STORYBOARD \u2502 \u251c\u2500\u252c\u2500 02-PROD \u2502 \u251c\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the mod step \u2502 \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the mod step \u2502 \u2514\u2500\u252c\u2500 PROJECTID_G_RIG # Common files for the rig step \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the rig step \u2502 \u251c\u2500\u252c\u2500 03-POST-PROD \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_EDIT # Post production step \u2502 \u251c\u2500\u252c\u2500 04-ASSETS \u2502 \u251c\u2500\u252c\u2500 Characters # A Group of Assets \u2502 \u2502 \u251c\u2500\u252c\u2500 PROJECTID_A_TRISTAN # An Asset \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_DESIGN # An asset production step \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_RIG \u2502 \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_TEX \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_ISOLDE # An Asset \u2502 \u251c\u2500\u2500\u2500 Props # A Group of Assets \u2502 \u2514\u2500\u2500\u2500 Sets # A Group of Assets \u2502 \u251c\u2500\u252c\u2500 05-SHOTS \u2502 \u251c\u2500\u252c\u2500 PROJECTID_S_01-001 # A Shot \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_ANIM # A shot production step \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_LIGHT \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_01-001_COMP \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-002 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-003 # A Shot \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_02-001 # A Shot \u2502 \u2514\u2500\u2500\u2500 06-EXPORT","title":"The Project Folder"},{"location":"components/files/tree/#a-working-folder","text":"A folder containing working files is always organised the same way. Here is an example for the modelling step of the asset called Tristan . \u250c PROJECTID_A_TRISTAN_MOD # The working folder, subfolder of the asset folder. \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The main file for modelling Tristan (on Blender) \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.blend # Another resource \u2502 \u251c\u2500\u252c\u2500 _versions # The versionning folder, handled by Ramses. \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_wip001.blend # A WIP version \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_wip002.blend \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_chk003.blend # The version which has to be reviewed \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_ok004.blend # The validated version \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_pub005.blend # The version which has been published \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt_v001.blend # The first version of a resource \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt_v002.blend # The second version of a resource \u2502 \u251c\u2500\u252c\u2500 _published \u2502 \u251c\u2500\u252c\u2500 001_WIP # The first published version \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The working file as it was when publishing \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.abc # The published export (an *Alembic* file) \u2502 \u2502 \u2502 \u251c\u2500\u252c\u2500 004_OK # The 4th version, which was published as ok \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The working file as it was when publishing \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.abc # The published export (an *Alembic* file) \u2502 \u2502 \u2502 \u2514\u2500\u252c\u2500 Sculpt_002_OK # The 2nd version of the \"Sculpt\" resource, which was published as ok \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.blend # The working file as it was when publishing \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.abc # The published export (an *Alembic* file) | \u2514\u2500\u252c\u2500 _preview \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.jpg # A file for previewing the modelling \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.mp4 # A file for previewing the modelling The _versions subfolder contains the versionning and history of the work. The _published subfolder contains the published and exported files to be used by other steps. The _preview subfolder contains the files for previewing the current work, like videos or images. These files may be used by Ramses to generate thumbnails. Ramses is also able to list, preview, and play these files (if their format is standard and supported). Warning The working file and published files do not include the version in their names, and the versionning and history are hidden in a _versions subfolder. This way, there can be no mistake about what file to open or import. Note Only Ramses should access the _versions subfolder and it should not be needed for the user to manipulate these files. Both the Ramses Client and Ramses Add-ons have a restore feature to retrieve previous versions. Tip When backuping a project, only the files in the published subfolder may be kept.","title":"A working folder"},{"location":"components/files/tree/#template-folders","text":"Ramses can use template files to create new working files. You can use this feature with any application, even if there\u2019s no Ramses Add-on available for it (yet). The template files must be located in each step\u2019s Templates subfolder. As you can have multiple templates for a single step, each template must be located in its own subfolder, which itself must respect the working folder structure. Here is an example of a step folder and its templates: \u250c PROJECTID # Root \u2514\u2500\u252c\u2500 02-PROD \u2514\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the MOD step \u2514\u2500\u252c\u2500 Templates # Template files for the mod step \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template # A template \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Other # Another template A template folder should be organized the same way as any working folder . Typically, a template folder will look like this: \u250c PROJECTID_G_MOD_Template # The working folder for the template named \"Template\" \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The main template file \u2502 \u251c\u2500\u252c\u2500 _versions # The versionning folder \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template_wip001.blend \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template_wip002.blend \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template_ok003.blend \u2502 \u2514\u2500\u252c\u2500 _published \u251c\u2500\u252c\u2500 001_WIP # The first published version \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The working file as it was when publishing \u2502 \u2514\u2500\u252c\u2500 003_OK # The 3rd version, which was published as ok \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The working file as it was when publishing Note A template working folder may contain different resources, but even if they\u2019re published, Ramses will use only the main resource to create new files from templates and ignore other resources.","title":"Template folders"},{"location":"components/files/tree/#ramses-special-files-and-folders","text":"Ramses will also store some special files and folders it needs in the Ramses Tree .","title":"Ramses special files and folders"},{"location":"components/files/tree/#_trash-folder","text":"When Ramses needs to remove a file, it will automatically be moved in a _trash subfolder. If a file with the same name already exists in this _trash subfolder, it will be moved in the system trash so it\u2019s not overwritten.","title":"_trash Folder"},{"location":"components/files/tree/#_ramses_datajson-file","text":"Ramses may create a file named _ramses_data.json in any folder. This file is used to store some meta-data associated with the other files in the same folder. This file should stay small, and it should never be manually removed.","title":"_ramses_data.json File"},{"location":"components/files/tree/#ini-files","text":"Ramses stores its settings in files with the .ini extension. These are standard text files, and should remain only in folders named Config . If these files (or the Config folders) are removed, this re-initializes the corresponding settings in Ramses .","title":"*.ini Files"},{"location":"components/server/","text":"The Ramses Server The server stores and serves all shared data to the Ramses Application between all workstations in the studio. The Ramses Applications installed on these workstations connect to it to sync the data they need. You can either install your own or rent a server managed by RxLaboratory (or any other provider you trust). It is just a small software meant to be installable on small hardware and with very low requirements. You can install it on any computer in the studio (even just a simple Raspberry ) and make it available on your Local Area Network , or make it available from the internet. You can also easily install it on a shared or private hosting, even a low-cost one. Requirements Required Software The Ramses Server must be installed on a computer with: An http(s) web server like Apache PHP 7 Optional Software An acces to a mySQL or MariaDB or any other compatible server and a dedicated database. Without such a database server, the Ramses Server can still be run correctly (it will use an SQLite database which doesn\u2019t need any particular server), but performance may be poor with too many different concurrent users. An SSL certificate. Although this is not mandatory, it is strongly recommended to always encrypt your connections to the server, especially if the server is publicly available on the internet. Recommended configuration The recommended configuration is a standard AMP stack ( Apache - mySQL - PHP ), with at least 2GB of RAM if the SQL server is on the same computer than the Apache server. The needed space for the Ramses Server files ( PHP ) is only 200 KB ! If you\u2019re not using a mySQL database, you\u2019ll need more space to store the data directly with the server files. How much space depends on the size of the projects you\u2019ll work on, but it will never be huge. 100 MB should be more than enough in most cases. If you\u2019re using a mySQL database, 100 MB should be more than enough for the vast majority of users. Technical description The Ramses Server is a pretty standard REST API written in PHP which just serves as an interface to an SQL database. It receives requests from the Ramses Client and responds with the needed data. For developers who may want to extend or modify Ramses , or develop their own client, the complete reference of this API is available here .","title":"Introduction"},{"location":"components/server/#the-ramses-server","text":"The server stores and serves all shared data to the Ramses Application between all workstations in the studio. The Ramses Applications installed on these workstations connect to it to sync the data they need. You can either install your own or rent a server managed by RxLaboratory (or any other provider you trust). It is just a small software meant to be installable on small hardware and with very low requirements. You can install it on any computer in the studio (even just a simple Raspberry ) and make it available on your Local Area Network , or make it available from the internet. You can also easily install it on a shared or private hosting, even a low-cost one.","title":"The Ramses Server"},{"location":"components/server/#requirements","text":"","title":"Requirements"},{"location":"components/server/#required-software","text":"The Ramses Server must be installed on a computer with: An http(s) web server like Apache PHP 7","title":"Required Software"},{"location":"components/server/#optional-software","text":"An acces to a mySQL or MariaDB or any other compatible server and a dedicated database. Without such a database server, the Ramses Server can still be run correctly (it will use an SQLite database which doesn\u2019t need any particular server), but performance may be poor with too many different concurrent users. An SSL certificate. Although this is not mandatory, it is strongly recommended to always encrypt your connections to the server, especially if the server is publicly available on the internet.","title":"Optional Software"},{"location":"components/server/#recommended-configuration","text":"The recommended configuration is a standard AMP stack ( Apache - mySQL - PHP ), with at least 2GB of RAM if the SQL server is on the same computer than the Apache server. The needed space for the Ramses Server files ( PHP ) is only 200 KB ! If you\u2019re not using a mySQL database, you\u2019ll need more space to store the data directly with the server files. How much space depends on the size of the projects you\u2019ll work on, but it will never be huge. 100 MB should be more than enough in most cases. If you\u2019re using a mySQL database, 100 MB should be more than enough for the vast majority of users.","title":"Recommended configuration"},{"location":"components/server/#technical-description","text":"The Ramses Server is a pretty standard REST API written in PHP which just serves as an interface to an SQL database. It receives requests from the Ramses Client and responds with the needed data. For developers who may want to extend or modify Ramses , or develop their own client, the complete reference of this API is available here .","title":"Technical description"},{"location":"components/server/admin/","text":"Warning Ramses is still under active development , and this documentation is still being written. This specific page of the documentation still has to be written, sorry!","title":"Administration"},{"location":"components/server/config/","text":"Server configuration The server can and must be configured by editing these two files: config/config.php and config/config_logs.php . config.php The config.php file contains the main configuration and should look like that: <?php /* Ramses: Rx Asset Management System This program is licensed under the GNU General Public License. Copyright (C) 20202-2021 Nicolas Dufresne and Contributors. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the *GNU General Public License* along with this program. If not, see http://www.gnu.org/licenses/. */ // Edit this configuration file before running the install script at /install/index.php // === DEV MODE & DEBUG Info === // Activates printing the SQL & PHP errors. // For security reasons, it is important to set this to false in production mode $devMode = false; // Sets the minimum level of the logs in the server replies sent to the clients // One of: 'DATA', 'DEBUG', 'INFO', 'WARNING', 'CRITICAL', 'FATAL' $logLevel = 'WARNING'; // ==== SQL SETTINGS ==== // either 'mysql' (works for MariaDB too) or 'sqlite' $sqlMode = 'sqlite'; // Table prefix // should be a random character string (use https://duckduckgo.com/?q=generate+password) // you can setup multiple instances on the same DB // if each use a different prefix $tablePrefix = \"5H3VBzSY\"; // ==== MySQL/MariaDB SETTINGS ==== // Host URL $sqlHost = \"db\"; $sqlPort = 3306; // Database name $sqlDBName = \"ramses\"; // User $sqlUser = \"ramses\"; // Password $sqlpassword = \"password\"; // ==== SESSION & SECURITY SETTINGS ==== // This must be the server public adress, exactly as used in the clients $serverAddress = \"localhost/ramses\"; // Whether to accept only SSL connections // This should always be true, except maybe on dev environments. $forceSSL = true; // Session timeout (seconds) // The client will be disconnected after being idle for this time // 30 minutes by default (1800) are more than enough: // The official client makes a call at least every 2 minutes by default. // A negative value completely deactivates the timeout check. $sessionTimeout = 1800; // Max Session timeout (seconds) // The client will be disconnected no matter what after this time // 12 hours by default( 43200 ) $cookieTimeout = 43200; // This should never be changed, unless you change the key before building the official client or implementing your own client. // It is used to break compatibility between some updates of the client/server framework // It can be used to make sure only your own client, built by yourself, can connect to your own server. In this case, keep it secret! // It is used to hash passwords. $clientKey = \"drHSV2XQ\"; ?> $devMode should always be false unless this server is going to be used for development and tests in a development environement. For security reasons do not set this to true on a production server. $logLevel controls the quantity of logs included in the server replies and displayed by Ramses Applications . This is independant from the logs saved on the server configured by the config/config_logs.php file. $sqlMode can be either 'sqlite' or 'mysql' depending on your choice of configuration (read above). $tablePrefix is a prefix which will be used for the name of the database tables used by Ramses . It allows you to share a database with other instances of Ramses and even any other application (for example if your provider doesn\u2019t allow you to create more databases on your server). These next options are only used in MySQL mode. Ignore them when using SQLite . $sqlHost is the host name or IP of your MySQL server. Don\u2019t forget the quotes! $sqlPort is the port used by the MySQL server. 3306 is the default for most installations, if you need something different, your hosting provider should tell you. $sqlDBName is the name of the specific database you have to create for Ramses . $sqlUser is the name of the specific MySQL user you have to create for Ramses . $sqlpassword is the password of the specific MySQL user you have to create for Ramses . Note When using the MySQL Docker folder, do not change the sqlHost value, unless you\u2019ve changed the settings in the docker_compose.yml file. And finally complete these settings too: $serverAddress must be the one and only address used by the Ramses Applications to connect to this server. If this is incorrectly set, Ramses Applications won\u2019t be able to connect to this server. $forceSSL will always redirect calls to https when set to true . Set this to false if you don\u2019t have any SSL certificate on this server (not recommended). $sessionTimeout is the time, in seconds, before an idle client is disconnected. $cookieTimeout is the time, in seconds, before a client is disconnected, no matter what. $clientKey can be changed only if your client is not the official open source Ramses Client Application . Otherwise, leave it to the default value. It is a way to make sure only your client can connect to the server. It is currently used only when setting up the first user (administrator) during the server installation. config_logs.php Ramses can log what happens on the server. This can be useful for debugging or to diagnose issues on the server. By default, all logs are deactivated. Logs are stored by date in the logs subfolder inside the ramses server folder. Connection logs and debug logs are stored as CSV files (one per day), request logs are text and json files (one subfolder per request). This is the configuration for the logs: <?php /* Ramses: Rx Asset Management System This program is licensed under the GNU General Public License. Copyright (C) 20202-2021 Nicolas Dufresne and Contributors. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the *GNU General Public License* along with this program. If not, see http://www.gnu.org/licenses/. */ // Edit this configuration file to adjust server logging // === GLOBALLY ENABLE LOGS === $enableLogs = false; // Connexion logs $connexionLogs = false; // Requests logs $requestLogs = false; // Debug logs $debugLogs = false; // How long do we keep logs? (days) $logsExpiration = 2; ?> $enableLogs : set this to true or false to globally enable logs. $connexionLogs : when true , ramses will log all connections and disconnections to and from the server. $requestLogs : when true , ramses will log requests received by the server including: the request headers, body, and some metadata. The details of the request headers may change according to the web server you\u2019re using and its version. $debugLogs : when true , ramses will log some extra information coming with each request. $logsExpiration sets how many days the logs will be kept. Keep this value small if there\u2019s a lot of activity on your server to avoid quickly growing the log size.","title":"Configuration"},{"location":"components/server/config/#server-configuration","text":"The server can and must be configured by editing these two files: config/config.php and config/config_logs.php .","title":"Server configuration"},{"location":"components/server/config/#configphp","text":"The config.php file contains the main configuration and should look like that: <?php /* Ramses: Rx Asset Management System This program is licensed under the GNU General Public License. Copyright (C) 20202-2021 Nicolas Dufresne and Contributors. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the *GNU General Public License* along with this program. If not, see http://www.gnu.org/licenses/. */ // Edit this configuration file before running the install script at /install/index.php // === DEV MODE & DEBUG Info === // Activates printing the SQL & PHP errors. // For security reasons, it is important to set this to false in production mode $devMode = false; // Sets the minimum level of the logs in the server replies sent to the clients // One of: 'DATA', 'DEBUG', 'INFO', 'WARNING', 'CRITICAL', 'FATAL' $logLevel = 'WARNING'; // ==== SQL SETTINGS ==== // either 'mysql' (works for MariaDB too) or 'sqlite' $sqlMode = 'sqlite'; // Table prefix // should be a random character string (use https://duckduckgo.com/?q=generate+password) // you can setup multiple instances on the same DB // if each use a different prefix $tablePrefix = \"5H3VBzSY\"; // ==== MySQL/MariaDB SETTINGS ==== // Host URL $sqlHost = \"db\"; $sqlPort = 3306; // Database name $sqlDBName = \"ramses\"; // User $sqlUser = \"ramses\"; // Password $sqlpassword = \"password\"; // ==== SESSION & SECURITY SETTINGS ==== // This must be the server public adress, exactly as used in the clients $serverAddress = \"localhost/ramses\"; // Whether to accept only SSL connections // This should always be true, except maybe on dev environments. $forceSSL = true; // Session timeout (seconds) // The client will be disconnected after being idle for this time // 30 minutes by default (1800) are more than enough: // The official client makes a call at least every 2 minutes by default. // A negative value completely deactivates the timeout check. $sessionTimeout = 1800; // Max Session timeout (seconds) // The client will be disconnected no matter what after this time // 12 hours by default( 43200 ) $cookieTimeout = 43200; // This should never be changed, unless you change the key before building the official client or implementing your own client. // It is used to break compatibility between some updates of the client/server framework // It can be used to make sure only your own client, built by yourself, can connect to your own server. In this case, keep it secret! // It is used to hash passwords. $clientKey = \"drHSV2XQ\"; ?> $devMode should always be false unless this server is going to be used for development and tests in a development environement. For security reasons do not set this to true on a production server. $logLevel controls the quantity of logs included in the server replies and displayed by Ramses Applications . This is independant from the logs saved on the server configured by the config/config_logs.php file. $sqlMode can be either 'sqlite' or 'mysql' depending on your choice of configuration (read above). $tablePrefix is a prefix which will be used for the name of the database tables used by Ramses . It allows you to share a database with other instances of Ramses and even any other application (for example if your provider doesn\u2019t allow you to create more databases on your server). These next options are only used in MySQL mode. Ignore them when using SQLite . $sqlHost is the host name or IP of your MySQL server. Don\u2019t forget the quotes! $sqlPort is the port used by the MySQL server. 3306 is the default for most installations, if you need something different, your hosting provider should tell you. $sqlDBName is the name of the specific database you have to create for Ramses . $sqlUser is the name of the specific MySQL user you have to create for Ramses . $sqlpassword is the password of the specific MySQL user you have to create for Ramses . Note When using the MySQL Docker folder, do not change the sqlHost value, unless you\u2019ve changed the settings in the docker_compose.yml file. And finally complete these settings too: $serverAddress must be the one and only address used by the Ramses Applications to connect to this server. If this is incorrectly set, Ramses Applications won\u2019t be able to connect to this server. $forceSSL will always redirect calls to https when set to true . Set this to false if you don\u2019t have any SSL certificate on this server (not recommended). $sessionTimeout is the time, in seconds, before an idle client is disconnected. $cookieTimeout is the time, in seconds, before a client is disconnected, no matter what. $clientKey can be changed only if your client is not the official open source Ramses Client Application . Otherwise, leave it to the default value. It is a way to make sure only your client can connect to the server. It is currently used only when setting up the first user (administrator) during the server installation.","title":"config.php"},{"location":"components/server/config/#config_logsphp","text":"Ramses can log what happens on the server. This can be useful for debugging or to diagnose issues on the server. By default, all logs are deactivated. Logs are stored by date in the logs subfolder inside the ramses server folder. Connection logs and debug logs are stored as CSV files (one per day), request logs are text and json files (one subfolder per request). This is the configuration for the logs: <?php /* Ramses: Rx Asset Management System This program is licensed under the GNU General Public License. Copyright (C) 20202-2021 Nicolas Dufresne and Contributors. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the *GNU General Public License* along with this program. If not, see http://www.gnu.org/licenses/. */ // Edit this configuration file to adjust server logging // === GLOBALLY ENABLE LOGS === $enableLogs = false; // Connexion logs $connexionLogs = false; // Requests logs $requestLogs = false; // Debug logs $debugLogs = false; // How long do we keep logs? (days) $logsExpiration = 2; ?> $enableLogs : set this to true or false to globally enable logs. $connexionLogs : when true , ramses will log all connections and disconnections to and from the server. $requestLogs : when true , ramses will log requests received by the server including: the request headers, body, and some metadata. The details of the request headers may change according to the web server you\u2019re using and its version. $debugLogs : when true , ramses will log some extra information coming with each request. $logsExpiration sets how many days the logs will be kept. Keep this value small if there\u2019s a lot of activity on your server to avoid quickly growing the log size.","title":"config_logs.php"},{"location":"components/server/install-docker-mysql/","text":"Docker install (MySQL) Use the Docker MySQL folder for a quick and easy setup of the Ramses Server . Un-Zip the ramses-server_docker-mysql archive you\u2019ve downloaded. On Linux , you may need to adjust permissions to the unzipped folder to make sure Docker has write access in there. Set passwords for the database. You may skip this step in development environments, but they must be set in production. Set the $sqlpassword variable in www/config/config.php . Set the same password for the MYSQL_PASSWORD variable in docker-compose.yml . Set a new password for the MYSQL_ROOT_PASSWORD variable in docker-compose.yml . Replace password and rootpassword in the db/init.sql file with the new passwords you\u2019ve chosen. Go inside the docker folder and use the command docker compose up . Go to http://localhost:8001/ramses/install . Delete the install folder from the docker folder. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database! Customize the Docker container There are some settings you may find useful to adjust in the provided docker-compose.yml file before you run your container. Default www port By default, the Docker Ramses Server is set to use the 8001 port. It may be easier to use the default 80 port. Default MySQL port By default, the Docker Ramses Server is set to use the usual 3306 port. You can adjust this port to avoid conflicts on the server running the container. This is also true for PHPMyAdmin which exposes the 8000 port by default in this configuration. Secured connection (SSL) In production, it is recommended to add an SSL certificate to the Ramses Server and set $forceSSL = true; in the Ramses Server config/config.php file. In this case, you can add this port mapping to the www service: - \"XXX:443\" Change XXX by the port you want to expose, which should be 443 by default. Access the MySQL Data A PHPMyAdmin container is included to help you access and manage the database. Go to http://localhost:8000 to access it, and user either the ramses user and its password to access the ramses database, or the admin user and its rootpassword to manage the whole database.","title":"Docker (MySQL)"},{"location":"components/server/install-docker-mysql/#docker-install-mysql","text":"Use the Docker MySQL folder for a quick and easy setup of the Ramses Server . Un-Zip the ramses-server_docker-mysql archive you\u2019ve downloaded. On Linux , you may need to adjust permissions to the unzipped folder to make sure Docker has write access in there. Set passwords for the database. You may skip this step in development environments, but they must be set in production. Set the $sqlpassword variable in www/config/config.php . Set the same password for the MYSQL_PASSWORD variable in docker-compose.yml . Set a new password for the MYSQL_ROOT_PASSWORD variable in docker-compose.yml . Replace password and rootpassword in the db/init.sql file with the new passwords you\u2019ve chosen. Go inside the docker folder and use the command docker compose up . Go to http://localhost:8001/ramses/install . Delete the install folder from the docker folder. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database!","title":"Docker install (MySQL)"},{"location":"components/server/install-docker-mysql/#customize-the-docker-container","text":"There are some settings you may find useful to adjust in the provided docker-compose.yml file before you run your container.","title":"Customize the Docker container"},{"location":"components/server/install-docker-mysql/#default-www-port","text":"By default, the Docker Ramses Server is set to use the 8001 port. It may be easier to use the default 80 port.","title":"Default www port"},{"location":"components/server/install-docker-mysql/#default-mysql-port","text":"By default, the Docker Ramses Server is set to use the usual 3306 port. You can adjust this port to avoid conflicts on the server running the container. This is also true for PHPMyAdmin which exposes the 8000 port by default in this configuration.","title":"Default MySQL port"},{"location":"components/server/install-docker-mysql/#secured-connection-ssl","text":"In production, it is recommended to add an SSL certificate to the Ramses Server and set $forceSSL = true; in the Ramses Server config/config.php file. In this case, you can add this port mapping to the www service: - \"XXX:443\" Change XXX by the port you want to expose, which should be 443 by default.","title":"Secured connection (SSL)"},{"location":"components/server/install-docker-mysql/#access-the-mysql-data","text":"A PHPMyAdmin container is included to help you access and manage the database. Go to http://localhost:8000 to access it, and user either the ramses user and its password to access the ramses database, or the admin user and its rootpassword to manage the whole database.","title":"Access the MySQL Data"},{"location":"components/server/install-docker-sqlite/","text":"Docker install (SQLite) Use the Docker SQLite folder for a quick and easy setup of the Ramses Server . This is the recommended way of using the Ramses Server in a development environement. Un-Zip the ramses-server_docker-sqlite archive you\u2019ve downloaded. On Linux , you may need to adjust permissions to the unzipped folder to make sure Docker has write access in there. Go inside the docker folder and use the command docker compose up . Go to http://localhost:8001/ramses/install . Delete the install folder from the docker folder. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database! Customize the Docker container There are some settings you may find useful to adjust in the provided docker-compose.yml file before you run your container. Default port By default, the Docker Ramses Server is set to use the 8001 port. It may be easier to use the default 80 port. Secured connection (SSL) In production, it is recommended to add an SSL certificate to the Ramses Server and set $forceSSL = true; in the Ramses Server config/config.php file. In this case, you can add this port mapping to the www service: - \"XXX:443\" Change XXX by the port you want to expose, which should be 443 by default.","title":"Docker (SQLite)"},{"location":"components/server/install-docker-sqlite/#docker-install-sqlite","text":"Use the Docker SQLite folder for a quick and easy setup of the Ramses Server . This is the recommended way of using the Ramses Server in a development environement. Un-Zip the ramses-server_docker-sqlite archive you\u2019ve downloaded. On Linux , you may need to adjust permissions to the unzipped folder to make sure Docker has write access in there. Go inside the docker folder and use the command docker compose up . Go to http://localhost:8001/ramses/install . Delete the install folder from the docker folder. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database!","title":"Docker install (SQLite)"},{"location":"components/server/install-docker-sqlite/#customize-the-docker-container","text":"There are some settings you may find useful to adjust in the provided docker-compose.yml file before you run your container.","title":"Customize the Docker container"},{"location":"components/server/install-docker-sqlite/#default-port","text":"By default, the Docker Ramses Server is set to use the 8001 port. It may be easier to use the default 80 port.","title":"Default port"},{"location":"components/server/install-docker-sqlite/#secured-connection-ssl","text":"In production, it is recommended to add an SSL certificate to the Ramses Server and set $forceSSL = true; in the Ramses Server config/config.php file. In this case, you can add this port mapping to the www service: - \"XXX:443\" Change XXX by the port you want to expose, which should be 443 by default.","title":"Secured connection (SSL)"},{"location":"components/server/install-src/","text":"Install from source Installing from source is the easiest way to install the ramses server on any host, including shared hosting. ( MySQL only) Create a new base on your SQL server, along with its user and password. Un-Zip the Ramses Server you\u2019ve downloaded. Edit config/config.php with all needed info. Copy the Ramses Server files to the web server (you can just copy the ramses folder from the ZIP archive). Go to http://your.server/ramses/install . Delete the install folder from the server. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database!","title":"Install from source"},{"location":"components/server/install-src/#install-from-source","text":"Installing from source is the easiest way to install the ramses server on any host, including shared hosting. ( MySQL only) Create a new base on your SQL server, along with its user and password. Un-Zip the Ramses Server you\u2019ve downloaded. Edit config/config.php with all needed info. Copy the Ramses Server files to the web server (you can just copy the ramses folder from the ZIP archive). Go to http://your.server/ramses/install . Delete the install folder from the server. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database!","title":"Install from source"},{"location":"components/server/install/","text":"Ramses Server installation Ramses Server runs on very standard web servers, with the usual Web Server / PHP / mySQL stack. That means you can install it on almost any desktop or server computers, private server, shared hosting, workstation, Raspberry\u2026 It doesn\u2019t need much resources. Warning The procedure to install and to update Ramses differ a bit. Do not follow the installation procedure to update your server, as it will wipe all your data! It is also a good habit to always backup the data before updating. Prerequisites Ramses Server must be installed on a computer with: An http web server like Apache PHP 7 Optionally , an acces to a mySQL server and a dedicated database. An SSL certificate. Although this is not mandatory, it is strongly recommended to always encrypt your connections to the server, especially if the server is publicly available on the internet. The recommended configuration is a standard AMP stack ( Apache - mySQL - PHP ), with at least 2GB of RAM if the SQL server is on the same computer than the Apache server. This can easily be automated using Docker if you already have it installed. We provide a ready-to-use Docker folder to help you quickly install and run the server. Installation You first have to decide what type of database the Ramses Server will be using. There are two options: MySQL or any other compatible server like MariaDB . Use this if there will be a lot of users connected simultaneously to Ramses , and if you already know how to configure an SQL database (or you\u2019re ready to learn). SQLite is a simpler database, self-contained in a single file handled by the Ramses Server . Use this if there will be just a few users connected simultaneously to Ramses , or if you want a server easier to setup and backup. Once you\u2019ve made your choice, follow these guides according to your environement: \u25b9 Install from source \u25b9 Docker (MySQL) \u25b9 Docker (SQLite) You can adjust the server configuration by editing config/config.php and config/config_logs.php .","title":"Installation"},{"location":"components/server/install/#ramses-server-installation","text":"Ramses Server runs on very standard web servers, with the usual Web Server / PHP / mySQL stack. That means you can install it on almost any desktop or server computers, private server, shared hosting, workstation, Raspberry\u2026 It doesn\u2019t need much resources. Warning The procedure to install and to update Ramses differ a bit. Do not follow the installation procedure to update your server, as it will wipe all your data! It is also a good habit to always backup the data before updating.","title":"Ramses Server installation"},{"location":"components/server/install/#prerequisites","text":"Ramses Server must be installed on a computer with: An http web server like Apache PHP 7 Optionally , an acces to a mySQL server and a dedicated database. An SSL certificate. Although this is not mandatory, it is strongly recommended to always encrypt your connections to the server, especially if the server is publicly available on the internet. The recommended configuration is a standard AMP stack ( Apache - mySQL - PHP ), with at least 2GB of RAM if the SQL server is on the same computer than the Apache server. This can easily be automated using Docker if you already have it installed. We provide a ready-to-use Docker folder to help you quickly install and run the server.","title":"Prerequisites"},{"location":"components/server/install/#installation","text":"You first have to decide what type of database the Ramses Server will be using. There are two options: MySQL or any other compatible server like MariaDB . Use this if there will be a lot of users connected simultaneously to Ramses , and if you already know how to configure an SQL database (or you\u2019re ready to learn). SQLite is a simpler database, self-contained in a single file handled by the Ramses Server . Use this if there will be just a few users connected simultaneously to Ramses , or if you want a server easier to setup and backup. Once you\u2019ve made your choice, follow these guides according to your environement: \u25b9 Install from source \u25b9 Docker (MySQL) \u25b9 Docker (SQLite) You can adjust the server configuration by editing config/config.php and config/config_logs.php .","title":"Installation"},{"location":"components/server/update/","text":"Ramses Server update Before updating, it is always a good habit to backup your data! Backup the server files (php) : download them or move them to another folder. If you\u2019re using SQLite , the database is included in these files, it is the data/ramses_data file. Backup the data if you\u2019re using a MySQL server . Use phpMyAdmin to export the database, or any backup provided by your web hosting provider. Keep a copy of of the config folder in a safe place! If you lose the information from these files, you\u2019ll permanently lose access to part or all of your data, and nobody will ever be able to retrieve it. But be careful, if anyone gets access to them, they will be able to access and decrypt your data without you knowing it. With this copy of your server, you\u2019ll be able to easily retrieve your data or revert to the previous version if anything goes wrong. The safe update procedure is as follow: Un-Zip the Ramses Server you\u2019ve downloaded. Download the current config folder from your server and keep it safe. Update the new version of config/config.php with the same information from the one you\u2019ve just retrieved. Update the new version of config/config_logs.php with the same information from the one you\u2019ve just retrieved. Upload all files and folders from the update package to your server, except the folder named install . Note In the future, when Ramses won\u2019t be in a test version anymore, there should be an automatic update procedure.","title":"Update"},{"location":"components/server/update/#ramses-server-update","text":"Before updating, it is always a good habit to backup your data! Backup the server files (php) : download them or move them to another folder. If you\u2019re using SQLite , the database is included in these files, it is the data/ramses_data file. Backup the data if you\u2019re using a MySQL server . Use phpMyAdmin to export the database, or any backup provided by your web hosting provider. Keep a copy of of the config folder in a safe place! If you lose the information from these files, you\u2019ll permanently lose access to part or all of your data, and nobody will ever be able to retrieve it. But be careful, if anyone gets access to them, they will be able to access and decrypt your data without you knowing it. With this copy of your server, you\u2019ll be able to easily retrieve your data or revert to the previous version if anything goes wrong. The safe update procedure is as follow: Un-Zip the Ramses Server you\u2019ve downloaded. Download the current config folder from your server and keep it safe. Update the new version of config/config.php with the same information from the one you\u2019ve just retrieved. Update the new version of config/config_logs.php with the same information from the one you\u2019ve just retrieved. Upload all files and folders from the update package to your server, except the folder named install . Note In the future, when Ramses won\u2019t be in a test version anymore, there should be an automatic update procedure.","title":"Ramses Server update"},{"location":"dev/","text":"Developping and extending Ramses Warning Ramses is still under active development , and this documentation is still being written. This specific page of the documentation is just a draft, sorry! Ramses already includes a few different APIs to allow for different levels of extensibility, and don\u2019t forget, Ramses is free and open source, you can modify it according to your needs, and you can also contribute ;) Extending Ramses Several levels: Add-Ons extensibility Using: The Ramses Scripting API The Daemon API Client extensibility Using the Server API Add-ons Extending a provided Add-On Adobe After Effects Autodesk Maya Blender Inkscape Krita Developping a new Add-On using the Ramses Scripting API Python Adobe ExtendScript Other languages: building a new API using the Daemon API Client Application Using Triggers and scripts with the provided client Windows 64 bits MacOS Linux amd64 Compiling the existing client for a new platform Building a new client using the Server API Contributing and developping Ramses WIP","title":"Introduction"},{"location":"dev/#developping-and-extending-ramses","text":"Warning Ramses is still under active development , and this documentation is still being written. This specific page of the documentation is just a draft, sorry! Ramses already includes a few different APIs to allow for different levels of extensibility, and don\u2019t forget, Ramses is free and open source, you can modify it according to your needs, and you can also contribute ;)","title":"Developping and extending Ramses"},{"location":"dev/#extending-ramses","text":"Several levels: Add-Ons extensibility Using: The Ramses Scripting API The Daemon API Client extensibility Using the Server API","title":"Extending Ramses"},{"location":"dev/#add-ons","text":"Extending a provided Add-On Adobe After Effects Autodesk Maya Blender Inkscape Krita Developping a new Add-On using the Ramses Scripting API Python Adobe ExtendScript Other languages: building a new API using the Daemon API","title":"Add-ons"},{"location":"dev/#client-application","text":"Using Triggers and scripts with the provided client Windows 64 bits MacOS Linux amd64 Compiling the existing client for a new platform Building a new client using the Server API","title":"Client Application"},{"location":"dev/#contributing-and-developping-ramses","text":"WIP","title":"Contributing and developping Ramses"},{"location":"dev/objects/","text":"Objects and data In Ramses, everything is represented by Objects . An object consists of a Unique Universal Identifier (UUID) used to identify it across the whole system, and its associated data , encoded as a JSON Object . The whole object could thus be saved and shared as a JSON Document like this: { \"uuid\": \"unique-uid\", \"data\": { // Here's the data } } An object may also be associated with some paths in the file system. These paths are dynamic and are not included in the associated data . They have to be queried or defined by the software. Ramses Objects (i.e. RamObjects ) can represent a shot, an asset, a user, an application, or a whole project for example. They can also contain lists of other objects. Lists of objects are basic string lists of UUIDs stored in the parent object data. UUIDs and object data are synced by all the Ramses Applications and a Ramses Server , and are mirrored on all workstations and the server itself. Any other software (e.g. APIs , scripts, plugins\u2026) should get the list of objects and all data using the Ramses Daemon run by the Ramses Application which is guaranteed to be up-to-date. You can also use the Daemon to set new data to specific objects. Virtual objects RamObject All objects derive from the RamObject and have at least the same properties. Note Some optional properties may be missing in the JSON data as shared by Ramses . In this case, it\u2019s up to the software to decide of a default value. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", // Colors are Hexadecimal numbers with a leading # \"settings\": { // The settings object can contain additional arbitrary values, // depending on the object // these values can be set by any software / API } } RamObjectList A list of other objects. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"list\": [ \"uuid1\", \"uuid2\", \"...\" ] } Objects RamApplication An application used in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"executableFilePath\": \"path/to/the/application/bin.exe\", \"nativeFileTypes\": \"RamFileType_list-uuid\", \"importFileTypes\": \"RamFileType_list-uuid\", \"exportFileTypes\": \"RamFileType_list-uuid\", } RamAsset An asset used in one or several shots. The RamAsset is derived from the RamItem and has all its properties. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"\", // Should be the same as the containing asset group \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" }, \"assetGroup\": \"RamAssetGroup-uuid\", \"tags\": [ \"tag1\", \"tag2\", \"...\" ] } RamAssetGroup A group of assets. All assets should be assigned to one and only one group. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\" } RamFileType A type of file. { \"shortName\": \"abc\", // Should be the default file extension \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"extensions\": [ \"abc\", \"def\", \"etc\" ], \"previewable\": true // Is it standard and can it be opened with the OS default file viewer? } RamItem An item (i.e. a shot or an asset or another production file/folder) { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" } } RamPipe A connexion between two steps in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"inputStep\": \"RamStep-uuid\", // The step this pipe is connected to \"outputStep\": \"RamStep-uuid\", // The step this pipe comes from \"project\": \"RamProject-uuid\", \"pipeFiles\": \"RamPipeFile_list-uuid\" // The list of files used through this pipe } RamPipeFile A a specific format used through a pipe. { \"shortName\": \"a short ID\", \"name\": \"a short ID.ext\", // Should be the shortname and the extension of the file type \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"fileType\": \"RamFileType-uuid\", \"project\": \"RamProject-uuid\", \"customSettings\": \"- format: ext\" // Settings to be used in applications when handling this format; formatted as a YAML string. } RamProject A project (feature film, episode, short movie\u2026) { \"shortName\": \"a short ID\", \"name\": \"a short ID.ext\", // Should be the shortname and the extension of the file type \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"steps\": \"RamStep_list-uuid\", \"assetGroups\": \"RamAssetGroup_list-uuid\", \"sequences\": \"RamSequence_list-uuid\", \"shots\": \"RamShot_list-uuid\", \"assets\": \"RamAsset_list-uuid\", \"pipeline\": \"RamPipe_list-uuid\", \"pipeFiles\": \"RamPipeFile_list-uuid\", \"users\": \"RamUser_list-uuid\", \"scheduleComments\": \"RamScheduleComment_list-uuid\", \"framerate\": 24.0, \"width\": 2048, \"height\": 858, \"aspectRatio\": 2.85, \"deadline\": \"2023-01-01\" } RamScheduleComment A simple comment in the schedule. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"date\": \"2022-09-01 12:00:00\" } RamScheduleEntry An entry in the schedule, i.e. a step associated to a user and a date. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"date\": \"2022-09-01 12:00:00\", \"user\": \"RamUser-uuid\", \"step\": \"RamStep-uuid\" } RamSequence A sequence containing shots. All shots must be part of one and only one sequence. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\" } RamShot A shot. All shots must be part of one and only one sequence. The RamShot is derived from the RamItem and has all its properties. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" }, \"sequence\": \"RamSequence-uuid\", \"duration\": 5, // in seconds \"assets\": \"RamAsset_list-uuid\" // The list of assets used in this shot } RamState A state of production, used in the more general RamStatus . { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"completionRatio\": 50 // % } RamStatus The status of the production of an item, for a specific step. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"completionRatio\": 50, // % \"user\": \"RamUser-uuid\", // The last user who's modified the status \"step\": \"RamStep-uuid\", \"item\": \"RamItem-uuid or RamShot-uuid or RamAsset-uuid\", \"itemType\": \"asset\", // One of asset or shot or item \"state\": \"RamState-uuid\", \"version\": 12, \"date\": \"2022-09-15 13:00:00 \", // The modification date of the status \"published\": true, // Is this item ready to be used in another step? \"assignedUser\": \"RamUser-uuid\", // Who's working on this? \"timeSpent\": 3600, // Seconds \"difficulty\": \"medium\", // One of: veryEasy, easy, medium, hard, veryHard \"goal\": 3 // How long this shoud take, in days } RamStep A step in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"estimationMultiplyGroup\": \"RamAssetGroup-uuid\", // Used to estimate time for shots \"type\": \"shot\", // One of pre, asset, shot, post, all \"publishSettings\": \"- format: ext\", // Some settings to be used by an application to publish files. Should be a YAML-formatted string \"estimationMethod\": \"shot\", // Pne of shot, second. Estimate work per shot or per second \"estimationVeryEasy\": 0.1, // days \"estimationEasy\": 0.5, \"estimationMedium\": 1, \"estimationHard\": 2, \"estimationVeryHard\": 5 } RamUser A user of Ramses. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"role\": \"lead\", // One of admin, project, lead, standard, \"schedule\": \"RamScheduleEntry_list-uuid\", \"email\": \"contact@rxlaboratory.org\" } Note User data is encrypted in databases saved by the Ramses Application and Ramses Server to protect user privacy. Extensions (scripts, APIs, etc) should never write user data to any file, unless it is safely encrypted too. The email should be used for technical features, like password retrieval, but never be available to other users.","title":"Objects"},{"location":"dev/objects/#objects-and-data","text":"In Ramses, everything is represented by Objects . An object consists of a Unique Universal Identifier (UUID) used to identify it across the whole system, and its associated data , encoded as a JSON Object . The whole object could thus be saved and shared as a JSON Document like this: { \"uuid\": \"unique-uid\", \"data\": { // Here's the data } } An object may also be associated with some paths in the file system. These paths are dynamic and are not included in the associated data . They have to be queried or defined by the software. Ramses Objects (i.e. RamObjects ) can represent a shot, an asset, a user, an application, or a whole project for example. They can also contain lists of other objects. Lists of objects are basic string lists of UUIDs stored in the parent object data. UUIDs and object data are synced by all the Ramses Applications and a Ramses Server , and are mirrored on all workstations and the server itself. Any other software (e.g. APIs , scripts, plugins\u2026) should get the list of objects and all data using the Ramses Daemon run by the Ramses Application which is guaranteed to be up-to-date. You can also use the Daemon to set new data to specific objects.","title":"Objects and data"},{"location":"dev/objects/#virtual-objects","text":"","title":"Virtual objects"},{"location":"dev/objects/#ramobject","text":"All objects derive from the RamObject and have at least the same properties. Note Some optional properties may be missing in the JSON data as shared by Ramses . In this case, it\u2019s up to the software to decide of a default value. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", // Colors are Hexadecimal numbers with a leading # \"settings\": { // The settings object can contain additional arbitrary values, // depending on the object // these values can be set by any software / API } }","title":"RamObject"},{"location":"dev/objects/#ramobjectlist","text":"A list of other objects. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"list\": [ \"uuid1\", \"uuid2\", \"...\" ] }","title":"RamObjectList"},{"location":"dev/objects/#objects","text":"","title":"Objects"},{"location":"dev/objects/#ramapplication","text":"An application used in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"executableFilePath\": \"path/to/the/application/bin.exe\", \"nativeFileTypes\": \"RamFileType_list-uuid\", \"importFileTypes\": \"RamFileType_list-uuid\", \"exportFileTypes\": \"RamFileType_list-uuid\", }","title":"RamApplication"},{"location":"dev/objects/#ramasset","text":"An asset used in one or several shots. The RamAsset is derived from the RamItem and has all its properties. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"\", // Should be the same as the containing asset group \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" }, \"assetGroup\": \"RamAssetGroup-uuid\", \"tags\": [ \"tag1\", \"tag2\", \"...\" ] }","title":"RamAsset"},{"location":"dev/objects/#ramassetgroup","text":"A group of assets. All assets should be assigned to one and only one group. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\" }","title":"RamAssetGroup"},{"location":"dev/objects/#ramfiletype","text":"A type of file. { \"shortName\": \"abc\", // Should be the default file extension \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"extensions\": [ \"abc\", \"def\", \"etc\" ], \"previewable\": true // Is it standard and can it be opened with the OS default file viewer? }","title":"RamFileType"},{"location":"dev/objects/#ramitem","text":"An item (i.e. a shot or an asset or another production file/folder) { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" } }","title":"RamItem"},{"location":"dev/objects/#rampipe","text":"A connexion between two steps in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"inputStep\": \"RamStep-uuid\", // The step this pipe is connected to \"outputStep\": \"RamStep-uuid\", // The step this pipe comes from \"project\": \"RamProject-uuid\", \"pipeFiles\": \"RamPipeFile_list-uuid\" // The list of files used through this pipe }","title":"RamPipe"},{"location":"dev/objects/#rampipefile","text":"A a specific format used through a pipe. { \"shortName\": \"a short ID\", \"name\": \"a short ID.ext\", // Should be the shortname and the extension of the file type \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"fileType\": \"RamFileType-uuid\", \"project\": \"RamProject-uuid\", \"customSettings\": \"- format: ext\" // Settings to be used in applications when handling this format; formatted as a YAML string. }","title":"RamPipeFile"},{"location":"dev/objects/#ramproject","text":"A project (feature film, episode, short movie\u2026) { \"shortName\": \"a short ID\", \"name\": \"a short ID.ext\", // Should be the shortname and the extension of the file type \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"steps\": \"RamStep_list-uuid\", \"assetGroups\": \"RamAssetGroup_list-uuid\", \"sequences\": \"RamSequence_list-uuid\", \"shots\": \"RamShot_list-uuid\", \"assets\": \"RamAsset_list-uuid\", \"pipeline\": \"RamPipe_list-uuid\", \"pipeFiles\": \"RamPipeFile_list-uuid\", \"users\": \"RamUser_list-uuid\", \"scheduleComments\": \"RamScheduleComment_list-uuid\", \"framerate\": 24.0, \"width\": 2048, \"height\": 858, \"aspectRatio\": 2.85, \"deadline\": \"2023-01-01\" }","title":"RamProject"},{"location":"dev/objects/#ramschedulecomment","text":"A simple comment in the schedule. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"date\": \"2022-09-01 12:00:00\" }","title":"RamScheduleComment"},{"location":"dev/objects/#ramscheduleentry","text":"An entry in the schedule, i.e. a step associated to a user and a date. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"date\": \"2022-09-01 12:00:00\", \"user\": \"RamUser-uuid\", \"step\": \"RamStep-uuid\" }","title":"RamScheduleEntry"},{"location":"dev/objects/#ramsequence","text":"A sequence containing shots. All shots must be part of one and only one sequence. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\" }","title":"RamSequence"},{"location":"dev/objects/#ramshot","text":"A shot. All shots must be part of one and only one sequence. The RamShot is derived from the RamItem and has all its properties. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" }, \"sequence\": \"RamSequence-uuid\", \"duration\": 5, // in seconds \"assets\": \"RamAsset_list-uuid\" // The list of assets used in this shot }","title":"RamShot"},{"location":"dev/objects/#ramstate","text":"A state of production, used in the more general RamStatus . { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"completionRatio\": 50 // % }","title":"RamState"},{"location":"dev/objects/#ramstatus","text":"The status of the production of an item, for a specific step. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"completionRatio\": 50, // % \"user\": \"RamUser-uuid\", // The last user who's modified the status \"step\": \"RamStep-uuid\", \"item\": \"RamItem-uuid or RamShot-uuid or RamAsset-uuid\", \"itemType\": \"asset\", // One of asset or shot or item \"state\": \"RamState-uuid\", \"version\": 12, \"date\": \"2022-09-15 13:00:00 \", // The modification date of the status \"published\": true, // Is this item ready to be used in another step? \"assignedUser\": \"RamUser-uuid\", // Who's working on this? \"timeSpent\": 3600, // Seconds \"difficulty\": \"medium\", // One of: veryEasy, easy, medium, hard, veryHard \"goal\": 3 // How long this shoud take, in days }","title":"RamStatus"},{"location":"dev/objects/#ramstep","text":"A step in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"estimationMultiplyGroup\": \"RamAssetGroup-uuid\", // Used to estimate time for shots \"type\": \"shot\", // One of pre, asset, shot, post, all \"publishSettings\": \"- format: ext\", // Some settings to be used by an application to publish files. Should be a YAML-formatted string \"estimationMethod\": \"shot\", // Pne of shot, second. Estimate work per shot or per second \"estimationVeryEasy\": 0.1, // days \"estimationEasy\": 0.5, \"estimationMedium\": 1, \"estimationHard\": 2, \"estimationVeryHard\": 5 }","title":"RamStep"},{"location":"dev/objects/#ramuser","text":"A user of Ramses. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"role\": \"lead\", // One of admin, project, lead, standard, \"schedule\": \"RamScheduleEntry_list-uuid\", \"email\": \"contact@rxlaboratory.org\" } Note User data is encrypted in databases saved by the Ramses Application and Ramses Server to protect user privacy. Extensions (scripts, APIs, etc) should never write user data to any file, unless it is safely encrypted too. The email should be used for technical features, like password retrieval, but never be available to other users.","title":"RamUser"},{"location":"dev/add-ons-reference/","text":"Scripting API reference RxLaboratory provides a reference implementation of the API in Python and Adobe ExtendScript . Other APIs may be developped, in which case all these APIs on all programming/scripting language should implement this reference, with the same classes, attributes and methods. As this document is referring to different scripting languages, it uses general terms which may be different than what is actually used in specific languages. (TODO: ADD THE LINK TO THE GITHUB REPOS OF THE APIs / LINK TO GET THEM ON RXLAB.ORG) Hint Some of the elements described in this documentation have to be interpreted differently depending on the language used in the implementations of the Ramses Add-ons API and may vary a bit. Read the examples below to see the differences between a few scripting languages. Classes This is the comprehensive list of available classes. In the Ramses Add-ons API , everything is contained in these classes. Class Inheritance Description Ramses The main class. One (and only one) instance globally available, instantiated during init time. RamAsset RamItem An asset. RamDaemonInterface The Class used to communicate with the Ramses Daemon RamFileManager Generic tools to handle files and the Ramses Naming Scheme RamFileType A File type (name and possible extensions) RamItem RamObject The base class for Shots and Assets. RamMetaDataManager A Class to get/set metadata from files. RamFileInfo A Class to handle ramses (file)names. RamObject The base class for most of Ramses objects. RamPipe A pipe which connects two steps together in the production pipeline RamPipeFile The description of a file type going through a pipe RamProject RamObject A project handled by Ramses. Projects contains general items, assets and shots. RamSettings Gets and saves settings used by Ramses. RamShot RamItem A shot. RamState RamObject The state of a step (like \u201cWaiting for approval\u201d, \u201cApproved\u201d, etc.). RamStatus A state associated to a comment, the user who changed the state, etc. RamStep RamObject A step in the production of the shots or assets of the project. RamUser RamObject The class representing users. Global Methods Method Arguments Description log string : message , LogLevel : level = LogLevel.Info Logs a message to the console. The level must be one of LogLevel.DataReceived , LogLevel.DataSent , LogLevel.Debug , LogLevel.Info , LogLevel.Critical , LogLevel.Fatal printException To be used in an except statement in Python or a catch statement in JavaScript . In JavaScript the error must be passed as an argument. Logs the exception to the console. Examples Here are a few examples showing how this API can be used. Include / Import the API # Python # Use your usual preferred way to import the module. from ramses import * # The unique `Ramses` instance is available as `Ramses.instance()`. myRamses = Ramses.instance() theSettings = myRamses.settings myShot = RamShot.getFromPath(\"path/to/the/shot\") aNewStatus = RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ) myShot.setStatus(aNewStatus, myRamses.currentStep()) # or (this is the recommended way) import ramses as ram myRamses = ram.Ramses.instance() theSettings = myRamses.settings() myShot = ram.RamShot.getFromPath(\"path/to/the/shot\") aNewStatus = ram.RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ) myShot.setStatus(aNewStatus, myRamses.currentStep()) // ExtendScript // Just include the file the usual way. #include ramses.jsxinc // The unique `Ramses` instance is available as `Ramses.instance()`. var myRamses = Ramses.instance(); var theSettings = myRamses.settings(); var myShot = RamShot.getFromPath(\"path/to/the/shot\"); var aNewStatus = new RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ); myShot.setStatus(aNewStatus, myRamses.currentStep()); Enumerated values (constants) Enumerated values (a.k.a. Constants) are predefined sets of values to be used in specific methods. Their name is in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple Color.RED, or Shape.RECTANGLE). The value itself can be of any type (array, string, number\u2026). In this documentation they\u2019re written like this: ValueType.VALUE , i.e. ItemType.SHOT or ItemType.ASSET , and they\u2019re used the same way in the actual code. # Python from ramses import RamItem, ItemType # Get an item from a specific file path anItem = RamItem.getFromPath( somePath ) if anItem is not None: # We want it only if it's a shot, # We can use the enum ItemType to compare the value. if anItem.itemType() == ItemType.SHOT: doSomething() // ExtendScript #include ramses.jsxinc // Get an item from a specific file path var anItem = RamItem.getFromPath( somePath ); if (anItem != null) { // We want it only if it's a shot, // We can use the enum ItemType to compare the value. if ( anItem.itemType() == ItemType.SHOT ) doSomething(); } Save command for Maya (Python) This example shows how to use the RamFileManager class to implement a save command in Maya with automatic backup in the _versions subfolder. import maya.cmds as cmds import ramses as ram ramses = ram.Ramses.instance() settings = ram.RamSettings.instance() def ramSave(): # The current maya file currentFilePath = cmds.file( q=True, sn=True ) ram.log(\"Saving file: \" + currentFilePath) # Check if the Daemon is available, if Ramses is set to be used \"online\" if settings.online: if not ramses.connect(): cmds.confirmDialog( title=\"No User\", message=\"You must log in Ramses first!\", button=[\"OK\"], icon=\"warning\" ) ramses.showClient() cmds.error( \"User not available: You must log in Ramses first!\" ) return # Get the save path (Ramses will check if the current file has to be renamed to respect the Ramses Tree and Naming Scheme) saveFilePath = ram.RamFileManager.getSaveFilePath( currentFilePath ) if not saveFilePath: # Ramses may return None if the current file name does not respeect the Ramses Naming Scheme cmds.warning( ram.Log.MalformedName ) # Set file to be renamed cmds.file( renameToSave = True ) cmds.inViewMessage( msg='Malformed Ramses file name! <hl>Please save with a correct name first</hl>.', pos='midCenter', fade=True ) return # If the current Maya file is inside a preview/publish/version subfolder, we're going to increment # to be sure not to lose the previous working file. increment = False if ram.RamFileManager.inReservedFolder( currentFilePath ): increment = True cmds.warning( \"Incremented and Saved as \" + saveFilePath ) # Set the save name and save cmds.file( rename = saveFilePath ) cmds.file( save=True, options=\"v=1;\" ) # Backup / Increment backupFilePath = ram.RamFileManager.copyToVersion( saveFilePath, increment=increment ) backupFileName = os.path.basename( backupFilePath ) decomposedFileName = ram.RamFileManager.decomposeRamsesFileName( backupFileName ) newVersion = str( decomposedFileName['version'] ) ram.log( \"Scene saved! Current version is: \" + newVersion ) cmds.inViewMessage( msg='Scene saved! <hl>v' + newVersion + '</hl>', pos='midCenter', fade=True ) ramSave()","title":"Reference"},{"location":"dev/add-ons-reference/#scripting-api-reference","text":"RxLaboratory provides a reference implementation of the API in Python and Adobe ExtendScript . Other APIs may be developped, in which case all these APIs on all programming/scripting language should implement this reference, with the same classes, attributes and methods. As this document is referring to different scripting languages, it uses general terms which may be different than what is actually used in specific languages. (TODO: ADD THE LINK TO THE GITHUB REPOS OF THE APIs / LINK TO GET THEM ON RXLAB.ORG) Hint Some of the elements described in this documentation have to be interpreted differently depending on the language used in the implementations of the Ramses Add-ons API and may vary a bit. Read the examples below to see the differences between a few scripting languages.","title":"Scripting API reference"},{"location":"dev/add-ons-reference/#classes","text":"This is the comprehensive list of available classes. In the Ramses Add-ons API , everything is contained in these classes. Class Inheritance Description Ramses The main class. One (and only one) instance globally available, instantiated during init time. RamAsset RamItem An asset. RamDaemonInterface The Class used to communicate with the Ramses Daemon RamFileManager Generic tools to handle files and the Ramses Naming Scheme RamFileType A File type (name and possible extensions) RamItem RamObject The base class for Shots and Assets. RamMetaDataManager A Class to get/set metadata from files. RamFileInfo A Class to handle ramses (file)names. RamObject The base class for most of Ramses objects. RamPipe A pipe which connects two steps together in the production pipeline RamPipeFile The description of a file type going through a pipe RamProject RamObject A project handled by Ramses. Projects contains general items, assets and shots. RamSettings Gets and saves settings used by Ramses. RamShot RamItem A shot. RamState RamObject The state of a step (like \u201cWaiting for approval\u201d, \u201cApproved\u201d, etc.). RamStatus A state associated to a comment, the user who changed the state, etc. RamStep RamObject A step in the production of the shots or assets of the project. RamUser RamObject The class representing users.","title":"Classes"},{"location":"dev/add-ons-reference/#global-methods","text":"Method Arguments Description log string : message , LogLevel : level = LogLevel.Info Logs a message to the console. The level must be one of LogLevel.DataReceived , LogLevel.DataSent , LogLevel.Debug , LogLevel.Info , LogLevel.Critical , LogLevel.Fatal printException To be used in an except statement in Python or a catch statement in JavaScript . In JavaScript the error must be passed as an argument. Logs the exception to the console.","title":"Global Methods"},{"location":"dev/add-ons-reference/#examples","text":"Here are a few examples showing how this API can be used.","title":"Examples"},{"location":"dev/add-ons-reference/#include-import-the-api","text":"# Python # Use your usual preferred way to import the module. from ramses import * # The unique `Ramses` instance is available as `Ramses.instance()`. myRamses = Ramses.instance() theSettings = myRamses.settings myShot = RamShot.getFromPath(\"path/to/the/shot\") aNewStatus = RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ) myShot.setStatus(aNewStatus, myRamses.currentStep()) # or (this is the recommended way) import ramses as ram myRamses = ram.Ramses.instance() theSettings = myRamses.settings() myShot = ram.RamShot.getFromPath(\"path/to/the/shot\") aNewStatus = ram.RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ) myShot.setStatus(aNewStatus, myRamses.currentStep()) // ExtendScript // Just include the file the usual way. #include ramses.jsxinc // The unique `Ramses` instance is available as `Ramses.instance()`. var myRamses = Ramses.instance(); var theSettings = myRamses.settings(); var myShot = RamShot.getFromPath(\"path/to/the/shot\"); var aNewStatus = new RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ); myShot.setStatus(aNewStatus, myRamses.currentStep());","title":"Include / Import the API"},{"location":"dev/add-ons-reference/#enumerated-values-constants","text":"Enumerated values (a.k.a. Constants) are predefined sets of values to be used in specific methods. Their name is in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple Color.RED, or Shape.RECTANGLE). The value itself can be of any type (array, string, number\u2026). In this documentation they\u2019re written like this: ValueType.VALUE , i.e. ItemType.SHOT or ItemType.ASSET , and they\u2019re used the same way in the actual code. # Python from ramses import RamItem, ItemType # Get an item from a specific file path anItem = RamItem.getFromPath( somePath ) if anItem is not None: # We want it only if it's a shot, # We can use the enum ItemType to compare the value. if anItem.itemType() == ItemType.SHOT: doSomething() // ExtendScript #include ramses.jsxinc // Get an item from a specific file path var anItem = RamItem.getFromPath( somePath ); if (anItem != null) { // We want it only if it's a shot, // We can use the enum ItemType to compare the value. if ( anItem.itemType() == ItemType.SHOT ) doSomething(); }","title":"Enumerated values (constants)"},{"location":"dev/add-ons-reference/#save-command-for-maya-python","text":"This example shows how to use the RamFileManager class to implement a save command in Maya with automatic backup in the _versions subfolder. import maya.cmds as cmds import ramses as ram ramses = ram.Ramses.instance() settings = ram.RamSettings.instance() def ramSave(): # The current maya file currentFilePath = cmds.file( q=True, sn=True ) ram.log(\"Saving file: \" + currentFilePath) # Check if the Daemon is available, if Ramses is set to be used \"online\" if settings.online: if not ramses.connect(): cmds.confirmDialog( title=\"No User\", message=\"You must log in Ramses first!\", button=[\"OK\"], icon=\"warning\" ) ramses.showClient() cmds.error( \"User not available: You must log in Ramses first!\" ) return # Get the save path (Ramses will check if the current file has to be renamed to respect the Ramses Tree and Naming Scheme) saveFilePath = ram.RamFileManager.getSaveFilePath( currentFilePath ) if not saveFilePath: # Ramses may return None if the current file name does not respeect the Ramses Naming Scheme cmds.warning( ram.Log.MalformedName ) # Set file to be renamed cmds.file( renameToSave = True ) cmds.inViewMessage( msg='Malformed Ramses file name! <hl>Please save with a correct name first</hl>.', pos='midCenter', fade=True ) return # If the current Maya file is inside a preview/publish/version subfolder, we're going to increment # to be sure not to lose the previous working file. increment = False if ram.RamFileManager.inReservedFolder( currentFilePath ): increment = True cmds.warning( \"Incremented and Saved as \" + saveFilePath ) # Set the save name and save cmds.file( rename = saveFilePath ) cmds.file( save=True, options=\"v=1;\" ) # Backup / Increment backupFilePath = ram.RamFileManager.copyToVersion( saveFilePath, increment=increment ) backupFileName = os.path.basename( backupFilePath ) decomposedFileName = ram.RamFileManager.decomposeRamsesFileName( backupFileName ) newVersion = str( decomposedFileName['version'] ) ram.log( \"Scene saved! Current version is: \" + newVersion ) cmds.inViewMessage( msg='Scene saved! <hl>v' + newVersion + '</hl>', pos='midCenter', fade=True ) ramSave()","title":"Save command for Maya (Python)"},{"location":"dev/add-ons-reference/enum/","text":"Enumerated values (constants) Enumerated values (a.k.a. Constants) are predefined sets of values to be used in specific methods. Their name should be in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple Color.RED , or Shape.RECTANGLE ). The value itself can be of any type (array, string, number\u2026). In this documentation they\u2019re written like this: ValueType.VALUE , i.e. ItemType.SHOT or ItemType.ASSET , and they\u2019re used the same way in the actual code. Warning For the current 0.x versions of the framework, not all enumerated values respect the naming CAPITAL_SNAKE_CASE convention. This will change before the release of 1.0; when using the API during the 0.x development phase, be careful when updating as you may need to rename these values in your code. This reference will be kept up-to-date in real time. FileNames The names of some files reserved by Ramses . Name Actual value Description FileNames. META_DATA \"_ramses_data.json\" FolderNames The names of the folders used by the Ramses Tree . Name Actual value Description FolderNames. admin \"00-ADMIN\" FolderNames. assets \"04-ASSETS FolderNames. export \"06-EXPORT FolderNames. postProd 03-POST-PROD\" FolderNames. preProd \"01-PRE-PROD\" FolderNames. preview \"_preview\" FolderNames. prod \"02-PROD\" FolderNames. projects \"Projects\" FolderNames. publish \"_published\" FolderNames. shots \"05-SHOTS\" FolderNames. config \"Config\" FolderNames. users \"Users\" FolderNames. versions \"_versions\" ItemType Used to differenciate between Shots, Assets, and General items. Name Actual value Description ItemType. ASSET 'A' ItemType. GENERAL 'G' ItemType. SHOT 'S' Log A list of messages to be logged / shown to the user. Name Actual value Description Log. MalformedName \"Cannot work on this file as it does not respect the Ramses' naming scheme, sorry.\" Log. NoProject \"There's no current project. Select a project first.\" Log. NotAnItem \"This file does not seem to be a valid Ramses Item, sorry.\" Log. NoUser \"There's no current user. You may need to log in.\" Log. PathNotFound \"The file or folder path could not be found.\" Log. StateNotFound \"State not found.\" LogLevel Importance of the log messages. The API itself should not log any LogLevel.Info , this level is reserved for the add-ons developped using the API. Name Actual value Description LogLevel. DataReceived -2 The raw data received from the Daemon LogLevel. DataSent -1 The queries sent to the Daemon LogLevel. Debug 0 General debug information LogLevel. Info 1 General information to be shown to the user LogLevel. Critical 2 An non-blocking error LogLevel. Fatal 3 A fatal error MetaDataKeys The available predefined keys to store file metadata. Name Actual value Description MetaDataKeys. COMMENT \"comment\" A comment associated to the file MetaDataKeys. DATE \"date\" A date for the file MetaDataKeys. MODIFICATION_HISTORY \"history\" The list of all modification dates MetaDataKeys. PIPE_TYPE \"pipeFileShortName\" The type of the pipe associated to the file MetaDataKeys. STATE \"stateShortName\" A version file associated to the file MetaDataKeys. VERSION \"version\" A version associated to the file MetaDataKeys. VERSION_FILE \"versionFilePath\" A version file associated to the file StepType The type of a step. Usually used to filter available steps. Name Value Description StepType. PRE_PRODUCTION 'PRE_PRODUCTION' StepType. ASSET_PRODUCTION 'ASSET_PRODUCTION' StepType. SHOT_PRODUCTION 'SHOT_PRODUCTION' StepType. POST_PRODUCTION 'POST_PRODUCTION' StepType. PRODUCTION 'PRODUCTION' Use for ASSET and SHOT production together. StepType. ALL 'ALL' Use for all steps. UserRole The role of the user (i.e. its administration rights). Name Value Description UserRole. ADMIN 3 UserRole. PROJECT_ADMIN 2 UserRole. LEAD 1 UserRole. STANDARD 0 Examples # Python from ramses import RamItem, ItemType # Get an item from a specific file path anItem = RamItem.getFromPath( somePath ) if anItem is not None: # We want it only if it's a shot, # We can use the enum ItemType to compare the value. if anItem.itemType() == ItemType.SHOT: doSomething() // ExtendScript #include ramses.jsxinc // Get an item from a specific file path var anItem = RamItem.getFromPath( somePath ); if (anItem != null) { // We want it only if it's a shot, // We can use the enum ItemType to compare the value. if ( anItem.itemType() == ItemType.SHOT ) doSomething(); }","title":"Constants"},{"location":"dev/add-ons-reference/enum/#enumerated-values-constants","text":"Enumerated values (a.k.a. Constants) are predefined sets of values to be used in specific methods. Their name should be in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple Color.RED , or Shape.RECTANGLE ). The value itself can be of any type (array, string, number\u2026). In this documentation they\u2019re written like this: ValueType.VALUE , i.e. ItemType.SHOT or ItemType.ASSET , and they\u2019re used the same way in the actual code. Warning For the current 0.x versions of the framework, not all enumerated values respect the naming CAPITAL_SNAKE_CASE convention. This will change before the release of 1.0; when using the API during the 0.x development phase, be careful when updating as you may need to rename these values in your code. This reference will be kept up-to-date in real time.","title":"Enumerated values (constants)"},{"location":"dev/add-ons-reference/enum/#filenames","text":"The names of some files reserved by Ramses . Name Actual value Description FileNames. META_DATA \"_ramses_data.json\"","title":"FileNames"},{"location":"dev/add-ons-reference/enum/#foldernames","text":"The names of the folders used by the Ramses Tree . Name Actual value Description FolderNames. admin \"00-ADMIN\" FolderNames. assets \"04-ASSETS FolderNames. export \"06-EXPORT FolderNames. postProd 03-POST-PROD\" FolderNames. preProd \"01-PRE-PROD\" FolderNames. preview \"_preview\" FolderNames. prod \"02-PROD\" FolderNames. projects \"Projects\" FolderNames. publish \"_published\" FolderNames. shots \"05-SHOTS\" FolderNames. config \"Config\" FolderNames. users \"Users\" FolderNames. versions \"_versions\"","title":"FolderNames"},{"location":"dev/add-ons-reference/enum/#itemtype","text":"Used to differenciate between Shots, Assets, and General items. Name Actual value Description ItemType. ASSET 'A' ItemType. GENERAL 'G' ItemType. SHOT 'S'","title":"ItemType"},{"location":"dev/add-ons-reference/enum/#log","text":"A list of messages to be logged / shown to the user. Name Actual value Description Log. MalformedName \"Cannot work on this file as it does not respect the Ramses' naming scheme, sorry.\" Log. NoProject \"There's no current project. Select a project first.\" Log. NotAnItem \"This file does not seem to be a valid Ramses Item, sorry.\" Log. NoUser \"There's no current user. You may need to log in.\" Log. PathNotFound \"The file or folder path could not be found.\" Log. StateNotFound \"State not found.\"","title":"Log"},{"location":"dev/add-ons-reference/enum/#loglevel","text":"Importance of the log messages. The API itself should not log any LogLevel.Info , this level is reserved for the add-ons developped using the API. Name Actual value Description LogLevel. DataReceived -2 The raw data received from the Daemon LogLevel. DataSent -1 The queries sent to the Daemon LogLevel. Debug 0 General debug information LogLevel. Info 1 General information to be shown to the user LogLevel. Critical 2 An non-blocking error LogLevel. Fatal 3 A fatal error","title":"LogLevel"},{"location":"dev/add-ons-reference/enum/#metadatakeys","text":"The available predefined keys to store file metadata. Name Actual value Description MetaDataKeys. COMMENT \"comment\" A comment associated to the file MetaDataKeys. DATE \"date\" A date for the file MetaDataKeys. MODIFICATION_HISTORY \"history\" The list of all modification dates MetaDataKeys. PIPE_TYPE \"pipeFileShortName\" The type of the pipe associated to the file MetaDataKeys. STATE \"stateShortName\" A version file associated to the file MetaDataKeys. VERSION \"version\" A version associated to the file MetaDataKeys. VERSION_FILE \"versionFilePath\" A version file associated to the file","title":"MetaDataKeys"},{"location":"dev/add-ons-reference/enum/#steptype","text":"The type of a step. Usually used to filter available steps. Name Value Description StepType. PRE_PRODUCTION 'PRE_PRODUCTION' StepType. ASSET_PRODUCTION 'ASSET_PRODUCTION' StepType. SHOT_PRODUCTION 'SHOT_PRODUCTION' StepType. POST_PRODUCTION 'POST_PRODUCTION' StepType. PRODUCTION 'PRODUCTION' Use for ASSET and SHOT production together. StepType. ALL 'ALL' Use for all steps.","title":"StepType"},{"location":"dev/add-ons-reference/enum/#userrole","text":"The role of the user (i.e. its administration rights). Name Value Description UserRole. ADMIN 3 UserRole. PROJECT_ADMIN 2 UserRole. LEAD 1 UserRole. STANDARD 0","title":"UserRole"},{"location":"dev/add-ons-reference/enum/#examples","text":"# Python from ramses import RamItem, ItemType # Get an item from a specific file path anItem = RamItem.getFromPath( somePath ) if anItem is not None: # We want it only if it's a shot, # We can use the enum ItemType to compare the value. if anItem.itemType() == ItemType.SHOT: doSomething() // ExtendScript #include ramses.jsxinc // Get an item from a specific file path var anItem = RamItem.getFromPath( somePath ); if (anItem != null) { // We want it only if it's a shot, // We can use the enum ItemType to compare the value. if ( anItem.itemType() == ItemType.SHOT ) doSomething(); }","title":"Examples"},{"location":"dev/add-ons-reference/implementation/","text":"Implementation / API Dev notes Note This section is for the development of the low-level API only; you should not need these notes when developping your own add-on using the API. Hint Some of the elements described in this documentation have to be interpreted depending on the language used in the implementations of the Ramses API and may vary a bit. Enumerated Values Enumerated values (a.k.a. Constants ) are predefined sets of values to be used in specific methods. Their name is in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple color.RED , or shape.RECTANGLE ). The value itself can be of any type (array, string, number\u2026). # Python # Enumerated values are public static attributes of a containing class. They're declared like this: class Group(): VALUE_1 = 0 VALUE_2 = 1 VALUE_3 = 2 # Example: class Color(): RED = [255,0,0] GREEN = [0,255,0] BLUE = [0,0,255] // ExtendScript // Enumerated values are attributes in simple objects. They're declared like this: var Group = { VALUE_1: 0, VALUE_2: 1, VALUE_3: 2 }; // Example: var Color = { RED: [255,0,0], GREEN: [0,255,0], BLUE: [0,0,255] }; Accessing the data In All \u201c RamClasses \u201d, most of the data is retrieved with methods (instead of accessing it directly from an attribute). This allows the API to get and set the data from the Daemon , if and only if Ramses.instance().online is true . Some instances of these classes can be virtual . A virtual instance is an object which is not stored in the database; it\u2019s meant to be temporary. In this case, the data can be set by the API itself and is not retrieved nor updated with the Daemon . There is also a cache system, to prevent having too many calls to the Daemon and improve performance. The Daemon is called if and only if the data stored in the object is more than two second old. That means subsequent calls to the data in a single process should result to a single call to the Daemon . Here are example concepts in Python and ExtendScript, like what\u2019s done in the provided implementations of the Ramses Add-ons API. # Python DAEMON = RamDaemonInterface.instance() class RamClass( object ): # The data can be passed to the constructor. def __init__( self, uuid=\"\", data = None, virtual=True, objectType=\"RamObject\" ): \"\"\" Args: uuid (str): The object's uuid \"\"\" if uuid == \"\" and virtual: self.__virtual = True else: self.__virtual = False if uuid == \"\": uuid = str(UUID.uuid4()) self.__uuid = uuid if isinstance(data, str): data = json.loads(data) if data: self.__data = data self.__cacheTime = time.time() else: self.__data = {} self.__cacheTime = 0 if not virtual: reply = DAEMON.create( self.__uuid, self.__data, objectType ) if not DAEMON.checkReply(reply): log(\"I can't create this object.\") def uuid( self ): return self.__uuid def data( self ): \"\"\"Gets the data for this object\"\"\" if self.__virtual: return self.__data # Check if the cached data is recent enough # there's a 2-second timeout to not post too many queries # and improve performance cacheElapsed = time.time() - self.__cacheTime if self.__data and cacheElapsed < 2: return self.__data # Get the data from the daemon data = DAEMON.getData( self.__uuid ) if data: self.__data = data self.__cacheTime = time.time() return self.__data def setData( self, data): if isinstance(data, str): data = json.loads(data) self.__data = data if not self.__virtual: DAEMON.setData( self.__uuid, data ) def get(self, key, default = None): \"\"\"Get a specific value in the data\"\"\" data = self.data() return data.get(key, default) def name( self ): \"\"\" Returns: str \"\"\" return self.get('name', 'Unknown Object')","title":"Dev Notes"},{"location":"dev/add-ons-reference/implementation/#implementation-api-dev-notes","text":"Note This section is for the development of the low-level API only; you should not need these notes when developping your own add-on using the API. Hint Some of the elements described in this documentation have to be interpreted depending on the language used in the implementations of the Ramses API and may vary a bit.","title":"Implementation / API Dev notes"},{"location":"dev/add-ons-reference/implementation/#enumerated-values","text":"Enumerated values (a.k.a. Constants ) are predefined sets of values to be used in specific methods. Their name is in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple color.RED , or shape.RECTANGLE ). The value itself can be of any type (array, string, number\u2026). # Python # Enumerated values are public static attributes of a containing class. They're declared like this: class Group(): VALUE_1 = 0 VALUE_2 = 1 VALUE_3 = 2 # Example: class Color(): RED = [255,0,0] GREEN = [0,255,0] BLUE = [0,0,255] // ExtendScript // Enumerated values are attributes in simple objects. They're declared like this: var Group = { VALUE_1: 0, VALUE_2: 1, VALUE_3: 2 }; // Example: var Color = { RED: [255,0,0], GREEN: [0,255,0], BLUE: [0,0,255] };","title":"Enumerated Values"},{"location":"dev/add-ons-reference/implementation/#accessing-the-data","text":"In All \u201c RamClasses \u201d, most of the data is retrieved with methods (instead of accessing it directly from an attribute). This allows the API to get and set the data from the Daemon , if and only if Ramses.instance().online is true . Some instances of these classes can be virtual . A virtual instance is an object which is not stored in the database; it\u2019s meant to be temporary. In this case, the data can be set by the API itself and is not retrieved nor updated with the Daemon . There is also a cache system, to prevent having too many calls to the Daemon and improve performance. The Daemon is called if and only if the data stored in the object is more than two second old. That means subsequent calls to the data in a single process should result to a single call to the Daemon . Here are example concepts in Python and ExtendScript, like what\u2019s done in the provided implementations of the Ramses Add-ons API. # Python DAEMON = RamDaemonInterface.instance() class RamClass( object ): # The data can be passed to the constructor. def __init__( self, uuid=\"\", data = None, virtual=True, objectType=\"RamObject\" ): \"\"\" Args: uuid (str): The object's uuid \"\"\" if uuid == \"\" and virtual: self.__virtual = True else: self.__virtual = False if uuid == \"\": uuid = str(UUID.uuid4()) self.__uuid = uuid if isinstance(data, str): data = json.loads(data) if data: self.__data = data self.__cacheTime = time.time() else: self.__data = {} self.__cacheTime = 0 if not virtual: reply = DAEMON.create( self.__uuid, self.__data, objectType ) if not DAEMON.checkReply(reply): log(\"I can't create this object.\") def uuid( self ): return self.__uuid def data( self ): \"\"\"Gets the data for this object\"\"\" if self.__virtual: return self.__data # Check if the cached data is recent enough # there's a 2-second timeout to not post too many queries # and improve performance cacheElapsed = time.time() - self.__cacheTime if self.__data and cacheElapsed < 2: return self.__data # Get the data from the daemon data = DAEMON.getData( self.__uuid ) if data: self.__data = data self.__cacheTime = time.time() return self.__data def setData( self, data): if isinstance(data, str): data = json.loads(data) self.__data = data if not self.__virtual: DAEMON.setData( self.__uuid, data ) def get(self, key, default = None): \"\"\"Get a specific value in the data\"\"\" data = self.data() return data.get(key, default) def name( self ): \"\"\" Returns: str \"\"\" return self.get('name', 'Unknown Object')","title":"Accessing the data"},{"location":"dev/add-ons-reference/ram_asset/","text":"RamAsset A class representing an asset. Inherits object \u25ba RamObject \u25ba RamItem \u25ba RamAsset Static Methods Method Arguments Description fromPath \u25b9 RamAsset string : folderPath Returns a RamAsset instance built using the given path. The path can be any file or folder path from the asset (a version file, a preview file, etc) Methods Method Arguments Description tags \u25b9 list of string Some tags describing the asset. An empty string if the Daemon is not available. group \u25b9 string The name of the group containing this asset. assetGroup \u25b9 RamAssetGroup The group containing this asset.","title":"RamAsset"},{"location":"dev/add-ons-reference/ram_asset/#ramasset","text":"A class representing an asset. Inherits object \u25ba RamObject \u25ba RamItem \u25ba RamAsset","title":"RamAsset"},{"location":"dev/add-ons-reference/ram_asset/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamAsset string : folderPath Returns a RamAsset instance built using the given path. The path can be any file or folder path from the asset (a version file, a preview file, etc)","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_asset/#methods","text":"Method Arguments Description tags \u25b9 list of string Some tags describing the asset. An empty string if the Daemon is not available. group \u25b9 string The name of the group containing this asset. assetGroup \u25b9 RamAssetGroup The group containing this asset.","title":"Methods"},{"location":"dev/add-ons-reference/ram_assetgroup/","text":"RamAssetGroup A group of assets. Inherits object \u25ba RamObject \u25ba RamAssetGroup Static Methods Method Arguments Description fromPath \u25b9 RamAssetGroup or None string : fileOrFolderPath The path can be any file or folder path from inside the group (a version file, a preview file, etc). Methods Method Arguments Description project \u25b9 RamProject The project containing this group.","title":"RamAssetGroup"},{"location":"dev/add-ons-reference/ram_assetgroup/#ramassetgroup","text":"A group of assets. Inherits object \u25ba RamObject \u25ba RamAssetGroup","title":"RamAssetGroup"},{"location":"dev/add-ons-reference/ram_assetgroup/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamAssetGroup or None string : fileOrFolderPath The path can be any file or folder path from inside the group (a version file, a preview file, etc).","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_assetgroup/#methods","text":"Method Arguments Description project \u25b9 RamProject The project containing this group.","title":"Methods"},{"location":"dev/add-ons-reference/ram_daemon_interface/","text":"RamDaemonInterface This is a low-level Class used to communicate with the Ramses Daemon. This is a simple wrapper for the Daemon API . One (and only one) instance is globally available (RamDaemonInterface is a singleton ), by calling RamDaemonInterface.instance() or Ramses.instance().daemonInterface() . Note You should not need this class as all communications are automatically handled by the other classes. Static Methods Method Arguments Description Dev Notes instance \u25b9 RamDaemonInterface Returns the RamDaemonInterface unique instance. checkReply \u25b9 boolean dict : reply Checks if the reply returned by a RamDaemonInterface instance is accepted, successful and has some content. Methods Please refer to the Daemon API reference for more information about these methods. These methods return the reply of the Daemon converted from JSON to an object, dict, structure, or whatever best suits the language in which the add-on is implemented. This returned object can be converted to a RamObject instance using the corresponding RamObject.fromDict() static method. Method Arguments Description Dev Notes create \u25b9 Object / Dict \u2022 string : uuid \u2022 string or Object/ Dict : data \u2022 string : objectType Creates a new object, with the given data getCurrentProject \u25b9 RamProject or None Gets the current project getCurrentUser \u25b9 RamUser or None Gets the current user getData \u25b9 Object / Dict \u2022 string : uuid Gets the data of a specific RamObject . getObjects \u25b9 list of RamObject \u2022 string : objectType Gets the list of objects of a given type. The returned class type depends on the type of object and may be a derived class of RamObject . getPath \u25b9 string \u2022 string : uuid Gets the path for a specific object. getProjects \u25b9 list of RamProject Gets the list of available projects (for the current user) getRamsesFolderPath \u25b9 string Gets the main Ramses folder containing projects, config files, user files\u2026 online \u25b9 boolean True if the Daemon is available ping \u25b9 Object / Dict Gets the version and current user of the Ramses Daemon raiseWindow Raises the Ramses Application main window setCurrentProject \u25b9 Object / Dict \u2022 string : uuid Sets the current project setData \u25b9 Object / Dict \u2022 string : uuid \u2022 string or Object/ Dict : data Sets the data for a specific RamObject . uuidFromPath \u25b9 string \u2022 string : path \u2022 string : type = \"RamObject\" Gets the UUID of a RamObject using its path. Examples # Python daemon = RamDaemonInterface.instance() reply = daemon.getProjects() # Call from the instance if RamDaemonInterface.checkReply(reply): # Call from the class, it's a static method doSomething(reply['content']) else: print (reply['message']) // JavaScript var daemon = RamDaemonInterface.instance(); var reply = daemon.getProjects(); // Call from the instance if ( RamDaemonInterface.checkReply(reply) ) { // Call from the class, it's a static method doSomething(reply['content']); } else { alert (reply['message']); } Implementation Python In Python, the methods from this class return a dict as constructed from the JSON reply of the Daemon using the standard json.loads( str ) method. JavaScript / ExtendScript In JS, the methods from this class return a standard JS object as constructed from the JSON reply of the Daemon using the standard json2 library.","title":"RamDaemonInterface"},{"location":"dev/add-ons-reference/ram_daemon_interface/#ramdaemoninterface","text":"This is a low-level Class used to communicate with the Ramses Daemon. This is a simple wrapper for the Daemon API . One (and only one) instance is globally available (RamDaemonInterface is a singleton ), by calling RamDaemonInterface.instance() or Ramses.instance().daemonInterface() . Note You should not need this class as all communications are automatically handled by the other classes.","title":"RamDaemonInterface"},{"location":"dev/add-ons-reference/ram_daemon_interface/#static-methods","text":"Method Arguments Description Dev Notes instance \u25b9 RamDaemonInterface Returns the RamDaemonInterface unique instance. checkReply \u25b9 boolean dict : reply Checks if the reply returned by a RamDaemonInterface instance is accepted, successful and has some content.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_daemon_interface/#methods","text":"Please refer to the Daemon API reference for more information about these methods. These methods return the reply of the Daemon converted from JSON to an object, dict, structure, or whatever best suits the language in which the add-on is implemented. This returned object can be converted to a RamObject instance using the corresponding RamObject.fromDict() static method. Method Arguments Description Dev Notes create \u25b9 Object / Dict \u2022 string : uuid \u2022 string or Object/ Dict : data \u2022 string : objectType Creates a new object, with the given data getCurrentProject \u25b9 RamProject or None Gets the current project getCurrentUser \u25b9 RamUser or None Gets the current user getData \u25b9 Object / Dict \u2022 string : uuid Gets the data of a specific RamObject . getObjects \u25b9 list of RamObject \u2022 string : objectType Gets the list of objects of a given type. The returned class type depends on the type of object and may be a derived class of RamObject . getPath \u25b9 string \u2022 string : uuid Gets the path for a specific object. getProjects \u25b9 list of RamProject Gets the list of available projects (for the current user) getRamsesFolderPath \u25b9 string Gets the main Ramses folder containing projects, config files, user files\u2026 online \u25b9 boolean True if the Daemon is available ping \u25b9 Object / Dict Gets the version and current user of the Ramses Daemon raiseWindow Raises the Ramses Application main window setCurrentProject \u25b9 Object / Dict \u2022 string : uuid Sets the current project setData \u25b9 Object / Dict \u2022 string : uuid \u2022 string or Object/ Dict : data Sets the data for a specific RamObject . uuidFromPath \u25b9 string \u2022 string : path \u2022 string : type = \"RamObject\" Gets the UUID of a RamObject using its path.","title":"Methods"},{"location":"dev/add-ons-reference/ram_daemon_interface/#examples","text":"# Python daemon = RamDaemonInterface.instance() reply = daemon.getProjects() # Call from the instance if RamDaemonInterface.checkReply(reply): # Call from the class, it's a static method doSomething(reply['content']) else: print (reply['message']) // JavaScript var daemon = RamDaemonInterface.instance(); var reply = daemon.getProjects(); // Call from the instance if ( RamDaemonInterface.checkReply(reply) ) { // Call from the class, it's a static method doSomething(reply['content']); } else { alert (reply['message']); }","title":"Examples"},{"location":"dev/add-ons-reference/ram_daemon_interface/#implementation","text":"","title":"Implementation"},{"location":"dev/add-ons-reference/ram_daemon_interface/#python","text":"In Python, the methods from this class return a dict as constructed from the JSON reply of the Daemon using the standard json.loads( str ) method.","title":"Python"},{"location":"dev/add-ons-reference/ram_daemon_interface/#javascript-extendscript","text":"In JS, the methods from this class return a standard JS object as constructed from the JSON reply of the Daemon using the standard json2 library.","title":"JavaScript / ExtendScript"},{"location":"dev/add-ons-reference/ram_file_info/","text":"RamFileInfo A class to easily handle Ramses names using the Ramses Naming Scheme . Read the sections about the Naming Scheme for more details about names used by Ramses . Attributes These attributes are automatically set by the RamFileInfo.setFileName( name ) or RamFileInfo.setFilePath( name ) methods; They can then be changed and a new file name can be generated using RamFileInfo.fileName( ) or RamFileInfo.filePath( ) Attribute Type Default Description date datetime current date and time The modification date of the file. extension string \"\" The file extension (without the leading . ). isRestoredVersion boolean false True if the corresponding file is a file created from restoring a previous version. project string \"\" The project short name (ID). ramType ItemType \"\" The type of the corresponding item. resource string \"\" The resource string. restoredVersion boolean -1 The version which was restored if isRestoredVersion is true . shortName string \"\" The short name (ID) of the item. state string \"\" The state short name (ID), if any. step string \"\" The step short name (ID). version int -1 The versin, -1 if not set/found. Methods Method Arguments Description constructor Creates a new empty instance. copy \u25b9 RamFileInfo Creates a copy of the current instance. fileName \u25b9 string Constructs and returns the file name based on the attributes. filePath \u25b9 string Constructs and returns the file path based on the attributes. originalFileName \u25b9 string Gets the original file name without any modification. originalFilePath \u25b9 string Gets the original file path if it was set, without any modification. setFileName \u25b9 boolean Sets the filename and parses data from it. Returns true on success. setFilePath Parses all data which can be found from a file path. Special Convert to string RamFileInfo s can be converted to string the usual way. This is equivalent to calling RamFileInfo.fileName() . # Python info = RamFileInfo( ) info.setFileName( aFileName ) print( info ) # implicit conversion print( str(info) ) # explicit conversion # Both will print: >>> PROJ_A_anAsset_aStep_aResource.ext // ExtendScript var info = new RamFileInfo( ); info.setFileName( aFileName ); $.writeln( obj.toString() ); // Prints: // PROJ_A_anAsset_aStep_aResource.ext Comparing objects RamFileInfo can be compared to check if two file info are the same, by comparing the attributes except the state and the version . That means all different versions of the same file are considered equal. The location is not compared either: two identical files but in different locations are considered the same. # Python info = RamFileInfo( ) info.setFileName( aFileName ) other = RamFileInfo( ) other.setFileName( anotherFileName ) same = RamFileInfo( ) same.setFileName( aFileNameButAnotherVersionOrLocation ) # RamFileInfo can be compared as any other value info == other # False info == same # True # It can be used with the `in` operator too infoList = [ info, other ] same in infoList # True # But RamFileInfo is not hashable, so it cannot be used in a `set` or as a key in a `dict` // ExtendScript var info = RamFileInfo( ); info.setFileName( aFileName ); var other = RamFileInfo( ); other.setFileName( anotherFileName ); var same = RamFileInfo( ); same.setFileName( aFileNameButAnotherVersionOrLocation ); // RamObject can be compared with the is() method info.is(other) // false info.is(same) // true Examples # Python from ramses import RamFileInfo, ItemType # Get info from an existing asset file filePath = '/path/to/PROJ_A_MyAsset_RIG_aResource.blend' nm = RamFileInfo() if nm.setFileName(filePath: nm.version = 12 # Set the version to 12 nm.state = \"OK\" # Set thje state print( nm.step ) # Prints: RIG print( nm.fileName() ) # Prints: PROJ_A_MyAsset_RIG_aResource_OK012.blend # Build a filename from scratch nm = RamFileInfo() nm.project = \"OTHER\" nm.shortName = \"MyShot\" nm.ramType = ItemType.SHOT nm.step = \"ANIM\" nm.extension = \"kra\" print( nm.fileName() ) # Prints: OTHER_S_MyShot_ANIM.kra # A function to publish a file # Note that this is actually the implementation of RamFileManager.publishFile() def publishFile( filePath ): \"\"\"Copies the given file to its corresponding publish folder\"\"\" fileInfo = RamFileManager.getPublishInfo( filePath ) if fileInfo.project == \"\": return publishFilePath = fileInfo.filePath() RamFileManager.copy( filePath, publishFilePath ) # Keep the date in the metadata, just in case RamMetaDataManager.setDate( publishFilePath, fileInfo.date ) return publishFilePath // ExtendScript #include ramses.jsxinc // Get info from an existing asset file var filePath = '/path/to/PROJ_A_MyAsset_RIG_aResource.blend'; var nm = new RamFileInfo(); if ( nm.setFileName(filePath) ) { nm.version = 12; // Set the version to 12 nm.state = \"OK\"; // Set thje state alert( nm.step ); // Alerts: RIG alert( nm.fileName() ); // Alerts: PROJ_A_MyAsset_RIG_aResource_OK012.blend } // Build a filename from scratch nm = RamFileInfo(); nm.project = \"OTHER\"; nm.shortName = \"MyShot\"; nm.ramType = ItemType.SHOT; nm.step = \"ANIM\"; nm.extension = \"kra\"; alert( nm.fileName() ); // Alerts: OTHER_S_MyShot_ANIM.kra // A function to publish a file // Note that this is actually the implementation of RamFileManager.publishFile() function publishFile( filePath ) { // Copies the given file to its corresponding publish folder var fileInfo = RamFileManager.getPublishInfo( filePath ); if (fileInfo.project == \"\") return var publishFilePath = fileInfo.filePath(); RamFileManager.copy( filePath, publishFilePath ); // Keep the date in the metadata, just in case RamMetaDataManager.setDate( publishFilePath, fileInfo.date ); return publishFilePath; }","title":"RamFileInfo"},{"location":"dev/add-ons-reference/ram_file_info/#ramfileinfo","text":"A class to easily handle Ramses names using the Ramses Naming Scheme . Read the sections about the Naming Scheme for more details about names used by Ramses .","title":"RamFileInfo"},{"location":"dev/add-ons-reference/ram_file_info/#attributes","text":"These attributes are automatically set by the RamFileInfo.setFileName( name ) or RamFileInfo.setFilePath( name ) methods; They can then be changed and a new file name can be generated using RamFileInfo.fileName( ) or RamFileInfo.filePath( ) Attribute Type Default Description date datetime current date and time The modification date of the file. extension string \"\" The file extension (without the leading . ). isRestoredVersion boolean false True if the corresponding file is a file created from restoring a previous version. project string \"\" The project short name (ID). ramType ItemType \"\" The type of the corresponding item. resource string \"\" The resource string. restoredVersion boolean -1 The version which was restored if isRestoredVersion is true . shortName string \"\" The short name (ID) of the item. state string \"\" The state short name (ID), if any. step string \"\" The step short name (ID). version int -1 The versin, -1 if not set/found.","title":"Attributes"},{"location":"dev/add-ons-reference/ram_file_info/#methods","text":"Method Arguments Description constructor Creates a new empty instance. copy \u25b9 RamFileInfo Creates a copy of the current instance. fileName \u25b9 string Constructs and returns the file name based on the attributes. filePath \u25b9 string Constructs and returns the file path based on the attributes. originalFileName \u25b9 string Gets the original file name without any modification. originalFilePath \u25b9 string Gets the original file path if it was set, without any modification. setFileName \u25b9 boolean Sets the filename and parses data from it. Returns true on success. setFilePath Parses all data which can be found from a file path.","title":"Methods"},{"location":"dev/add-ons-reference/ram_file_info/#special","text":"","title":"Special"},{"location":"dev/add-ons-reference/ram_file_info/#convert-to-string","text":"RamFileInfo s can be converted to string the usual way. This is equivalent to calling RamFileInfo.fileName() . # Python info = RamFileInfo( ) info.setFileName( aFileName ) print( info ) # implicit conversion print( str(info) ) # explicit conversion # Both will print: >>> PROJ_A_anAsset_aStep_aResource.ext // ExtendScript var info = new RamFileInfo( ); info.setFileName( aFileName ); $.writeln( obj.toString() ); // Prints: // PROJ_A_anAsset_aStep_aResource.ext","title":"Convert to string"},{"location":"dev/add-ons-reference/ram_file_info/#comparing-objects","text":"RamFileInfo can be compared to check if two file info are the same, by comparing the attributes except the state and the version . That means all different versions of the same file are considered equal. The location is not compared either: two identical files but in different locations are considered the same. # Python info = RamFileInfo( ) info.setFileName( aFileName ) other = RamFileInfo( ) other.setFileName( anotherFileName ) same = RamFileInfo( ) same.setFileName( aFileNameButAnotherVersionOrLocation ) # RamFileInfo can be compared as any other value info == other # False info == same # True # It can be used with the `in` operator too infoList = [ info, other ] same in infoList # True # But RamFileInfo is not hashable, so it cannot be used in a `set` or as a key in a `dict` // ExtendScript var info = RamFileInfo( ); info.setFileName( aFileName ); var other = RamFileInfo( ); other.setFileName( anotherFileName ); var same = RamFileInfo( ); same.setFileName( aFileNameButAnotherVersionOrLocation ); // RamObject can be compared with the is() method info.is(other) // false info.is(same) // true","title":"Comparing objects"},{"location":"dev/add-ons-reference/ram_file_info/#examples","text":"# Python from ramses import RamFileInfo, ItemType # Get info from an existing asset file filePath = '/path/to/PROJ_A_MyAsset_RIG_aResource.blend' nm = RamFileInfo() if nm.setFileName(filePath: nm.version = 12 # Set the version to 12 nm.state = \"OK\" # Set thje state print( nm.step ) # Prints: RIG print( nm.fileName() ) # Prints: PROJ_A_MyAsset_RIG_aResource_OK012.blend # Build a filename from scratch nm = RamFileInfo() nm.project = \"OTHER\" nm.shortName = \"MyShot\" nm.ramType = ItemType.SHOT nm.step = \"ANIM\" nm.extension = \"kra\" print( nm.fileName() ) # Prints: OTHER_S_MyShot_ANIM.kra # A function to publish a file # Note that this is actually the implementation of RamFileManager.publishFile() def publishFile( filePath ): \"\"\"Copies the given file to its corresponding publish folder\"\"\" fileInfo = RamFileManager.getPublishInfo( filePath ) if fileInfo.project == \"\": return publishFilePath = fileInfo.filePath() RamFileManager.copy( filePath, publishFilePath ) # Keep the date in the metadata, just in case RamMetaDataManager.setDate( publishFilePath, fileInfo.date ) return publishFilePath // ExtendScript #include ramses.jsxinc // Get info from an existing asset file var filePath = '/path/to/PROJ_A_MyAsset_RIG_aResource.blend'; var nm = new RamFileInfo(); if ( nm.setFileName(filePath) ) { nm.version = 12; // Set the version to 12 nm.state = \"OK\"; // Set thje state alert( nm.step ); // Alerts: RIG alert( nm.fileName() ); // Alerts: PROJ_A_MyAsset_RIG_aResource_OK012.blend } // Build a filename from scratch nm = RamFileInfo(); nm.project = \"OTHER\"; nm.shortName = \"MyShot\"; nm.ramType = ItemType.SHOT; nm.step = \"ANIM\"; nm.extension = \"kra\"; alert( nm.fileName() ); // Alerts: OTHER_S_MyShot_ANIM.kra // A function to publish a file // Note that this is actually the implementation of RamFileManager.publishFile() function publishFile( filePath ) { // Copies the given file to its corresponding publish folder var fileInfo = RamFileManager.getPublishInfo( filePath ); if (fileInfo.project == \"\") return var publishFilePath = fileInfo.filePath(); RamFileManager.copy( filePath, publishFilePath ); // Keep the date in the metadata, just in case RamMetaDataManager.setDate( publishFilePath, fileInfo.date ); return publishFilePath; }","title":"Examples"},{"location":"dev/add-ons-reference/ram_file_manager/","text":"RamFileManager Generic tools to handle files and the Ramses Naming Scheme Read the sections about the Ramses Tree and Naming Scheme for more details about names and folders used by Ramses . Static Methods Method Arguments Description buildPath \u25b9 boolean list of string : folders Builds a path with a list of folder names or subpaths, adding the \"/\" only if needed. Paths never include any trailing \"/\" copyToVersion \u25b9 string string : filePath , boolean : increment = false , string : dafaultStateShortName = \"v\" Copies the given file inside the corresponding _versions subfolder, optionnaly incrementing the version number. Use defaultStateShortName to change the state to be used if not found in the current or previous version. Returns the path to the new file. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. getLatestVersionInfo \u25b9 RamFileInfo string : filePath , string : dafaultStateShortName = \"v\" , boolean : previous = false Gets the latest version number and state for the given file, which can be located either in the main folder or one of the _versions , _preview or _published subfolder. Use defaultStateShortName to change the state to be used if not found in the current or previous version. If previous is true, will return the version immediately before the latest one. getLatestVersionFilePath \u25b9 string string : filePath , boolean : previous = false Gets the latest version file path for the given file, which can be located either in the main folder or one of the _versions , _preview or _published subfolder. If previous is true, will return the version immediately before the latest one. getProjectFolder \u25b9 string string : path Gets the root folder of the project this path belongs to. getPublishFolder \u25b9 string string : filePath Gets the published folder path for any given file. getPublishInfo \u25b9 RamFileInfo string : filePath Gets the published information for any given file. getPublishedVersions \u25b9 list of string string : filePath Gets the list of subfolders (versions) from the published folder of this file. getRamsesFiles \u25b9 list of string string : folderPath , string : resource = None Gets all the files respecting the Ramses naming scheme inside the folder, optionally corresponding to the given resource only. getSaveFilePath \u25b9 string string : filePath Gets and returns the path to be used to save the file given as argument, with a name respecting the Ramses Naming Scheme . If the file is in a _versions , _preview or _published folder, the save file is located in the parent folder. getVersionFilePaths \u25b9 string string : filePath Gets the corresponding version files from the _versions folder path for any given file. getVersionFolder \u25b9 string string : filePath Gets the _versions folder path for any given file. inPreviewFolder \u25b9 boolean string : filePath Checks if a given file is located in a _preview folder. inPublishFolder \u25b9 boolean string : filePath Checks if a given file is located in a _published folder. inReservedFolder \u25b9 boolean string : filePath Checks if a given file is located in a _published or _versions or _preview folder. inVersionsFolder \u25b9 boolean string : filePath Checks if a given file is located in a _versions folder. isAssetStep \u25b9 boolean string : stepShortName , string : assetsPath Checks using the information found in assetsPath (which should be the assets folder of a given project) if the given short name corresponds to an asset production step. isProjectFolder \u25b9 boolean string : folderPath Checks if a given folder is the project root folder. isRestoredFilePath \u25b9 boolean or int string : filePath Checks if the file is a working file which has been restored from a previous version (contains \"+restored-vXX+\" in its resource name). If it is a restored older version, the version number is returned, otherwise returns false . isShotStep \u25b9 boolean string : shotShortName , string : shotsPath Checks using the information found in shotsPath (which should be the shots folder of a given project) if the given short name corresponds to a shot production step. publishFile \u25b9 string string : filePath Copies the given file inside the corresponding _published subfolder. Returns the path to the new file. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. restoreVersionFile string : filePath Restores an older version. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. validateName \u25b9 boolean string : name Checks if this name respects the Ramses naming scheme. validateShortName \u25b9 boolean string : shortName Checks if this short name respects the Ramses naming scheme. waitFiles Calling this makes the current thread wait for all file writing threads to finish. API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. Private methods Method Arguments Description _isRamsesItemFoldername \u25b9 boolean string : n Checks if a given folder respects Ramses\u2019 naming convention for items\u2019 root folders. The root folder should look like this: \"projectID_itemType_objectID\"","title":"RamFileManager"},{"location":"dev/add-ons-reference/ram_file_manager/#ramfilemanager","text":"Generic tools to handle files and the Ramses Naming Scheme Read the sections about the Ramses Tree and Naming Scheme for more details about names and folders used by Ramses .","title":"RamFileManager"},{"location":"dev/add-ons-reference/ram_file_manager/#static-methods","text":"Method Arguments Description buildPath \u25b9 boolean list of string : folders Builds a path with a list of folder names or subpaths, adding the \"/\" only if needed. Paths never include any trailing \"/\" copyToVersion \u25b9 string string : filePath , boolean : increment = false , string : dafaultStateShortName = \"v\" Copies the given file inside the corresponding _versions subfolder, optionnaly incrementing the version number. Use defaultStateShortName to change the state to be used if not found in the current or previous version. Returns the path to the new file. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. getLatestVersionInfo \u25b9 RamFileInfo string : filePath , string : dafaultStateShortName = \"v\" , boolean : previous = false Gets the latest version number and state for the given file, which can be located either in the main folder or one of the _versions , _preview or _published subfolder. Use defaultStateShortName to change the state to be used if not found in the current or previous version. If previous is true, will return the version immediately before the latest one. getLatestVersionFilePath \u25b9 string string : filePath , boolean : previous = false Gets the latest version file path for the given file, which can be located either in the main folder or one of the _versions , _preview or _published subfolder. If previous is true, will return the version immediately before the latest one. getProjectFolder \u25b9 string string : path Gets the root folder of the project this path belongs to. getPublishFolder \u25b9 string string : filePath Gets the published folder path for any given file. getPublishInfo \u25b9 RamFileInfo string : filePath Gets the published information for any given file. getPublishedVersions \u25b9 list of string string : filePath Gets the list of subfolders (versions) from the published folder of this file. getRamsesFiles \u25b9 list of string string : folderPath , string : resource = None Gets all the files respecting the Ramses naming scheme inside the folder, optionally corresponding to the given resource only. getSaveFilePath \u25b9 string string : filePath Gets and returns the path to be used to save the file given as argument, with a name respecting the Ramses Naming Scheme . If the file is in a _versions , _preview or _published folder, the save file is located in the parent folder. getVersionFilePaths \u25b9 string string : filePath Gets the corresponding version files from the _versions folder path for any given file. getVersionFolder \u25b9 string string : filePath Gets the _versions folder path for any given file. inPreviewFolder \u25b9 boolean string : filePath Checks if a given file is located in a _preview folder. inPublishFolder \u25b9 boolean string : filePath Checks if a given file is located in a _published folder. inReservedFolder \u25b9 boolean string : filePath Checks if a given file is located in a _published or _versions or _preview folder. inVersionsFolder \u25b9 boolean string : filePath Checks if a given file is located in a _versions folder. isAssetStep \u25b9 boolean string : stepShortName , string : assetsPath Checks using the information found in assetsPath (which should be the assets folder of a given project) if the given short name corresponds to an asset production step. isProjectFolder \u25b9 boolean string : folderPath Checks if a given folder is the project root folder. isRestoredFilePath \u25b9 boolean or int string : filePath Checks if the file is a working file which has been restored from a previous version (contains \"+restored-vXX+\" in its resource name). If it is a restored older version, the version number is returned, otherwise returns false . isShotStep \u25b9 boolean string : shotShortName , string : shotsPath Checks using the information found in shotsPath (which should be the shots folder of a given project) if the given short name corresponds to a shot production step. publishFile \u25b9 string string : filePath Copies the given file inside the corresponding _published subfolder. Returns the path to the new file. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. restoreVersionFile string : filePath Restores an older version. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. validateName \u25b9 boolean string : name Checks if this name respects the Ramses naming scheme. validateShortName \u25b9 boolean string : shortName Checks if this short name respects the Ramses naming scheme. waitFiles Calling this makes the current thread wait for all file writing threads to finish.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_file_manager/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_file_manager/#private-methods","text":"Method Arguments Description _isRamsesItemFoldername \u25b9 boolean string : n Checks if a given folder respects Ramses\u2019 naming convention for items\u2019 root folders. The root folder should look like this: \"projectID_itemType_objectID\"","title":"Private methods"},{"location":"dev/add-ons-reference/ram_filetype/","text":"RamFileType A File type. File types are typically used with RamPipe . Inherits object \u25ba RamObject \u25ba RamFileType Methods Method Arguments Description check \u25b9 boolean string : filePath Checks if the given file is of this type. extensions \u25b9 list of string The extensions which can be used for this file type, excluding the leading \u201c.\u201d","title":"RamFileType"},{"location":"dev/add-ons-reference/ram_filetype/#ramfiletype","text":"A File type. File types are typically used with RamPipe . Inherits object \u25ba RamObject \u25ba RamFileType","title":"RamFileType"},{"location":"dev/add-ons-reference/ram_filetype/#methods","text":"Method Arguments Description check \u25b9 boolean string : filePath Checks if the given file is of this type. extensions \u25b9 list of string The extensions which can be used for this file type, excluding the leading \u201c.\u201d","title":"Methods"},{"location":"dev/add-ons-reference/ram_item/","text":"RamItem Base class for RamAsset and RamShot . An item of the project, either an asset or a shot. Inherits object \u25ba RamObject \u25ba RamItem Inherited by RamShot , RamAsset Static Methods Method Arguments Description fromPath \u25b9 RamItem or None \u2022 string : fileOrFolderPath \u2022 boolean : virtualIfNotFound = false The path can be any file or folder path from the item (a version file, a preview file, etc). Methods Method Arguments Description currentStatus \u25b9 RamStatus \u2022 RamStep or string : step = \"\" The current status for the given step isPublished \u25b9 bool \u2022 RamStep or string : step = \"\" Convenience function to check if there are published files in the publish folder. Equivalent to len(self.publishedVersionFolderPaths(step, resource)) > 0 itemType \u25b9 ItemType The type of this item. One of ItemType.SHOT , ItemType.ASSET , ItemType.GENERAL latestPublishedVersionFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" , \u2022 string : fileName = \"\" , \u2022 string : resource = undefined Folder of the latest published version, for a specific file name and/or resource latestVersion \u25b9 integer \u2022 string : resource = \"\" , \u2022 string : state = \"\" , \u2022 RamStep or string : step *= \"\" Returns the highest version number for the given state (wip, pub\u2026). latestVersionFilePath \u25b9 string \u2022 string : resource = \"\" , \u2022 string : state = \"\" , \u2022 RamStep or string : step = \"\" Latest version file path previewFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Gets the path to the preview folder. Paths are relative to the root of the item folder. previewFilePaths \u25b9 list of string \u2022 string : resource = \"\" , \u2022 RamStep or string : step = \"\" Gets the list of file paths in the preview folder. Paths are relative to the root of the item folder. project \u25b9 RamProject Gets the project this item belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName() projectShortName \u25b9 string Gets the short name of the project this item belongs too. publishedVersionFolderPaths \u25b9 list of string \u2022 RamStep or string : step = \"\" , \u2022 string : fileName = \"\" , \u2022 string : resource * = undefined Gets the list of folder paths in the publish folder, optionally for a given specific file name and/or resource. publishFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Gets the path to the publish folder. Paths are relative to the root of the item folder. setStatus \u2022 RamStatus : status , \u2022 RamStep or string : step Sets the current status for the given step stepFilePath \u25b9 string \u2022 string : resource = \"\" , \u2022 string : extension = \"\" , \u2022 RamStep or string : step *= \"\" Gets the file used for this step with the given file extension. stepFilePaths \u25b9 list of string \u2022 RamStep or string : step *= \"\" Gets the files used for this step (there may be several files, one per resource) stepFolderPath \u25b9 string \u2022 RamStep or string : step *= \"\" The subfolder for the given step stepStatusHistory \u25b9 list of string Gets the list of RamStatus UUIDs for the given step, ordered from oldest to most recent. versionFilePaths \u25b9 string \u2022 string : resource = \"\" , \u2022 RamStep or string : step = \"\" Gets all version files for the given resource. versionFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Path to the version folder relative to the item root folder","title":"RamItem"},{"location":"dev/add-ons-reference/ram_item/#ramitem","text":"Base class for RamAsset and RamShot . An item of the project, either an asset or a shot. Inherits object \u25ba RamObject \u25ba RamItem Inherited by RamShot , RamAsset","title":"RamItem"},{"location":"dev/add-ons-reference/ram_item/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamItem or None \u2022 string : fileOrFolderPath \u2022 boolean : virtualIfNotFound = false The path can be any file or folder path from the item (a version file, a preview file, etc).","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_item/#methods","text":"Method Arguments Description currentStatus \u25b9 RamStatus \u2022 RamStep or string : step = \"\" The current status for the given step isPublished \u25b9 bool \u2022 RamStep or string : step = \"\" Convenience function to check if there are published files in the publish folder. Equivalent to len(self.publishedVersionFolderPaths(step, resource)) > 0 itemType \u25b9 ItemType The type of this item. One of ItemType.SHOT , ItemType.ASSET , ItemType.GENERAL latestPublishedVersionFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" , \u2022 string : fileName = \"\" , \u2022 string : resource = undefined Folder of the latest published version, for a specific file name and/or resource latestVersion \u25b9 integer \u2022 string : resource = \"\" , \u2022 string : state = \"\" , \u2022 RamStep or string : step *= \"\" Returns the highest version number for the given state (wip, pub\u2026). latestVersionFilePath \u25b9 string \u2022 string : resource = \"\" , \u2022 string : state = \"\" , \u2022 RamStep or string : step = \"\" Latest version file path previewFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Gets the path to the preview folder. Paths are relative to the root of the item folder. previewFilePaths \u25b9 list of string \u2022 string : resource = \"\" , \u2022 RamStep or string : step = \"\" Gets the list of file paths in the preview folder. Paths are relative to the root of the item folder. project \u25b9 RamProject Gets the project this item belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName() projectShortName \u25b9 string Gets the short name of the project this item belongs too. publishedVersionFolderPaths \u25b9 list of string \u2022 RamStep or string : step = \"\" , \u2022 string : fileName = \"\" , \u2022 string : resource * = undefined Gets the list of folder paths in the publish folder, optionally for a given specific file name and/or resource. publishFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Gets the path to the publish folder. Paths are relative to the root of the item folder. setStatus \u2022 RamStatus : status , \u2022 RamStep or string : step Sets the current status for the given step stepFilePath \u25b9 string \u2022 string : resource = \"\" , \u2022 string : extension = \"\" , \u2022 RamStep or string : step *= \"\" Gets the file used for this step with the given file extension. stepFilePaths \u25b9 list of string \u2022 RamStep or string : step *= \"\" Gets the files used for this step (there may be several files, one per resource) stepFolderPath \u25b9 string \u2022 RamStep or string : step *= \"\" The subfolder for the given step stepStatusHistory \u25b9 list of string Gets the list of RamStatus UUIDs for the given step, ordered from oldest to most recent. versionFilePaths \u25b9 string \u2022 string : resource = \"\" , \u2022 RamStep or string : step = \"\" Gets all version files for the given resource. versionFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Path to the version folder relative to the item root folder","title":"Methods"},{"location":"dev/add-ons-reference/ram_metadata_manager/","text":"RamMetaDataManager A Class to get/set metadata from files. Ramses will use a single sidecar file named _ramses_data.json (storing data in json ) for all files located in a given folder; thus the metadata used by Ramses is set on a per-folder basis, and is not copied when a file is copied/moved: it does not make sense for Ramses to have the same metadata when a file is moved. The Meta-Data structure The Meta-Data used by Ramses contains at least these attributes. Key Name Type Default Value Description MetaDataKeys.COMMENT string \"\" A comment associated to the file MetaDataKeys.PIPE_TYPE int \"\" The type of the pipe associated to the file MetaDataKeys.VERSION int -1 A version associated to the file MetaDataKeys.VERSION_FILE string \"\" A version file associated to the file Static Methods Method Arguments Description getComment \u25b9 string string : filePath Gets the comment associated to the file. getDate \u25b9 datetime string : filePath Gets the date associated to the file. getFileMetaData \u25b9 object or dict string : filePath Gets the meta-data of the given file. getMetaData \u25b9 object or dict string : folderPath Gets the meta-data of all the files for the given folder. Each file name is used as a key in the returned object. getMetaDataFile \u25b9 string string : path Gets the path of the file containing the metadata for the given file or folder. getPipeType \u25b9 string string : filePath Gets the type of the pipe which created this file (if it has previously been set by the addon using setPipeType() ). getState \u25b9 string string : filePath Gets the state short name of the file. getValue \u25b9 any string : filePath , string : key Gets the value of a specific key for the file. getVersion \u25b9 int string : filePath Gets the version associated to the file. getVersionFilePath \u25b9 string string : filePath Gets the version file associated to the file. setComment \u25b9 string string : filePath , string : comment Sets the comment associated to a file. setDate \u25b9 string string : filePath , date or datetime or int or string : date Sets the date associated to a file. setFileMetaData string : filePath , object or dict : fileData Writes the given meta-data to the meta-data file associated to this file. setMetaData string : path , object or dict : data Writes the given meta-data to the meta-data file associated to this folder. setPipeType string : filePath , string : pipeType Sets the pipe which created the file. The value should be the short name of the pipe. setState string : filePath , string : state Sets the state for the file. setValue string : filePath , string : key , any : value Sets the value of a specific key for the file. setVersion string : filePath , int : version Sets the version associated to the file. setVersionFilePath string : filePath , string : versionFilePath Sets the version file associated to the file.","title":"RamMetaDataManager"},{"location":"dev/add-ons-reference/ram_metadata_manager/#rammetadatamanager","text":"A Class to get/set metadata from files. Ramses will use a single sidecar file named _ramses_data.json (storing data in json ) for all files located in a given folder; thus the metadata used by Ramses is set on a per-folder basis, and is not copied when a file is copied/moved: it does not make sense for Ramses to have the same metadata when a file is moved.","title":"RamMetaDataManager"},{"location":"dev/add-ons-reference/ram_metadata_manager/#the-meta-data-structure","text":"The Meta-Data used by Ramses contains at least these attributes. Key Name Type Default Value Description MetaDataKeys.COMMENT string \"\" A comment associated to the file MetaDataKeys.PIPE_TYPE int \"\" The type of the pipe associated to the file MetaDataKeys.VERSION int -1 A version associated to the file MetaDataKeys.VERSION_FILE string \"\" A version file associated to the file","title":"The Meta-Data structure"},{"location":"dev/add-ons-reference/ram_metadata_manager/#static-methods","text":"Method Arguments Description getComment \u25b9 string string : filePath Gets the comment associated to the file. getDate \u25b9 datetime string : filePath Gets the date associated to the file. getFileMetaData \u25b9 object or dict string : filePath Gets the meta-data of the given file. getMetaData \u25b9 object or dict string : folderPath Gets the meta-data of all the files for the given folder. Each file name is used as a key in the returned object. getMetaDataFile \u25b9 string string : path Gets the path of the file containing the metadata for the given file or folder. getPipeType \u25b9 string string : filePath Gets the type of the pipe which created this file (if it has previously been set by the addon using setPipeType() ). getState \u25b9 string string : filePath Gets the state short name of the file. getValue \u25b9 any string : filePath , string : key Gets the value of a specific key for the file. getVersion \u25b9 int string : filePath Gets the version associated to the file. getVersionFilePath \u25b9 string string : filePath Gets the version file associated to the file. setComment \u25b9 string string : filePath , string : comment Sets the comment associated to a file. setDate \u25b9 string string : filePath , date or datetime or int or string : date Sets the date associated to a file. setFileMetaData string : filePath , object or dict : fileData Writes the given meta-data to the meta-data file associated to this file. setMetaData string : path , object or dict : data Writes the given meta-data to the meta-data file associated to this folder. setPipeType string : filePath , string : pipeType Sets the pipe which created the file. The value should be the short name of the pipe. setState string : filePath , string : state Sets the state for the file. setValue string : filePath , string : key , any : value Sets the value of a specific key for the file. setVersion string : filePath , int : version Sets the version associated to the file. setVersionFilePath string : filePath , string : versionFilePath Sets the version file associated to the file.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_object/","text":"RamObject The base class for most of Ramses objects. Inherits object \u25ba RamObject Inherited by RamFileType , RamItem , RamPipe , RamPipeFile , RamProject , RamSequence , RamShot , RamState , RamStatus , RamStep , RamUser Static Methods Method Arguments Description isUuid \u25b9 bool \u2022 string : str Checks if a given string is a valid UUID . getUuid \u25b9 string object or string : object Convenience method. Returns the object\u2019s uuid or the string itself; use this to parse arguments in methods which need to use the uuid but can get either an object or a string as an argument. getShortName \u25b9 string object or string : object Convenience method. Returns the object\u2019s short name; the argument could be either the uuid or an object, or even a short name already. Methods Method Arguments Description constructor \u2022 string : uuid = \"\" \u2022 Object / Dict : data = None \u2022 bool : create = false \u2022 string : objectType = \"RamObject\" You should always provide the UUID unless you\u2019re creating a new object. In this case, set create = true and the object type. An object without UUID nor the create option will be virtual . color \u25b9 list of int The color used to display this object, as an [R, G, B] list. colorName \u25b9 string The color used to display this object, as an \"#000000\" string. comment \u25b9 string The comment for this object. data \u25b9 Object / dict The data of this object. folderPath \u25b9 string The path of this object (or an empty string). get \u25b9 any \u2022 string : key \u2022 any : default = None Gets a specific value from the data. If the key can\u2019t be found, returns the default value. name \u25b9 string The name of this object. set \u25b9 any \u2022 string : key \u2022 any : value Sets a specific value in the data. setData \u25b9 string \u2022 string or Object / Dict : data Sets new internal data for this object (and sends it to the application). shortName \u25b9 string The short name of this object. uuid \u25b9 string The universal unique identified (UUID) of this object. virtual \u25b9 bool Checks if this object is virtual. A virtual object is an object which is not saved in the system and will disappear after when the program quits. Invalid UUIDs will be converted to virtual objects. Special Convert to string RamObject s can be converted to string the usual way. # Python obj = RamObject( \"Name\", \"ShortName\" ) print( obj ) # implicit conversion print( str(obj) ) # explicit conversion # Both will print: >>> ShortName | Name // ExtendScript var obj = new RamObject( \"Name\", \"ShortName\" ); $.writeln( obj.toString() ); // Prints: // ShortName | Name Comparing objects RamObjects can be compared to check if two objects are the same (comparing the values, not the object instances). Two objects are considered the same if and only if their UUIDs are the same. Names will not be compared. # Python obj = RamObject( \"unique-uid1\" ) other = RamObject( \"unique-uid2\" ) same = RamObject( \"unique-uid1\" ) # RamObject can be compared as any other value obj == other # False obj == same # True # It can be used with the `in` operator too objList = [ obj, other ] same in objList # True # But RamObject is not hashable, so it cannot be used in a `set` or as a key in a `dict` // ExtendScript var obj = RamObject( \"unique-uid1\" ); var other = RamObject( \"unique-uid2\" ); var same = RamObject( \"unique-uid1\" ); // RamObject can be compared with the is() method obj.is(other) // false obj.is(same) // true Cached data To limit the number of queries to the Ramses Daemon and improve performance, the data is cached for two seconds. That means any change in the Ramses Application (by the user or a sync process) in between two calls on a RamObject instance will be ignored if there is less than two seconds between these calls. A way to force the update of the data is to reinit the internal data of the RamObject to an empty dictionnary/object. # Python # Create an object obj = RamObject(\"unique-uid\") # Get some info name = obj.name() # Do stuff, in less than two seconds. # If we absolutely need the latest data # (i.e. it may have changed since the call to 'name()') # reset the internal data obj.__data = {} # Now we can get up-to-date data name = obj.name() // ExtendScript // Create an object var obj = new RamObject(\"unique-uid\"); // Get some info var name = obj.name(); // Do stuff, in less than two seconds. // If we absolutely need the latest data // (i.e. it may have changed since the call to 'name()') // reset the internal data obj.__data = {}; // Now we can get up-to-date data name = obj.name(); Note When setting new data, the cache is automatically updated first, to be sure to avoid conflicts. API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. Implementation Converting objects to string # Python # Overload the __str__() method class RamObject: def __str__( self ): return self.shortName() + \" | \" + self.name() // ExtendScript // Overload the toString() method function RamObject() {}; RamObject.prototype.toString = function () { return this.shortName() + \" | \" + this.name(); } Object comparison # Python # Overload the __eq__() method class RamObject: def __eq__( self, other ): return self.__uuid == other.uuid() // ExtendScript // Implements an is() method function RamObject() {}; RamObject.prototype.is = function ( other ) { return this.__uuid == other.__uuid; }","title":"RamObject"},{"location":"dev/add-ons-reference/ram_object/#ramobject","text":"The base class for most of Ramses objects. Inherits object \u25ba RamObject Inherited by RamFileType , RamItem , RamPipe , RamPipeFile , RamProject , RamSequence , RamShot , RamState , RamStatus , RamStep , RamUser","title":"RamObject"},{"location":"dev/add-ons-reference/ram_object/#static-methods","text":"Method Arguments Description isUuid \u25b9 bool \u2022 string : str Checks if a given string is a valid UUID . getUuid \u25b9 string object or string : object Convenience method. Returns the object\u2019s uuid or the string itself; use this to parse arguments in methods which need to use the uuid but can get either an object or a string as an argument. getShortName \u25b9 string object or string : object Convenience method. Returns the object\u2019s short name; the argument could be either the uuid or an object, or even a short name already.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_object/#methods","text":"Method Arguments Description constructor \u2022 string : uuid = \"\" \u2022 Object / Dict : data = None \u2022 bool : create = false \u2022 string : objectType = \"RamObject\" You should always provide the UUID unless you\u2019re creating a new object. In this case, set create = true and the object type. An object without UUID nor the create option will be virtual . color \u25b9 list of int The color used to display this object, as an [R, G, B] list. colorName \u25b9 string The color used to display this object, as an \"#000000\" string. comment \u25b9 string The comment for this object. data \u25b9 Object / dict The data of this object. folderPath \u25b9 string The path of this object (or an empty string). get \u25b9 any \u2022 string : key \u2022 any : default = None Gets a specific value from the data. If the key can\u2019t be found, returns the default value. name \u25b9 string The name of this object. set \u25b9 any \u2022 string : key \u2022 any : value Sets a specific value in the data. setData \u25b9 string \u2022 string or Object / Dict : data Sets new internal data for this object (and sends it to the application). shortName \u25b9 string The short name of this object. uuid \u25b9 string The universal unique identified (UUID) of this object. virtual \u25b9 bool Checks if this object is virtual. A virtual object is an object which is not saved in the system and will disappear after when the program quits. Invalid UUIDs will be converted to virtual objects.","title":"Methods"},{"location":"dev/add-ons-reference/ram_object/#special","text":"","title":"Special"},{"location":"dev/add-ons-reference/ram_object/#convert-to-string","text":"RamObject s can be converted to string the usual way. # Python obj = RamObject( \"Name\", \"ShortName\" ) print( obj ) # implicit conversion print( str(obj) ) # explicit conversion # Both will print: >>> ShortName | Name // ExtendScript var obj = new RamObject( \"Name\", \"ShortName\" ); $.writeln( obj.toString() ); // Prints: // ShortName | Name","title":"Convert to string"},{"location":"dev/add-ons-reference/ram_object/#comparing-objects","text":"RamObjects can be compared to check if two objects are the same (comparing the values, not the object instances). Two objects are considered the same if and only if their UUIDs are the same. Names will not be compared. # Python obj = RamObject( \"unique-uid1\" ) other = RamObject( \"unique-uid2\" ) same = RamObject( \"unique-uid1\" ) # RamObject can be compared as any other value obj == other # False obj == same # True # It can be used with the `in` operator too objList = [ obj, other ] same in objList # True # But RamObject is not hashable, so it cannot be used in a `set` or as a key in a `dict` // ExtendScript var obj = RamObject( \"unique-uid1\" ); var other = RamObject( \"unique-uid2\" ); var same = RamObject( \"unique-uid1\" ); // RamObject can be compared with the is() method obj.is(other) // false obj.is(same) // true","title":"Comparing objects"},{"location":"dev/add-ons-reference/ram_object/#cached-data","text":"To limit the number of queries to the Ramses Daemon and improve performance, the data is cached for two seconds. That means any change in the Ramses Application (by the user or a sync process) in between two calls on a RamObject instance will be ignored if there is less than two seconds between these calls. A way to force the update of the data is to reinit the internal data of the RamObject to an empty dictionnary/object. # Python # Create an object obj = RamObject(\"unique-uid\") # Get some info name = obj.name() # Do stuff, in less than two seconds. # If we absolutely need the latest data # (i.e. it may have changed since the call to 'name()') # reset the internal data obj.__data = {} # Now we can get up-to-date data name = obj.name() // ExtendScript // Create an object var obj = new RamObject(\"unique-uid\"); // Get some info var name = obj.name(); // Do stuff, in less than two seconds. // If we absolutely need the latest data // (i.e. it may have changed since the call to 'name()') // reset the internal data obj.__data = {}; // Now we can get up-to-date data name = obj.name(); Note When setting new data, the cache is automatically updated first, to be sure to avoid conflicts.","title":"Cached data"},{"location":"dev/add-ons-reference/ram_object/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_object/#implementation","text":"","title":"Implementation"},{"location":"dev/add-ons-reference/ram_object/#converting-objects-to-string","text":"# Python # Overload the __str__() method class RamObject: def __str__( self ): return self.shortName() + \" | \" + self.name() // ExtendScript // Overload the toString() method function RamObject() {}; RamObject.prototype.toString = function () { return this.shortName() + \" | \" + this.name(); }","title":"Converting objects to string"},{"location":"dev/add-ons-reference/ram_object/#object-comparison","text":"# Python # Overload the __eq__() method class RamObject: def __eq__( self, other ): return self.__uuid == other.uuid() // ExtendScript // Implements an is() method function RamObject() {}; RamObject.prototype.is = function ( other ) { return this.__uuid == other.__uuid; }","title":"Object comparison"},{"location":"dev/add-ons-reference/ram_pipe/","text":"RamPipe A pipe which connects two steps together in the production pipeline. The pipe goes from the output step (which exports data into specific file types represented by the RamPipeFile class) to the input step (which imports that data). Inherits object \u25ba RamObject \u25ba RamPipe Methods Method Arguments Description inputStep \u25b9 RamStep The input step inputStepShortName \u25b9 string The short name of the input step outputStep \u25b9 RamStep The output step outputStepShortName \u25b9 string The short name of the output step pipeFiles \u25b9 list of RamPipeFile The list of pipe files used through this step","title":"RamPipe"},{"location":"dev/add-ons-reference/ram_pipe/#rampipe","text":"A pipe which connects two steps together in the production pipeline. The pipe goes from the output step (which exports data into specific file types represented by the RamPipeFile class) to the input step (which imports that data). Inherits object \u25ba RamObject \u25ba RamPipe","title":"RamPipe"},{"location":"dev/add-ons-reference/ram_pipe/#methods","text":"Method Arguments Description inputStep \u25b9 RamStep The input step inputStepShortName \u25b9 string The short name of the input step outputStep \u25b9 RamStep The output step outputStepShortName \u25b9 string The short name of the output step pipeFiles \u25b9 list of RamPipeFile The list of pipe files used through this step","title":"Methods"},{"location":"dev/add-ons-reference/ram_pipefile/","text":"RamPipeFile A file which goes through a RamPipe . Inherits object \u25ba RamObject \u25ba RamPipeFile Methods Method Arguments Description check \u25b9 boolean string : filePath Checks if the given file can go through this pipe. colorSpace \u25b9 string The color space used through the pipe. customSettings \u25b9 string Can be any string which can be set from the pipeline editor in the Ramses Client Application . Use this to add more information to configure your pipeline and pass this information to the addons. getFiles \u25b9 list of string string : folderPath Gets all the files which can go through this pipe in the given folder. fileType \u25b9 RamFileType The file type used through the pipe.","title":"RamPipeFile"},{"location":"dev/add-ons-reference/ram_pipefile/#rampipefile","text":"A file which goes through a RamPipe . Inherits object \u25ba RamObject \u25ba RamPipeFile","title":"RamPipeFile"},{"location":"dev/add-ons-reference/ram_pipefile/#methods","text":"Method Arguments Description check \u25b9 boolean string : filePath Checks if the given file can go through this pipe. colorSpace \u25b9 string The color space used through the pipe. customSettings \u25b9 string Can be any string which can be set from the pipeline editor in the Ramses Client Application . Use this to add more information to configure your pipeline and pass this information to the addons. getFiles \u25b9 list of string string : folderPath Gets all the files which can go through this pipe in the given folder. fileType \u25b9 RamFileType The file type used through the pipe.","title":"Methods"},{"location":"dev/add-ons-reference/ram_project/","text":"RamProject A project handled by Ramses. Projects contains general items, assets and shots. Inherits object \u25ba RamObject \u25ba RamProject Static Methods Method Arguments Description fromPath \u25b9 RamProject string : path Returns a RamProject instance built using the given path. The path can be any file or folder path from the project Methods Method Arguments Description adminPath \u25b9 str The path to the administration files of this project. When calling this method, the folder will created if it does not exist yet. absolutePath \u25b9 str string : relativePath Builds an absolute path from a path relative to the project path assetGroups \u25b9 list of RamAssetGroup Available asset groups in this project assets \u25b9 list of RamAsset RamAssetGroup : assetGroup = None Available assets in this project and group. If groupName is an empty string, returns all assets. assetsPath \u25b9 str string : assetGroup = \"\" The path to the assets (including the asset group if provided) of this project. When calling this method, the folder will created if it does not exist yet. exportPath \u25b9 str The path to the exported medias of this project. When calling this method, the folder will created if it does not exist yet. folderPath \u25b9 string The project\u2019s root folder. framerate \u25b9 float The project\u2019s framerate, in frames per second. height \u25b9 int The project\u2019s height, in pixels. pipes \u25b9 list of RamPipe Available pipes in this project postProdPath \u25b9 str The path to the post-production steps common files of this project. When calling this method, the folder will created if it does not exist yet. preProdPath \u25b9 str The path to the pre-production steps common files of this project. When calling this method, the folder will created if it does not exist yet. prodPath \u25b9 str The path to the production steps common files of this project. When calling this method, the folder will created if it does not exist yet. sequences \u25b9 list of RamSequence Available sequences in this project shots \u25b9 RamShot string : nameFilter = \"*\" , RamSequence : sequence = None Available shots in this project shotsPath \u25b9 str The path to the shots of this project. When calling this method, the folder will created if it does not exist yet. step \u25b9 RamStep or None string : shortName (Try to) retrieve a step from its short name. steps \u25b9 list of RamStep enumerated value : type = RamStep.ALL Available steps in this project. Use type to filter the results. One of: StepType.ALL , StepType.ASSET_PODUCTION , StepType.SHOT_PRODUCTION , StepType.PRE_PRODUCTION , StepType.PRODUCTION , StepType.POST_PRODUCTION . StepType.PRODUCTION represents a combination of SHOT and ASSET . width \u25b9 int The project\u2019s width, in pixels. API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. Private methods Method Arguments Description _getAssetsInFolder \u25b9 list of RamAsset string : folderPath , RamAssetGroup : assetGroup = None Recursively gets all assets contained in the given folder.","title":"RamProject"},{"location":"dev/add-ons-reference/ram_project/#ramproject","text":"A project handled by Ramses. Projects contains general items, assets and shots. Inherits object \u25ba RamObject \u25ba RamProject","title":"RamProject"},{"location":"dev/add-ons-reference/ram_project/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamProject string : path Returns a RamProject instance built using the given path. The path can be any file or folder path from the project","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_project/#methods","text":"Method Arguments Description adminPath \u25b9 str The path to the administration files of this project. When calling this method, the folder will created if it does not exist yet. absolutePath \u25b9 str string : relativePath Builds an absolute path from a path relative to the project path assetGroups \u25b9 list of RamAssetGroup Available asset groups in this project assets \u25b9 list of RamAsset RamAssetGroup : assetGroup = None Available assets in this project and group. If groupName is an empty string, returns all assets. assetsPath \u25b9 str string : assetGroup = \"\" The path to the assets (including the asset group if provided) of this project. When calling this method, the folder will created if it does not exist yet. exportPath \u25b9 str The path to the exported medias of this project. When calling this method, the folder will created if it does not exist yet. folderPath \u25b9 string The project\u2019s root folder. framerate \u25b9 float The project\u2019s framerate, in frames per second. height \u25b9 int The project\u2019s height, in pixels. pipes \u25b9 list of RamPipe Available pipes in this project postProdPath \u25b9 str The path to the post-production steps common files of this project. When calling this method, the folder will created if it does not exist yet. preProdPath \u25b9 str The path to the pre-production steps common files of this project. When calling this method, the folder will created if it does not exist yet. prodPath \u25b9 str The path to the production steps common files of this project. When calling this method, the folder will created if it does not exist yet. sequences \u25b9 list of RamSequence Available sequences in this project shots \u25b9 RamShot string : nameFilter = \"*\" , RamSequence : sequence = None Available shots in this project shotsPath \u25b9 str The path to the shots of this project. When calling this method, the folder will created if it does not exist yet. step \u25b9 RamStep or None string : shortName (Try to) retrieve a step from its short name. steps \u25b9 list of RamStep enumerated value : type = RamStep.ALL Available steps in this project. Use type to filter the results. One of: StepType.ALL , StepType.ASSET_PODUCTION , StepType.SHOT_PRODUCTION , StepType.PRE_PRODUCTION , StepType.PRODUCTION , StepType.POST_PRODUCTION . StepType.PRODUCTION represents a combination of SHOT and ASSET . width \u25b9 int The project\u2019s width, in pixels.","title":"Methods"},{"location":"dev/add-ons-reference/ram_project/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_project/#private-methods","text":"Method Arguments Description _getAssetsInFolder \u25b9 list of RamAsset string : folderPath , RamAssetGroup : assetGroup = None Recursively gets all assets contained in the given folder.","title":"Private methods"},{"location":"dev/add-ons-reference/ram_sequence/","text":"RamSequence A group of shots. Inherits object \u25ba RamObject \u25ba RamSequence Methods Method Arguments Description project \u25b9 RamProject The project containing this sequence.","title":"RamSequence"},{"location":"dev/add-ons-reference/ram_sequence/#ramsequence","text":"A group of shots. Inherits object \u25ba RamObject \u25ba RamSequence","title":"RamSequence"},{"location":"dev/add-ons-reference/ram_sequence/#methods","text":"Method Arguments Description project \u25b9 RamProject The project containing this sequence.","title":"Methods"},{"location":"dev/add-ons-reference/ram_settings/","text":"RamSettings Gets and saves settings used by Ramses. One (and only one) instance globally available (RamSettings is a singleton ), by calling RamSettings.instance() or Ramses.instance().settings() . To get a setting, just get the corresponding attribute. To change a setting temporarily, just set the corresponding attribute. If you want the change to be permanent (i.e. keep the setting for the next sessions), call the save() method. By default, settings are saved in a ramses_addons_settings.json file, in the user\u2019s OS specific settings folder: Linux: ~/.config/RxLaboratory/Ramses/Config Windows: %appdata%/RxLaboratory/Ramses/Config MacOS: ? Static Methods Method Arguments Description instance \u25b9 RamSettings Returns the RamSettings unique instance. Attributes To retrieve the default values after the settings have been changed, access them with the attributes which names start with default . Attribute Type Default Description addonsHelpUrl string The URL to this page Read-only. A link to the Ramses add-ons documentation apiReferenceUrl string This page URL Read-only. A link to this API documentation autoIncrementTimeout int 120 Timeout before auto incrementing a file, in minutes. debugMode boolean false Set to true to throw errors and other debug info when developping add-ons. defaultAutoIncrementTimeout int 120 defaultDebugMode boolean false defaultOnline boolean true defaultRamsesClientPath string os-specific defaultRamsesClientPort integer 18185 defaultRamsesFolderPath string \"~/Ramses\" defaultLogLevel LogLevel LogLevel.Info generalHelpUrl string The URL to this documentation Read-only. A link to the Ramses documentation logLevel LogLevel LogLevel.Info Changes the quantity of messages in the log. One of: LogLevel.DataReceived , LogLevel.DataSent , LogLevel.Debug , LogLevel.Info , LogLevel.Critical , LogLevel.Fatal online boolean true Wether to always try to (re)connect to the Daemon if offline. ramsesClientPath string os-specific Location of the Ramses Client executable file (.exe on Windows, .app on MacOS, .appimage or binary on Linux) ramsesClientPort integer 18185 Listening port of the Ramses Daemon ramsesFolderPath string \"~/Ramses\" The folder containing all Ramses files (settings, projects, etc) userSettings dict or object {} Use this attribute to store your own settings. You can add as many key/value pairs as you need, they will be saved with the RamSettings.save() method too. version string The current API version Read-only. Methods Method Arguments Description save Saves the current settings to the disk. folderPath \u25b9 string The folder path to the settings filePath \u25b9 string The file path to the settings API Dev notes Note This section is for the development of the API only; you should not need these when developping your add-on using the API. Private Attributes Attribute Type Default Description folderNames FolderNames A simple class containing the common names for subfolders. See the constants for more information. Examples ramses = Ramses.instance settings = ramses.settings theAsset = RamAsset(\"thing\", \"stuff\") thePreviewFolder = theAsset.folderPath() + \"/\" + settings.folderNames.preview","title":"RamSettings"},{"location":"dev/add-ons-reference/ram_settings/#ramsettings","text":"Gets and saves settings used by Ramses. One (and only one) instance globally available (RamSettings is a singleton ), by calling RamSettings.instance() or Ramses.instance().settings() . To get a setting, just get the corresponding attribute. To change a setting temporarily, just set the corresponding attribute. If you want the change to be permanent (i.e. keep the setting for the next sessions), call the save() method. By default, settings are saved in a ramses_addons_settings.json file, in the user\u2019s OS specific settings folder: Linux: ~/.config/RxLaboratory/Ramses/Config Windows: %appdata%/RxLaboratory/Ramses/Config MacOS: ?","title":"RamSettings"},{"location":"dev/add-ons-reference/ram_settings/#static-methods","text":"Method Arguments Description instance \u25b9 RamSettings Returns the RamSettings unique instance.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_settings/#attributes","text":"To retrieve the default values after the settings have been changed, access them with the attributes which names start with default . Attribute Type Default Description addonsHelpUrl string The URL to this page Read-only. A link to the Ramses add-ons documentation apiReferenceUrl string This page URL Read-only. A link to this API documentation autoIncrementTimeout int 120 Timeout before auto incrementing a file, in minutes. debugMode boolean false Set to true to throw errors and other debug info when developping add-ons. defaultAutoIncrementTimeout int 120 defaultDebugMode boolean false defaultOnline boolean true defaultRamsesClientPath string os-specific defaultRamsesClientPort integer 18185 defaultRamsesFolderPath string \"~/Ramses\" defaultLogLevel LogLevel LogLevel.Info generalHelpUrl string The URL to this documentation Read-only. A link to the Ramses documentation logLevel LogLevel LogLevel.Info Changes the quantity of messages in the log. One of: LogLevel.DataReceived , LogLevel.DataSent , LogLevel.Debug , LogLevel.Info , LogLevel.Critical , LogLevel.Fatal online boolean true Wether to always try to (re)connect to the Daemon if offline. ramsesClientPath string os-specific Location of the Ramses Client executable file (.exe on Windows, .app on MacOS, .appimage or binary on Linux) ramsesClientPort integer 18185 Listening port of the Ramses Daemon ramsesFolderPath string \"~/Ramses\" The folder containing all Ramses files (settings, projects, etc) userSettings dict or object {} Use this attribute to store your own settings. You can add as many key/value pairs as you need, they will be saved with the RamSettings.save() method too. version string The current API version Read-only.","title":"Attributes"},{"location":"dev/add-ons-reference/ram_settings/#methods","text":"Method Arguments Description save Saves the current settings to the disk. folderPath \u25b9 string The folder path to the settings filePath \u25b9 string The file path to the settings","title":"Methods"},{"location":"dev/add-ons-reference/ram_settings/#api-dev-notes","text":"Note This section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_settings/#private-attributes","text":"Attribute Type Default Description folderNames FolderNames A simple class containing the common names for subfolders. See the constants for more information.","title":"Private Attributes"},{"location":"dev/add-ons-reference/ram_settings/#examples","text":"ramses = Ramses.instance settings = ramses.settings theAsset = RamAsset(\"thing\", \"stuff\") thePreviewFolder = theAsset.folderPath() + \"/\" + settings.folderNames.preview","title":"Examples"},{"location":"dev/add-ons-reference/ram_shot/","text":"RamShot A shot. Inherits object \u25ba RamObject \u25ba RamItem \u25ba RamShot Static Methods Method Arguments Description fromPath \u25b9 RamShot string : folderPath Returns a RamShot instance built using the given folder path. The path can be any file or folder path from the asset (a version file, a preview file, etc) Methods Method Arguments Description constructor string : shotName , string : shotShortName , string : shotFolder , float : duration = 0.0 duration \u25b9 float The shot duration, in seconds frames \u25b9 int The shot duration, in frames group \u25b9 string The name of the sequence containing this shot. sequence \u25b9 RamSequence The sequence containing this shot. API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. (Im)mutable data The data returned by the methods can be either mutable or immutable . Method Type of the returned data duration Mutable","title":"RamShot"},{"location":"dev/add-ons-reference/ram_shot/#ramshot","text":"A shot. Inherits object \u25ba RamObject \u25ba RamItem \u25ba RamShot","title":"RamShot"},{"location":"dev/add-ons-reference/ram_shot/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamShot string : folderPath Returns a RamShot instance built using the given folder path. The path can be any file or folder path from the asset (a version file, a preview file, etc)","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_shot/#methods","text":"Method Arguments Description constructor string : shotName , string : shotShortName , string : shotFolder , float : duration = 0.0 duration \u25b9 float The shot duration, in seconds frames \u25b9 int The shot duration, in frames group \u25b9 string The name of the sequence containing this shot. sequence \u25b9 RamSequence The sequence containing this shot.","title":"Methods"},{"location":"dev/add-ons-reference/ram_shot/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_shot/#immutable-data","text":"The data returned by the methods can be either mutable or immutable . Method Type of the returned data duration Mutable","title":"(Im)mutable data"},{"location":"dev/add-ons-reference/ram_state/","text":"RamState Represents a state used in a status, like \u201cCHK\u201d (To be checked), \u201cOK\u201d (ok), \u201cTODO\u201d, etc. Inherits object \u25ba RamObject \u25ba RamState Methods Method Arguments Description completionRatio \u25b9 integer The ratio of completion of this state in the range [0, 100] .","title":"RamState"},{"location":"dev/add-ons-reference/ram_state/#ramstate","text":"Represents a state used in a status, like \u201cCHK\u201d (To be checked), \u201cOK\u201d (ok), \u201cTODO\u201d, etc. Inherits object \u25ba RamObject \u25ba RamState","title":"RamState"},{"location":"dev/add-ons-reference/ram_state/#methods","text":"Method Arguments Description completionRatio \u25b9 integer The ratio of completion of this state in the range [0, 100] .","title":"Methods"},{"location":"dev/add-ons-reference/ram_status/","text":"RamStatus A state associated to a comment, the user who changed the state, etc. Inherits object \u25ba RamObject \u25ba RamStatus Static Methods Method Arguments Description fromPath \u25b9 RamStatus string : filePath Returns a RamStatus instance built using the given file path. Methods Method Arguments Description completionRatio \u25b9 integer The ratio of completion of this status. date \u25b9 datetime The date at which this status was created. item \u25b9 RamAsset or RamItem or RamShot The item this status refers to. published \u25b9 boolean True if this version of the item has been published. state \u25b9 RamState The corresponding state. user \u25b9 RamUser The user who created this status. version \u25b9 integer The version of the corresponding working file. setCompletionRatio \u2022 integer : completion Sets the ratio of completion of this status. setPublished \u2022 boolean : published = true Sets if this version of the item has been published. setState \u2022 RamState : state Sets the corresponding state. setUser \u2022 RamUser : user Sets the user who created this status. setVersion \u2022 integer : version Sets the version of the corresponding working file. step \u25b9 RamStep The step this status refers to.","title":"RamStatus"},{"location":"dev/add-ons-reference/ram_status/#ramstatus","text":"A state associated to a comment, the user who changed the state, etc. Inherits object \u25ba RamObject \u25ba RamStatus","title":"RamStatus"},{"location":"dev/add-ons-reference/ram_status/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamStatus string : filePath Returns a RamStatus instance built using the given file path.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_status/#methods","text":"Method Arguments Description completionRatio \u25b9 integer The ratio of completion of this status. date \u25b9 datetime The date at which this status was created. item \u25b9 RamAsset or RamItem or RamShot The item this status refers to. published \u25b9 boolean True if this version of the item has been published. state \u25b9 RamState The corresponding state. user \u25b9 RamUser The user who created this status. version \u25b9 integer The version of the corresponding working file. setCompletionRatio \u2022 integer : completion Sets the ratio of completion of this status. setPublished \u2022 boolean : published = true Sets if this version of the item has been published. setState \u2022 RamState : state Sets the corresponding state. setUser \u2022 RamUser : user Sets the user who created this status. setVersion \u2022 integer : version Sets the version of the corresponding working file. step \u25b9 RamStep The step this status refers to.","title":"Methods"},{"location":"dev/add-ons-reference/ram_step/","text":"RamStep A step in the production of the shots or assets of the project. Inherits object \u25ba RamObject \u25ba RamStep Static Methods Method Arguments Description fromDict \u25b9 RamStep dict or object : stepDict Builds a RamStep from a dict or object like the one returned by the RamDaemonInterface fromPath \u25b9 RamStep string : path Returns a RamStep instance built using the given file path. Methods Method Arguments Description constructor string : stepName , string : stepShortName , string : stepFolderPath = \"\" , StepType : stepType = \"\" At least the folder or the type must be provided, but one is enough as the other info can be gotten from the Ramses Tree generalSettings \u25b9 string The general settings for this step. It is meant to be a YAML string, but can actually be anything. inputPipes \u25b9 list of RamPipe The pipes comming into this step. outputPipes \u25b9 list of RamPipe The pipes going out of this step. project \u25b9 RamProject Gets the project this step belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName() projectShortName \u25b9 string Gets the short name of the project this step belongs too. publishSettings \u25b9 string The publish settings for this step. It is meant to be a YAML string, but can actually be anything. setGeneralSettings string : settings Sets new general settings. It is meant to be a YAML string, but can actually be anything. setPublishSettings string : settings Sets new publish settings. It is meant to be a YAML string, but can actually be anything. stepType \u25b9 StepType The type of this step, one of StepType.PRE_PRODUCTION , StepType.SHOT_PRODUCTION , StepType.ASSET_PRODUCTION , StepType.POST_PRODUCTION templatesFolderPath \u25b9 string The absolute path to the folder containing the template files for this step templatesPublishFilePaths \u25b9 list of string The list of published files for the templates templatesPublishPath \u25b9 string The absolute path to the folder where templates are published","title":"RamStep"},{"location":"dev/add-ons-reference/ram_step/#ramstep","text":"A step in the production of the shots or assets of the project. Inherits object \u25ba RamObject \u25ba RamStep","title":"RamStep"},{"location":"dev/add-ons-reference/ram_step/#static-methods","text":"Method Arguments Description fromDict \u25b9 RamStep dict or object : stepDict Builds a RamStep from a dict or object like the one returned by the RamDaemonInterface fromPath \u25b9 RamStep string : path Returns a RamStep instance built using the given file path.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_step/#methods","text":"Method Arguments Description constructor string : stepName , string : stepShortName , string : stepFolderPath = \"\" , StepType : stepType = \"\" At least the folder or the type must be provided, but one is enough as the other info can be gotten from the Ramses Tree generalSettings \u25b9 string The general settings for this step. It is meant to be a YAML string, but can actually be anything. inputPipes \u25b9 list of RamPipe The pipes comming into this step. outputPipes \u25b9 list of RamPipe The pipes going out of this step. project \u25b9 RamProject Gets the project this step belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName() projectShortName \u25b9 string Gets the short name of the project this step belongs too. publishSettings \u25b9 string The publish settings for this step. It is meant to be a YAML string, but can actually be anything. setGeneralSettings string : settings Sets new general settings. It is meant to be a YAML string, but can actually be anything. setPublishSettings string : settings Sets new publish settings. It is meant to be a YAML string, but can actually be anything. stepType \u25b9 StepType The type of this step, one of StepType.PRE_PRODUCTION , StepType.SHOT_PRODUCTION , StepType.ASSET_PRODUCTION , StepType.POST_PRODUCTION templatesFolderPath \u25b9 string The absolute path to the folder containing the template files for this step templatesPublishFilePaths \u25b9 list of string The list of published files for the templates templatesPublishPath \u25b9 string The absolute path to the folder where templates are published","title":"Methods"},{"location":"dev/add-ons-reference/ram_user/","text":"RamUser The class representing users. Inherits object \u25ba RamObject \u25ba RamUser Methods Method Arguments Description comment \u25b9 string A comment associated to the user configPath \u25b9 string The path to the Config folder for this user role \u25b9 UserRole One of UserRole.ADMIN , UserRole.PROJECT_ADMIN , UserRole.LEAD or UserRole.STANDARD","title":"RamUser"},{"location":"dev/add-ons-reference/ram_user/#ramuser","text":"The class representing users. Inherits object \u25ba RamObject \u25ba RamUser","title":"RamUser"},{"location":"dev/add-ons-reference/ram_user/#methods","text":"Method Arguments Description comment \u25b9 string A comment associated to the user configPath \u25b9 string The path to the Config folder for this user role \u25b9 UserRole One of UserRole.ADMIN , UserRole.PROJECT_ADMIN , UserRole.LEAD or UserRole.STANDARD","title":"Methods"},{"location":"dev/add-ons-reference/ramses/","text":"Ramses The main class. One (and only one) instance globally available (Ramses is a singleton ), by calling Ramses.instance() . Static Methods Method Arguments Description instance \u25b9 Ramses Returns the Ramses unique instance. version \u25b9 string The current version of this API Static Attributes Attribute Type Default Description apiReferenceUrl string This page URL A link to this API documentation addonsHelpUrl string The URL to this page A link to the Ramses add-ons documentation generalHelpUrl string The URL to this documentation A link to the Ramses documentation Attributes Read the section entitled Callbacks below (and see the Examples ) for more information about the methods you can add to these lists. Attribute Type Default Description importScripts list [] A list of scripts/functions to be triggered when Ramses.instance().importItem() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user asks to import an item. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. publishScripts list [] A list of scripts/functions to be triggered when Ramses.instance().publish() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user publishes the current file from the host application. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. replaceScripts list [] A list of scripts/functions to be triggered when Ramses.instance().replaceItem() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user asks to import an item. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. statusScripts list [] A list of scripts/functions to be triggered when Ramses.instance().updateStatus() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user changes the current status of an asset / shot from the host application. userScripts dict or object {} This dict or object is here for your convenience, to make it easy to register and call any method from anywhere you\u2019ve imported Ramses without having to import the file containing the method. Just register with Ramses.instance().userScripts[\"TheFunctionName\"] = aFunction and call the method with Ramses.instance().userScripts[\"TheFunctionName\"](some, args) . Methods Method Arguments Description alternativeFolderPaths \u25b9 list of string A list of alternative absolute paths to the main Ramses folder. Missing files will be looked for in these paths (and copied to the main path if available), and they will be used if the main path is not available. backupFolderPath \u25b9 list of string A copy of the main folder where all files are stored. connect \u25b9 boolean Checks Daemon availability and initiates the connection. Returns success. currentProject \u25b9 RamProject or None The current project. currentUser \u25b9 RamUser or None The current user. daemonInterface \u25b9 RamDaemonInterface The Daemon interface unique instance. Same as RamDaemonInterface.instance() disconnect \u25b9 boolean Gets back to offline mode (stops all communications with the Daemon ). folderPath \u25b9 string The absolute path to main Ramses folder, containing projects by default, config files, user folders, admin files\u2026 importItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Callbacks below for more details. project \u25b9 RamProject or None (Try to) retrieve a project using its short name. projects \u25b9 list of RamProject The list of available projects. projectsPath \u25b9 string The path to the folder containing projects. states \u25b9 list of RamState The list of available states. state \u25b9 RamState \u2022 string : stateShortName = WIP Gets a specific state. online \u25b9 boolean True if connected to the Daemon and the Daemon is responding. publish \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Callbacks below for more details. replaceItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Callbacks below for more details. showClient Raises the Ramses Client window, launches the client if it is not already running. setCurrentProject \u2022 RamProject : project Sets the current project. settings \u25b9 RamSettings The settings unique instance. Same as RamSettings.instance() updateStatus \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Callbacks below for more details. usersPath \u25b9 string The path to the folder containing users. Callbacks The callbacks are the methods you can add to these lists: Ramses.publishScripts , Ramses.statusScripts , Ramses.importScripts , Ramses.userScripts . When using one of the provided Ramses Add-ons , these callbacks will be called automatically when the user publishes an item, changes the status, or wants to import a file. This makes it very easy to extend these add-ons by just adding your own methods. If you\u2019re developping your own add-on from scratch, it may be useful to add your methods to these lists to call them easily anyway; use Ramses.publish() , Ramses.importItem() , and Ramses.updateStatus() . Ramses will pass a few arguments depending on the context to theses methods, which they\u2019ll have to handle. The table below describes the callbacks. Callback Arguments Description importItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false - item is the item from which the user wants to import a file. - filePaths is the list of absolute path to the files the user wants to import. This list can be empty! In this case, it means the add-on must automatically choose the right file from the publish folder of the item and step. - step is the step from which the user wants to import. You can check step.outputPipes() to know which file types have been published, and inputPipes() from the step you\u2019re importing to to know which files to accept. - importOptions is a dictionnary (associative array) containing custom options you can use to import the item. - showImportOptions tells the script to show a UI or not to edit the import options before importing. publish \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false - item is the item from which the user wants to publish a file. - step is the step from which the user is publishing. You can check step.outputPipes() to know which file types to publish. - filePath is the path of the file currently being published. - publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. - showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. replaceItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false - item is the item from which the user wants to import a file. - filePath is the absolute path to the file the user wants to import. - step is the step from which the user wants to import. You can check step.outputPipes() to know which file types have been published, and inputPipes() from the step you\u2019re importing to to know which files to accept. - importOptions is a dictionnary (associative array) containing custom options you can use to import the item. - showImportOptions tells the script to show a UI or not to edit the import options before importing. With this info, the method should replace selected objects with the imported items. updateStatus \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step - item is the item which is being updated. - status is the new status. - step is the step being updated. Examples # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(item, filePath, step): ram.log(\"Hello, I've been published!\") # Another one def aFunction( arg1, arg2): ram.log(\"I'm doing something\") # Adds the method to the scripts which will be run when the add-on publishes a file ramses.publishScripts.append( published ) # Let's store a function in the userScripts to make it available everywhere ramses.userScripts[\"MyFunction\"] = aFunction # The provided Ramses add-ons for Blender, Maya, etc. automatically trigger these scripts. # If you're developping another addon, you have to call Ramses.publish() to run them ramses.publish(currentItem, 'a path', 'STEP') # From anywhere in the app where the Ramses module has been imported, you can call 'aFunction' with ramses.userScripts[\"MyFunction\"](some, arg) // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // A simple method function published(item, filePath, step) { ram.log(\"Hello, I've been published!\"); } // Another one function aFunction( arg1, arg2) { ram.log(\"I'm doing something\"); } // Adds the method to the scripts which will be run when the add-on publishes a file ramses.publishScripts.push( published ); // Let's store a function in the userScripts to make it available everywhere ramses.userScripts[\"MyFunction\"] = aFunction; // The provided Ramses add-ons for Blender, Maya, etc. automatically trigger these scripts. // If you're developping another addon, you have to call Ramses.publish() to run them ramses.publish(currentItem, 'a path', 'STEP'); // From anywhere in the app, you can call 'aFunction' with ramses.userScripts[\"MyFunction\"](some, arg); API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. Private attributes Attribute Type Default Description defaultState RamState The state to use as default (\u201cWIP\u201d).","title":"Ramses"},{"location":"dev/add-ons-reference/ramses/#ramses","text":"The main class. One (and only one) instance globally available (Ramses is a singleton ), by calling Ramses.instance() .","title":"Ramses"},{"location":"dev/add-ons-reference/ramses/#static-methods","text":"Method Arguments Description instance \u25b9 Ramses Returns the Ramses unique instance. version \u25b9 string The current version of this API","title":"Static Methods"},{"location":"dev/add-ons-reference/ramses/#static-attributes","text":"Attribute Type Default Description apiReferenceUrl string This page URL A link to this API documentation addonsHelpUrl string The URL to this page A link to the Ramses add-ons documentation generalHelpUrl string The URL to this documentation A link to the Ramses documentation","title":"Static Attributes"},{"location":"dev/add-ons-reference/ramses/#attributes","text":"Read the section entitled Callbacks below (and see the Examples ) for more information about the methods you can add to these lists. Attribute Type Default Description importScripts list [] A list of scripts/functions to be triggered when Ramses.instance().importItem() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user asks to import an item. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. publishScripts list [] A list of scripts/functions to be triggered when Ramses.instance().publish() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user publishes the current file from the host application. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. replaceScripts list [] A list of scripts/functions to be triggered when Ramses.instance().replaceItem() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user asks to import an item. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. statusScripts list [] A list of scripts/functions to be triggered when Ramses.instance().updateStatus() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user changes the current status of an asset / shot from the host application. userScripts dict or object {} This dict or object is here for your convenience, to make it easy to register and call any method from anywhere you\u2019ve imported Ramses without having to import the file containing the method. Just register with Ramses.instance().userScripts[\"TheFunctionName\"] = aFunction and call the method with Ramses.instance().userScripts[\"TheFunctionName\"](some, args) .","title":"Attributes"},{"location":"dev/add-ons-reference/ramses/#methods","text":"Method Arguments Description alternativeFolderPaths \u25b9 list of string A list of alternative absolute paths to the main Ramses folder. Missing files will be looked for in these paths (and copied to the main path if available), and they will be used if the main path is not available. backupFolderPath \u25b9 list of string A copy of the main folder where all files are stored. connect \u25b9 boolean Checks Daemon availability and initiates the connection. Returns success. currentProject \u25b9 RamProject or None The current project. currentUser \u25b9 RamUser or None The current user. daemonInterface \u25b9 RamDaemonInterface The Daemon interface unique instance. Same as RamDaemonInterface.instance() disconnect \u25b9 boolean Gets back to offline mode (stops all communications with the Daemon ). folderPath \u25b9 string The absolute path to main Ramses folder, containing projects by default, config files, user folders, admin files\u2026 importItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Callbacks below for more details. project \u25b9 RamProject or None (Try to) retrieve a project using its short name. projects \u25b9 list of RamProject The list of available projects. projectsPath \u25b9 string The path to the folder containing projects. states \u25b9 list of RamState The list of available states. state \u25b9 RamState \u2022 string : stateShortName = WIP Gets a specific state. online \u25b9 boolean True if connected to the Daemon and the Daemon is responding. publish \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Callbacks below for more details. replaceItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Callbacks below for more details. showClient Raises the Ramses Client window, launches the client if it is not already running. setCurrentProject \u2022 RamProject : project Sets the current project. settings \u25b9 RamSettings The settings unique instance. Same as RamSettings.instance() updateStatus \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Callbacks below for more details. usersPath \u25b9 string The path to the folder containing users.","title":"Methods"},{"location":"dev/add-ons-reference/ramses/#callbacks","text":"The callbacks are the methods you can add to these lists: Ramses.publishScripts , Ramses.statusScripts , Ramses.importScripts , Ramses.userScripts . When using one of the provided Ramses Add-ons , these callbacks will be called automatically when the user publishes an item, changes the status, or wants to import a file. This makes it very easy to extend these add-ons by just adding your own methods. If you\u2019re developping your own add-on from scratch, it may be useful to add your methods to these lists to call them easily anyway; use Ramses.publish() , Ramses.importItem() , and Ramses.updateStatus() . Ramses will pass a few arguments depending on the context to theses methods, which they\u2019ll have to handle. The table below describes the callbacks. Callback Arguments Description importItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false - item is the item from which the user wants to import a file. - filePaths is the list of absolute path to the files the user wants to import. This list can be empty! In this case, it means the add-on must automatically choose the right file from the publish folder of the item and step. - step is the step from which the user wants to import. You can check step.outputPipes() to know which file types have been published, and inputPipes() from the step you\u2019re importing to to know which files to accept. - importOptions is a dictionnary (associative array) containing custom options you can use to import the item. - showImportOptions tells the script to show a UI or not to edit the import options before importing. publish \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false - item is the item from which the user wants to publish a file. - step is the step from which the user is publishing. You can check step.outputPipes() to know which file types to publish. - filePath is the path of the file currently being published. - publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. - showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. replaceItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false - item is the item from which the user wants to import a file. - filePath is the absolute path to the file the user wants to import. - step is the step from which the user wants to import. You can check step.outputPipes() to know which file types have been published, and inputPipes() from the step you\u2019re importing to to know which files to accept. - importOptions is a dictionnary (associative array) containing custom options you can use to import the item. - showImportOptions tells the script to show a UI or not to edit the import options before importing. With this info, the method should replace selected objects with the imported items. updateStatus \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step - item is the item which is being updated. - status is the new status. - step is the step being updated.","title":"Callbacks"},{"location":"dev/add-ons-reference/ramses/#examples","text":"# Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(item, filePath, step): ram.log(\"Hello, I've been published!\") # Another one def aFunction( arg1, arg2): ram.log(\"I'm doing something\") # Adds the method to the scripts which will be run when the add-on publishes a file ramses.publishScripts.append( published ) # Let's store a function in the userScripts to make it available everywhere ramses.userScripts[\"MyFunction\"] = aFunction # The provided Ramses add-ons for Blender, Maya, etc. automatically trigger these scripts. # If you're developping another addon, you have to call Ramses.publish() to run them ramses.publish(currentItem, 'a path', 'STEP') # From anywhere in the app where the Ramses module has been imported, you can call 'aFunction' with ramses.userScripts[\"MyFunction\"](some, arg) // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // A simple method function published(item, filePath, step) { ram.log(\"Hello, I've been published!\"); } // Another one function aFunction( arg1, arg2) { ram.log(\"I'm doing something\"); } // Adds the method to the scripts which will be run when the add-on publishes a file ramses.publishScripts.push( published ); // Let's store a function in the userScripts to make it available everywhere ramses.userScripts[\"MyFunction\"] = aFunction; // The provided Ramses add-ons for Blender, Maya, etc. automatically trigger these scripts. // If you're developping another addon, you have to call Ramses.publish() to run them ramses.publish(currentItem, 'a path', 'STEP'); // From anywhere in the app, you can call 'aFunction' with ramses.userScripts[\"MyFunction\"](some, arg);","title":"Examples"},{"location":"dev/add-ons-reference/ramses/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ramses/#private-attributes","text":"Attribute Type Default Description defaultState RamState The state to use as default (\u201cWIP\u201d).","title":"Private attributes"},{"location":"dev/daemon-reference/","text":"Ramses Daemon API The Ramses Daemon is a local server used by the Ramses Add-ons to get and set data to the client (which in turn may communicate with the Ramses Server to sync data) and the whole system. The Ramses Daemon is automatically run by the Ramses Application , which is the beating heart of Ramses . Connecting to the Daemon Add-ons can communicate with the Daemon through a standard TCP Socket . The Daemon listens on port 18185 1 by default (but this can be adjusted in the Ramses Application settings), and is automatically started by the Ramses Application . It is terminated when the client quits. To avoid conflicts, it may be temporarily suspended when the client is syncing data with the Ramses Server but all requests are queued and all of them should be processed. Most of the Ramses data can only be accessed if a user is logged-in in the Ramses Application , thus before communicating with the Daemon , a Ramses Add-on must check if the Application (and its Daemon ) is running (or start it), and if a user is logged-in. The initial connection to the Daemon usually follows these steps: Check if the Daemon is running by sending the ping query. If the Daemon replies, connection is ready Else, try to start the Application and ping again. Check the version of the Daemon which is part of the reply to the ping . Check if a user is logged-in (this is also part of the reply to the ping ); if not, show an alert and raise the Ramses Application window. After these steps, other queries can be used to get or set new data and information. Communicating with the Daemon Queries Add-ons can post queries with the form of a standard form-encoded URL query; they are a single-line string of key=value pairs (the value may be optional) seperated by the & character. They should be encoded in UTF-8 . There\u2019s no need to enclose strings in quotes. Example queries: ping getProjects setCurrentProject&uuid=unique-uid Replies The Daemon replies with a JSON object (encoded in UTF-8 ) which contains the following attributes: accepted : boolean . True if the Daemon has recognized the query and accepted it. Will be False if the query does not exist. success : boolean . True if the Daemon has successfully processed the query, False in case of any error. message : string . A human-readable feedback about the result, which can be shown to the user by the Add-on . It contains explanation about the error, if any. query : string . The query that was made that the Daemon is replying to. content : object . The actual content of the reply, which varies depending on the query. Read this reference for more details. Note Replies are a single-line string, but they\u2019re prettyfied in this documentation for the sake of readabiliy A reply looks like this: { \"accepted\": true, \"query\": \"ping\", \"success\": true, \"message\": \"Hi, this is the Ramses Daemon.\", \"content\": { \"version\": \"1.0.0\", \"ramses\": \"Ramses\", \"userUuid\": \"unique-uid\" } } Objects and their data In Ramses, everything is represented by Objects . An object consists of a Unique Universal Identifier (UUID) used to identify them across the whole system, and its associated data , encoded as a JSON Object . Ramses Objects (i.e. RamObjects ) can represent a shot, an asset, a user, an application, or a whole project for example. They can also contain lists of other objects. Lists of objects are basic string lists of UUIDs stored in the parent object data. UUIDs and object data are synced by all the Ramses Applications and a Ramses Server , and are mirrored on all workstations and the server itself. Any other software (e.g. APIs , scripts, plugins\u2026) should get the list of objects and all data using this Ramses Daemon run by the Ramses Application which is guaranteed to be up-to-date. You can also use the Daemon to set new data to specific objects. Data can be retrived and updated with these two simple queries: getData and setData . This port was chosen in memory of Karl Marx, whose birth date was 05/05/1818. \u21a9","title":"Reference"},{"location":"dev/daemon-reference/#ramses-daemon-api","text":"The Ramses Daemon is a local server used by the Ramses Add-ons to get and set data to the client (which in turn may communicate with the Ramses Server to sync data) and the whole system. The Ramses Daemon is automatically run by the Ramses Application , which is the beating heart of Ramses .","title":"Ramses Daemon API"},{"location":"dev/daemon-reference/#connecting-to-the-daemon","text":"Add-ons can communicate with the Daemon through a standard TCP Socket . The Daemon listens on port 18185 1 by default (but this can be adjusted in the Ramses Application settings), and is automatically started by the Ramses Application . It is terminated when the client quits. To avoid conflicts, it may be temporarily suspended when the client is syncing data with the Ramses Server but all requests are queued and all of them should be processed. Most of the Ramses data can only be accessed if a user is logged-in in the Ramses Application , thus before communicating with the Daemon , a Ramses Add-on must check if the Application (and its Daemon ) is running (or start it), and if a user is logged-in. The initial connection to the Daemon usually follows these steps: Check if the Daemon is running by sending the ping query. If the Daemon replies, connection is ready Else, try to start the Application and ping again. Check the version of the Daemon which is part of the reply to the ping . Check if a user is logged-in (this is also part of the reply to the ping ); if not, show an alert and raise the Ramses Application window. After these steps, other queries can be used to get or set new data and information.","title":"Connecting to the Daemon"},{"location":"dev/daemon-reference/#communicating-with-the-daemon","text":"","title":"Communicating with the Daemon"},{"location":"dev/daemon-reference/#queries","text":"Add-ons can post queries with the form of a standard form-encoded URL query; they are a single-line string of key=value pairs (the value may be optional) seperated by the & character. They should be encoded in UTF-8 . There\u2019s no need to enclose strings in quotes. Example queries: ping getProjects setCurrentProject&uuid=unique-uid","title":"Queries"},{"location":"dev/daemon-reference/#replies","text":"The Daemon replies with a JSON object (encoded in UTF-8 ) which contains the following attributes: accepted : boolean . True if the Daemon has recognized the query and accepted it. Will be False if the query does not exist. success : boolean . True if the Daemon has successfully processed the query, False in case of any error. message : string . A human-readable feedback about the result, which can be shown to the user by the Add-on . It contains explanation about the error, if any. query : string . The query that was made that the Daemon is replying to. content : object . The actual content of the reply, which varies depending on the query. Read this reference for more details. Note Replies are a single-line string, but they\u2019re prettyfied in this documentation for the sake of readabiliy A reply looks like this: { \"accepted\": true, \"query\": \"ping\", \"success\": true, \"message\": \"Hi, this is the Ramses Daemon.\", \"content\": { \"version\": \"1.0.0\", \"ramses\": \"Ramses\", \"userUuid\": \"unique-uid\" } }","title":"Replies"},{"location":"dev/daemon-reference/#objects-and-their-data","text":"In Ramses, everything is represented by Objects . An object consists of a Unique Universal Identifier (UUID) used to identify them across the whole system, and its associated data , encoded as a JSON Object . Ramses Objects (i.e. RamObjects ) can represent a shot, an asset, a user, an application, or a whole project for example. They can also contain lists of other objects. Lists of objects are basic string lists of UUIDs stored in the parent object data. UUIDs and object data are synced by all the Ramses Applications and a Ramses Server , and are mirrored on all workstations and the server itself. Any other software (e.g. APIs , scripts, plugins\u2026) should get the list of objects and all data using this Ramses Daemon run by the Ramses Application which is guaranteed to be up-to-date. You can also use the Daemon to set new data to specific objects. Data can be retrived and updated with these two simple queries: getData and setData . This port was chosen in memory of Karl Marx, whose birth date was 05/05/1818. \u21a9","title":"Objects and their data"},{"location":"dev/daemon-reference/create/","text":"","title":"create"},{"location":"dev/daemon-reference/getCurrentProject/","text":"getCurrentProject Query: getCurrentProject Gets the current project ( UUID and data). Reply JSON { \"accepted\": true, \"query\": \"getCurrentProject\", \"success\": true, \"message\": \"\\\"Project Name\\\" is the current project.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": \"{some JSON data}\" } } Details uuid : string . The UUID of the project. Empty string if there\u2019s no current project. data : string . The data of the project. Empty JSON object if there\u2019s no current project.","title":"getCurrentProject"},{"location":"dev/daemon-reference/getCurrentProject/#getcurrentproject","text":"Query: getCurrentProject Gets the current project ( UUID and data).","title":"getCurrentProject"},{"location":"dev/daemon-reference/getCurrentProject/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getCurrentProject/#json","text":"{ \"accepted\": true, \"query\": \"getCurrentProject\", \"success\": true, \"message\": \"\\\"Project Name\\\" is the current project.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": \"{some JSON data}\" } }","title":"JSON"},{"location":"dev/daemon-reference/getCurrentProject/#details","text":"uuid : string . The UUID of the project. Empty string if there\u2019s no current project. data : string . The data of the project. Empty JSON object if there\u2019s no current project.","title":"Details"},{"location":"dev/daemon-reference/getData/","text":"getData Query: getData&uuid=unique-uid Gets the data for a specific RamObject . Reply JSON { \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got some data.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"getData"},{"location":"dev/daemon-reference/getData/#getdata","text":"Query: getData&uuid=unique-uid Gets the data for a specific RamObject .","title":"getData"},{"location":"dev/daemon-reference/getData/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getData/#json","text":"{ \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got some data.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"JSON"},{"location":"dev/daemon-reference/getObjects/","text":"getObjects Query: getObjects&type=RamObject Gets all objects of a specific type. Reply JSON { \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got the list of \\\"RamObject\\\".\", \"content\": { \"objects\": [ { \"uuid\": \"unique-uid1\", \"data\": {\"Some JSON Data\"} }, { \"uuid\": \"unique-uid2\", \"data\": {\"Some JSON Data\"} }, { \"...\" } ] } }","title":"getObjets"},{"location":"dev/daemon-reference/getObjects/#getobjects","text":"Query: getObjects&type=RamObject Gets all objects of a specific type.","title":"getObjects"},{"location":"dev/daemon-reference/getObjects/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getObjects/#json","text":"{ \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got the list of \\\"RamObject\\\".\", \"content\": { \"objects\": [ { \"uuid\": \"unique-uid1\", \"data\": {\"Some JSON Data\"} }, { \"uuid\": \"unique-uid2\", \"data\": {\"Some JSON Data\"} }, { \"...\" } ] } }","title":"JSON"},{"location":"dev/daemon-reference/getPath/","text":"getPath Query: getPath&uuid=unique-uid Gets the path for a specific RamObject . Reply JSON { \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got the path of the object.\", \"content\": { \"path\": \"path/to/the/object\" } }","title":"getPath"},{"location":"dev/daemon-reference/getPath/#getpath","text":"Query: getPath&uuid=unique-uid Gets the path for a specific RamObject .","title":"getPath"},{"location":"dev/daemon-reference/getPath/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getPath/#json","text":"{ \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got the path of the object.\", \"content\": { \"path\": \"path/to/the/object\" } }","title":"JSON"},{"location":"dev/daemon-reference/getProjects/","text":"getProjects Query: getProjects Gets the list of available projects for the current user. Reply JSON { \"accepted\": true, \"query\": \"getProjects\", \"success\": true, \"message\": \"I've got the project list.\", \"content\": { \"projects\": [ { \"uuid\": \"unique-uid1\", \"data\": {\"Some JSON Data\"} }, { \"uuid\": \"unique-uid2\", \"data\": {\"Some JSON Data\"} }, { \"...\" } ] } } Details projects : list of string . The list of available project UUIDs .","title":"getProjects"},{"location":"dev/daemon-reference/getProjects/#getprojects","text":"Query: getProjects Gets the list of available projects for the current user.","title":"getProjects"},{"location":"dev/daemon-reference/getProjects/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getProjects/#json","text":"{ \"accepted\": true, \"query\": \"getProjects\", \"success\": true, \"message\": \"I've got the project list.\", \"content\": { \"projects\": [ { \"uuid\": \"unique-uid1\", \"data\": {\"Some JSON Data\"} }, { \"uuid\": \"unique-uid2\", \"data\": {\"Some JSON Data\"} }, { \"...\" } ] } }","title":"JSON"},{"location":"dev/daemon-reference/getProjects/#details","text":"projects : list of string . The list of available project UUIDs .","title":"Details"},{"location":"dev/daemon-reference/getRamsesFolder/","text":"getRamsesFolder Query: getRamsesFolder Gets the folder where all data is stored. Reply JSON { \"accepted\": true, \"query\": \"getRamsesFolder\", \"success\": true, \"message\": \"I've got the Ramses folder.\", \"content\": { \"path\": \"path/to/ramses/data\" } } Details path : string . The path to the data.","title":"getRamsesFolder"},{"location":"dev/daemon-reference/getRamsesFolder/#getramsesfolder","text":"Query: getRamsesFolder Gets the folder where all data is stored.","title":"getRamsesFolder"},{"location":"dev/daemon-reference/getRamsesFolder/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getRamsesFolder/#json","text":"{ \"accepted\": true, \"query\": \"getRamsesFolder\", \"success\": true, \"message\": \"I've got the Ramses folder.\", \"content\": { \"path\": \"path/to/ramses/data\" } }","title":"JSON"},{"location":"dev/daemon-reference/getRamsesFolder/#details","text":"path : string . The path to the data.","title":"Details"},{"location":"dev/daemon-reference/ping/","text":"ping Query: ping Checks if the Daemon is running, and gets its version and current user information. Reply JSON { \"accepted\": true, \"query\": \"ping\", \"success\": true, \"message\": \"Hi, this is the Ramses Daemon.\", \"content\": { \"version\": \"1.0.0\", \"ramses\": \"Ramses\", \"userUuid\": \"unique-uid\" } } Details The Daemon replies with its version and information about the current user. version : string . The version of the client/daemon. ramses : string . The name of the client, should be \u201cRamses\u201d for the official client. userUuid : string . The UUID of the user. Empty string if there\u2019s no logged-in user.","title":"ping"},{"location":"dev/daemon-reference/ping/#ping","text":"Query: ping Checks if the Daemon is running, and gets its version and current user information.","title":"ping"},{"location":"dev/daemon-reference/ping/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/ping/#json","text":"{ \"accepted\": true, \"query\": \"ping\", \"success\": true, \"message\": \"Hi, this is the Ramses Daemon.\", \"content\": { \"version\": \"1.0.0\", \"ramses\": \"Ramses\", \"userUuid\": \"unique-uid\" } }","title":"JSON"},{"location":"dev/daemon-reference/ping/#details","text":"The Daemon replies with its version and information about the current user. version : string . The version of the client/daemon. ramses : string . The name of the client, should be \u201cRamses\u201d for the official client. userUuid : string . The UUID of the user. Empty string if there\u2019s no logged-in user.","title":"Details"},{"location":"dev/daemon-reference/raise/","text":"raise Query: raise Attempts to raise the Ramses Application window. Depending on the system, this may just show a notification, actually raise the window, or do nothing. This query doesn\u2019t send any reply.","title":"raise"},{"location":"dev/daemon-reference/raise/#raise","text":"Query: raise Attempts to raise the Ramses Application window. Depending on the system, this may just show a notification, actually raise the window, or do nothing. This query doesn\u2019t send any reply.","title":"raise"},{"location":"dev/daemon-reference/setCurrentProject/","text":"setCurrentProject Query: setCurrentProject&uuid=unique-uid Sets the application-side active project. Reply JSON { \"accepted\": true, \"query\": \"setCurrentProject\", \"success\": true, \"message\": \"Current project set to: \\\"Project Name\\\".\", \"content\": { } }","title":"setCurrentProject"},{"location":"dev/daemon-reference/setCurrentProject/#setcurrentproject","text":"Query: setCurrentProject&uuid=unique-uid Sets the application-side active project.","title":"setCurrentProject"},{"location":"dev/daemon-reference/setCurrentProject/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/setCurrentProject/#json","text":"{ \"accepted\": true, \"query\": \"setCurrentProject\", \"success\": true, \"message\": \"Current project set to: \\\"Project Name\\\".\", \"content\": { } }","title":"JSON"},{"location":"dev/daemon-reference/setData/","text":"setData Query: getData&uuid=unique-uid&data={Some JSON Data} Sets the data for a specific RamObject . Reply JSON { \"accepted\": true, \"query\": \"setData\", \"success\": true, \"message\": \"Data updated.\", \"content\": { } }","title":"setData"},{"location":"dev/daemon-reference/setData/#setdata","text":"Query: getData&uuid=unique-uid&data={Some JSON Data} Sets the data for a specific RamObject .","title":"setData"},{"location":"dev/daemon-reference/setData/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/setData/#json","text":"{ \"accepted\": true, \"query\": \"setData\", \"success\": true, \"message\": \"Data updated.\", \"content\": { } }","title":"JSON"},{"location":"dev/daemon-reference/uuidFromPath/","text":"uuidFromPath Query: uuidFromPath&path=some/path Gets the UUID of the object at this path. Reply JSON { \"accepted\": true, \"query\": \"uuidFromPath\", \"success\": true, \"message\": \"I've found an object.\", \"content\": { \"uuid\": \"unique-uid\" } } Details uuid : string . The UUID of the object.","title":"uuidFromPath"},{"location":"dev/daemon-reference/uuidFromPath/#uuidfrompath","text":"Query: uuidFromPath&path=some/path Gets the UUID of the object at this path.","title":"uuidFromPath"},{"location":"dev/daemon-reference/uuidFromPath/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/uuidFromPath/#json","text":"{ \"accepted\": true, \"query\": \"uuidFromPath\", \"success\": true, \"message\": \"I've found an object.\", \"content\": { \"uuid\": \"unique-uid\" } }","title":"JSON"},{"location":"dev/daemon-reference/uuidFromPath/#details","text":"uuid : string . The UUID of the object.","title":"Details"},{"location":"dev/files/naming/","text":"Regular Expressions for files and folder naming. Ramses uses specific file and folder naming conventions . Here are useful regular expressions to manipulate them. Note All names used by Ramses should be compated ignoring the case. Thus all regular expressions should use the i flag. Regular Expressions for files and folder naming. Short Names (IDs) Names Status and versions Extract version from a file name Resource names File names Master media file names Short Names (IDs) /^(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-zA-Z0-9+-]{1,10}$/gi Short names , or ID s are made exclusively of a-z , A-Z, 0-1 and +-` characters, and cannot be more than 10 characters. The negative part of the regular expression, (?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+) , is used to differenciate regular blocks (name, short name, etc.) from versions. Names /^(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[ a-zA-Z0-9+-]{1,256}$/gi Names made exclusively of a-z , A-Z , 0-1 , +- and the space characters, and cannot be more than 256 characters. Warning Names should never be used in file names, as it may generate paths which may be very long. The negative part of the regular expression, (?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+) , is used to differenciate regular blocks (name, short name, etc.) from versions. Status and versions /(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+)/gi The first matching group contains the status (and may be empty), and the second group is the version number. Note The string in the first matching group should be dynamically built using the list of available status ID s ( short names ). By default, it should at least contain the default states: NO , STB , TODO , WIP , OK , PUB , V . Extract version from a file name /(?:(_(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+)))(?:\\.[a-z0-9.]+)?$/gi This regular expressions matches everything including the last underscore, the version block and the file extension if any. The first group contains the underscore and the version block; it can be used to be replaced by an empty string in file names to quickly remove the version block from the name. The second and third groups contain the state and the version. Resource names /(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+\\s-]+/gi Resource names can be made of a-z , 0-9 , +- and white spaces but must not start with a version scheme. File names This is the regular expression for validating, matching and decomposing file names. /^([a-z0-9+-]{1,10})_(?:([ASG])_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+-]{1,10}))(?:_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+-]{1,10}))?(?:_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+\\s-]+))?(?:_(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+))?(?:\\.([a-z0-9.]+))?$/gi Here is the list of matching groups: Project ID Type: A (Asset) or S (Shot) or empty (for general items) Asset or Shot ID or empty (for general items) Type: G (General) or empty Step ID Resource name or empty Status or empty Version number or empty Extension or empty If any string does not match this regular expression, it means it does not follow the Ramses naming scheme. Master media file names /^([a-z0-9+-]{1,10})_([a-z0-9]{1,10})(?:-([a-z0-9]{1,10})?)_(\\d+)x(\\d+)(i|p)?_(\\d+\\.?\\d*)(?:fps)?(?:_([a-z]+))?(?:_([a-z]+)st)\\.([a-z0-9.]+)/gi Here is the list of matching groups: Project ID Codec ID Colorspace ID Width Height p (progressive), i (interlaced), or empty Framerate Language or empty Subtitles language or empty Extension","title":"Naming"},{"location":"dev/files/naming/#regular-expressions-for-files-and-folder-naming","text":"Ramses uses specific file and folder naming conventions . Here are useful regular expressions to manipulate them. Note All names used by Ramses should be compated ignoring the case. Thus all regular expressions should use the i flag. Regular Expressions for files and folder naming. Short Names (IDs) Names Status and versions Extract version from a file name Resource names File names Master media file names","title":"Regular Expressions for files and folder naming."},{"location":"dev/files/naming/#short-names-ids","text":"/^(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-zA-Z0-9+-]{1,10}$/gi Short names , or ID s are made exclusively of a-z , A-Z, 0-1 and +-` characters, and cannot be more than 10 characters. The negative part of the regular expression, (?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+) , is used to differenciate regular blocks (name, short name, etc.) from versions.","title":"Short Names (IDs)"},{"location":"dev/files/naming/#names","text":"/^(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[ a-zA-Z0-9+-]{1,256}$/gi Names made exclusively of a-z , A-Z , 0-1 , +- and the space characters, and cannot be more than 256 characters. Warning Names should never be used in file names, as it may generate paths which may be very long. The negative part of the regular expression, (?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+) , is used to differenciate regular blocks (name, short name, etc.) from versions.","title":"Names"},{"location":"dev/files/naming/#status-and-versions","text":"/(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+)/gi The first matching group contains the status (and may be empty), and the second group is the version number. Note The string in the first matching group should be dynamically built using the list of available status ID s ( short names ). By default, it should at least contain the default states: NO , STB , TODO , WIP , OK , PUB , V .","title":"Status and versions"},{"location":"dev/files/naming/#extract-version-from-a-file-name","text":"/(?:(_(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+)))(?:\\.[a-z0-9.]+)?$/gi This regular expressions matches everything including the last underscore, the version block and the file extension if any. The first group contains the underscore and the version block; it can be used to be replaced by an empty string in file names to quickly remove the version block from the name. The second and third groups contain the state and the version.","title":"Extract version from a file name"},{"location":"dev/files/naming/#resource-names","text":"/(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+\\s-]+/gi Resource names can be made of a-z , 0-9 , +- and white spaces but must not start with a version scheme.","title":"Resource names"},{"location":"dev/files/naming/#file-names","text":"This is the regular expression for validating, matching and decomposing file names. /^([a-z0-9+-]{1,10})_(?:([ASG])_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+-]{1,10}))(?:_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+-]{1,10}))?(?:_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+\\s-]+))?(?:_(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+))?(?:\\.([a-z0-9.]+))?$/gi Here is the list of matching groups: Project ID Type: A (Asset) or S (Shot) or empty (for general items) Asset or Shot ID or empty (for general items) Type: G (General) or empty Step ID Resource name or empty Status or empty Version number or empty Extension or empty If any string does not match this regular expression, it means it does not follow the Ramses naming scheme.","title":"File names"},{"location":"dev/files/naming/#master-media-file-names","text":"/^([a-z0-9+-]{1,10})_([a-z0-9]{1,10})(?:-([a-z0-9]{1,10})?)_(\\d+)x(\\d+)(i|p)?_(\\d+\\.?\\d*)(?:fps)?(?:_([a-z]+))?(?:_([a-z]+)st)\\.([a-z0-9.]+)/gi Here is the list of matching groups: Project ID Codec ID Colorspace ID Width Height p (progressive), i (interlaced), or empty Framerate Language or empty Subtitles language or empty Extension","title":"Master media file names"},{"location":"dev/server-reference/","text":"Ramses Server API The Ramses Server is used to backup and sync data across Ramses Applications and workstations. It provides a standard http(s) REST API . If you\u2019re developping your own client (or contributing to Ramses Client ), you can easily exchange data with the server using this reference. Queries must be a POST request ; the body must be JSON encoded, the Content-Type being application/json . Only one attribute must be set directly in the URL (like a GET request), the name of the query itself. For now, the server only supports the UTF-8 charset, so it is not mandatory to add the charset in the Content-Type , and any value other than utf-8 will be ignored. This may change in future versions. Queries The server provides a single endpoint, which is the root of the folder where it\u2019s installed. For example, for a server installed in a folder called example on the server at https://ramses.rxlab.io , the endpoint will be https://ramses.rxlab.io/example . To query the server, you only need to add the query name as a parameter to this URL . For example, the URL for the ping query is https://ramses.rxlab.io/example/?ping . All queries must be accompanied with a JSON object in the post body, containing at least these values: { \"version\": \"0.6.0\" } version : version of the client connected to the server. Replies The server replies to all queries with a JSON object, containing these values: { \"accepted\": true, \"success\": true, \"message\": \"Server ready.\", \"query\": \"ping\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } accepted : boolean . True if the server has recognized the query and accepted it. Will be False if the query does not exist. success : boolean . True if the server has successfully processed the query, False in case of any error. message : string . A short feedback about the result, which can be shown to the user by the client. query : string . The query that was made that the server is replying to. content : object . The actual content of the reply, which varies depending on the query. Read this reference for more details. serverUuid : string . The universal unique identifier of this server. This value can be used to make sure a local DB/client connects to the right server and avoid corrupting data by mixing servers. debug : array of objects . Server (debug) logs. Debug and logs The debug value of the reply is an array containing these objects: { \"date\": \"2022-11-25 13:05:24\", \"level\": \"DEBUG\", \"message\": \"A debug log entry\" } date : string . The date and time of the log entry. level : string . One of \"DATA\" , \"DEBUG\" , \"INFO\" , \"WARNING\" , \"CRITICAL\" , \"FATAL\" . The minimum level of the logs is \"WARNING\" by default (e.g. Data , Debug and Info logs won\u2019t be returned) and can be changed in the config file . lessage : string . The log entry. Syncing data This is the process to sync data with the server. ping to check if the server is available and check its version. This is mandatory to initiate the session before being able to log in. login to authenticate yourself. sync your data. For the examples in this documentation, we assume the ramses server is available at https://ramses.rxlab.io/example/ . Note For the sake of readability, the JSON replies are pretty formatted with indentation and new lines in this documentation, but the server actually uses one-line replies. ping Query: https://ramses.rxlab.io/example/?ping Request body { \"version\": \"0.6.0\" } version : version of the client. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Server ready.\", \"query\": \"ping\", \"content\": { \"installed\": true, \"version\": \"0.6.0\" }, \"serverUuid\": \"unique-uid\", \"debug\": [] } installed is false if the server has not been correctly installed yet. version is the version of the server, which should match the version of the client. login Query: https://ramses.rxlab.io/example/?login Request body { \"version\": \"0.6.0\", \"username\": \"Duduf\", \"password\": \"123456\" } version : version of the client. username : user name. password : user password. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Successful login. Welcome Duduf!\", \"query\": \"login\", \"content\": { \"username\": \"Duduf\", \"uuid\": \"uuid\", \"token\": \"token\" }, \"serverUuid\": \"unique-uid\", \"debug\": [] } username : the user name of the user. uuid : the uuid of the user. token : a token which must be associated with sync queries later. sync Query: https://ramses.rxlab.io/example/?sync Request body { \"version\": \"0.6.0\", \"token\": \"token\", \"previousSyncDate\": \"2022-06-15 15:44:23\", \"tables\":[ { \"name\": \"RamApplication\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamStep\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamUser\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"userName\": \"Duf\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"userName\": \"Ana\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] } ] } version : version of the client. token : the token got with login . previousSyncDate : the date and time of the previous sync. tables : the list of tables to sync. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Data sync, OK!\", \"query\": \"sync\", \"content\": { \"tables\":[ { \"name\": \"RamApplication\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-08-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-26 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamStep\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-08-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-26 15:44:23\", \"removed\": 1 } ] } ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tables : the list of tables to sync. The modifiedRows are the rows which have been changed or added to the table since the previous sync. clean Query: https://ramses.rxlab.io/example/?clean Deletes rows from tables, using the objects\u2019 uuids. Request body { \"version\": \"0.6.0\", \"token\": \"token\", \"tables\": [ { \"name\": \"tableName\", \"rows\": [\"uuid1\", \"uuid2\", \"uuid3\"] }, { \"name\": \"otherTable\", \"rows\": [\"uuid4\", \"uuid5\", \"uuid6\"] } ] } Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Cleaned data, removed 6 rows.\", \"query\": \"clean\", \"content\": { \"count\": 6 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } count : the number of deleted rows. setPassword Query: https://ramses.rxlab.io/example/?setPassword Request body { \"version\": \"0.6.0\", \"token\": \"token\", \"newPassword\": \"new password\", \"currentPassword\": \"current password\", \"uuid\": \"user-unique-uid\" } version : version of the client. token : the token got with login . newPassword : the new password to set. currentPassword : the current password of the user. uuid : the user UUID . The server will check if the connected user is an administrator, and accept the request accordingly: If the connected user is the same as the user changing its password, the current password is mandatory and will be checked before making any change. If the connected user is not the same as the new password, the request will be accepted if and only if the connected user has the administrator role. In this case, the current password is not mandatory. That means if there\u2019s only one administrator, who has forgotten its current password, only the server provider - someone who has an actual access to the server files (via FTP for example) - can set a new password, using Ramses Server development tools.","title":"Server API"},{"location":"dev/server-reference/#ramses-server-api","text":"The Ramses Server is used to backup and sync data across Ramses Applications and workstations. It provides a standard http(s) REST API . If you\u2019re developping your own client (or contributing to Ramses Client ), you can easily exchange data with the server using this reference. Queries must be a POST request ; the body must be JSON encoded, the Content-Type being application/json . Only one attribute must be set directly in the URL (like a GET request), the name of the query itself. For now, the server only supports the UTF-8 charset, so it is not mandatory to add the charset in the Content-Type , and any value other than utf-8 will be ignored. This may change in future versions.","title":"Ramses Server API"},{"location":"dev/server-reference/#queries","text":"The server provides a single endpoint, which is the root of the folder where it\u2019s installed. For example, for a server installed in a folder called example on the server at https://ramses.rxlab.io , the endpoint will be https://ramses.rxlab.io/example . To query the server, you only need to add the query name as a parameter to this URL . For example, the URL for the ping query is https://ramses.rxlab.io/example/?ping . All queries must be accompanied with a JSON object in the post body, containing at least these values: { \"version\": \"0.6.0\" } version : version of the client connected to the server.","title":"Queries"},{"location":"dev/server-reference/#replies","text":"The server replies to all queries with a JSON object, containing these values: { \"accepted\": true, \"success\": true, \"message\": \"Server ready.\", \"query\": \"ping\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } accepted : boolean . True if the server has recognized the query and accepted it. Will be False if the query does not exist. success : boolean . True if the server has successfully processed the query, False in case of any error. message : string . A short feedback about the result, which can be shown to the user by the client. query : string . The query that was made that the server is replying to. content : object . The actual content of the reply, which varies depending on the query. Read this reference for more details. serverUuid : string . The universal unique identifier of this server. This value can be used to make sure a local DB/client connects to the right server and avoid corrupting data by mixing servers. debug : array of objects . Server (debug) logs.","title":"Replies"},{"location":"dev/server-reference/#debug-and-logs","text":"The debug value of the reply is an array containing these objects: { \"date\": \"2022-11-25 13:05:24\", \"level\": \"DEBUG\", \"message\": \"A debug log entry\" } date : string . The date and time of the log entry. level : string . One of \"DATA\" , \"DEBUG\" , \"INFO\" , \"WARNING\" , \"CRITICAL\" , \"FATAL\" . The minimum level of the logs is \"WARNING\" by default (e.g. Data , Debug and Info logs won\u2019t be returned) and can be changed in the config file . lessage : string . The log entry.","title":"Debug and logs"},{"location":"dev/server-reference/#syncing-data","text":"This is the process to sync data with the server. ping to check if the server is available and check its version. This is mandatory to initiate the session before being able to log in. login to authenticate yourself. sync your data. For the examples in this documentation, we assume the ramses server is available at https://ramses.rxlab.io/example/ . Note For the sake of readability, the JSON replies are pretty formatted with indentation and new lines in this documentation, but the server actually uses one-line replies.","title":"Syncing data"},{"location":"dev/server-reference/#ping","text":"Query: https://ramses.rxlab.io/example/?ping","title":"ping"},{"location":"dev/server-reference/#request-body","text":"{ \"version\": \"0.6.0\" } version : version of the client.","title":"Request body"},{"location":"dev/server-reference/#reply","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Server ready.\", \"query\": \"ping\", \"content\": { \"installed\": true, \"version\": \"0.6.0\" }, \"serverUuid\": \"unique-uid\", \"debug\": [] } installed is false if the server has not been correctly installed yet. version is the version of the server, which should match the version of the client.","title":"Reply"},{"location":"dev/server-reference/#login","text":"Query: https://ramses.rxlab.io/example/?login","title":"login"},{"location":"dev/server-reference/#request-body_1","text":"{ \"version\": \"0.6.0\", \"username\": \"Duduf\", \"password\": \"123456\" } version : version of the client. username : user name. password : user password.","title":"Request body"},{"location":"dev/server-reference/#reply_1","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Successful login. Welcome Duduf!\", \"query\": \"login\", \"content\": { \"username\": \"Duduf\", \"uuid\": \"uuid\", \"token\": \"token\" }, \"serverUuid\": \"unique-uid\", \"debug\": [] } username : the user name of the user. uuid : the uuid of the user. token : a token which must be associated with sync queries later.","title":"Reply"},{"location":"dev/server-reference/#sync","text":"Query: https://ramses.rxlab.io/example/?sync","title":"sync"},{"location":"dev/server-reference/#request-body_2","text":"{ \"version\": \"0.6.0\", \"token\": \"token\", \"previousSyncDate\": \"2022-06-15 15:44:23\", \"tables\":[ { \"name\": \"RamApplication\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamStep\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamUser\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"userName\": \"Duf\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"userName\": \"Ana\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] } ] } version : version of the client. token : the token got with login . previousSyncDate : the date and time of the previous sync. tables : the list of tables to sync.","title":"Request body"},{"location":"dev/server-reference/#reply_2","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Data sync, OK!\", \"query\": \"sync\", \"content\": { \"tables\":[ { \"name\": \"RamApplication\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-08-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-26 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamStep\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-08-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-26 15:44:23\", \"removed\": 1 } ] } ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tables : the list of tables to sync. The modifiedRows are the rows which have been changed or added to the table since the previous sync.","title":"Reply"},{"location":"dev/server-reference/#clean","text":"Query: https://ramses.rxlab.io/example/?clean Deletes rows from tables, using the objects\u2019 uuids.","title":"clean"},{"location":"dev/server-reference/#request-body_3","text":"{ \"version\": \"0.6.0\", \"token\": \"token\", \"tables\": [ { \"name\": \"tableName\", \"rows\": [\"uuid1\", \"uuid2\", \"uuid3\"] }, { \"name\": \"otherTable\", \"rows\": [\"uuid4\", \"uuid5\", \"uuid6\"] } ] }","title":"Request body"},{"location":"dev/server-reference/#reply_3","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Cleaned data, removed 6 rows.\", \"query\": \"clean\", \"content\": { \"count\": 6 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } count : the number of deleted rows.","title":"Reply"},{"location":"dev/server-reference/#setpassword","text":"Query: https://ramses.rxlab.io/example/?setPassword","title":"setPassword"},{"location":"dev/server-reference/#request-body_4","text":"{ \"version\": \"0.6.0\", \"token\": \"token\", \"newPassword\": \"new password\", \"currentPassword\": \"current password\", \"uuid\": \"user-unique-uid\" } version : version of the client. token : the token got with login . newPassword : the new password to set. currentPassword : the current password of the user. uuid : the user UUID . The server will check if the connected user is an administrator, and accept the request accordingly: If the connected user is the same as the user changing its password, the current password is mandatory and will be checked before making any change. If the connected user is not the same as the new password, the request will be accepted if and only if the connected user has the administrator role. In this case, the current password is not mandatory. That means if there\u2019s only one administrator, who has forgotten its current password, only the server provider - someone who has an actual access to the server files (via FTP for example) - can set a new password, using Ramses Server development tools.","title":"Request body"},{"location":"licenses/gfdl/","text":"GNU Free Documentation License Version 1.3, 3 November 2008 Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 0. PREAMBLE The purpose of this License is to make a manual, textbook, or other functional and useful document \u201cfree\u201d in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of \u201ccopyleft\u201d, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. 1. APPLICABILITY AND DEFINITIONS This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The \u201cDocument\u201d, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as \u201cyou\u201d. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. A \u201cModified Version\u201d of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. A \u201cSecondary Section\u201d is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document\u2019s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The \u201cInvariant Sections\u201d are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The \u201cCover Texts\u201d are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A \u201cTransparent\u201d copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not \u201cTransparent\u201d is called \u201cOpaque\u201d. Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The \u201cTitle Page\u201d means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, \u201cTitle Page\u201d means the text near the most prominent appearance of the work\u2019s title, preceding the beginning of the body of the text. The \u201cpublisher\u201d means any person or entity that distributes copies of the Document to the public. A section \u201cEntitled XYZ\u201d means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as \u201cAcknowledgements\u201d, \u201cDedications\u201d, \u201cEndorsements\u201d, or \u201cHistory\u201d.) To \u201cPreserve the Title\u201d of such a section when you modify the Document means that it remains a section \u201cEntitled XYZ\u201d according to this definition. The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License. 2. VERBATIM COPYING You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. You may also lend copies, under the same conditions stated above, and you may publicly display copies. 3. COPYING IN QUANTITY If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document\u2019s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. 4. MODIFICATIONS You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement. C. State on the Title page the name of the publisher of the Modified Version, as the publisher. D. Preserve all the copyright notices of the Document. E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document\u2019s license notice. H. Include an unaltered copy of this License. I. Preserve the section Entitled \u201cHistory\u201d, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled \u201cHistory\u201d in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the \u201cHistory\u201d section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission. K. For any section Entitled \u201cAcknowledgements\u201d or \u201cDedications\u201d, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. M. Delete any section Entitled \u201cEndorsements\u201d. Such a section may not be included in the Modified Version. N. Do not retitle any existing section to be Entitled \u201cEndorsements\u201d or to conflict in title with any Invariant Section. O. Preserve any Warranty Disclaimers. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version\u2019s license notice. These titles must be distinct from any other section titles. You may add a section Entitled \u201cEndorsements\u201d, provided it contains nothing but endorsements of your Modified Version by various parties\u00e2\u20ac\u201dfor example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections Entitled \u201cHistory\u201d in the various original documents, forming one section Entitled \u201cHistory\u201d; likewise combine any sections Entitled \u201cAcknowledgements\u201d, and any sections Entitled \u201cDedications\u201d. You must delete all sections Entitled \u201cEndorsements\u201d. 6. COLLECTIONS OF DOCUMENTS You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. 7. AGGREGATION WITH INDEPENDENT WORKS A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an \u201caggregate\u201d if the copyright resulting from the compilation is not used to limit the legal rights of the compilation\u2019s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document\u2019s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate. 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. If a section in the Document is Entitled \u201cAcknowledgements\u201d, \u201cDedications\u201d, or \u201cHistory\u201d, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title. 9. TERMINATION You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License. However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it. 10. FUTURE REVISIONS OF THIS LICENSE The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/ . Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License \u201cor any later version\u201d applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy\u2019s public statement of acceptance of a version permanently authorizes you to choose that version for the Document. 11. RELICENSING \u201cMassive Multiauthor Collaboration Site\u201d (or \u201cMMC Site\u201d) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A \u201cMassive Multiauthor Collaboration\u201d (or \u201cMMC\u201d) contained in the site means any set of copyrightable works thus published on the MMC site. \u201cCC-BY-SA\u201d means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization. \u201cIncorporate\u201d means to publish or republish a Document, in whole or in part, as part of another Document. An MMC is \u201celigible for relicensing\u201d if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008. The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing. ADDENDUM: How to use this License for your documents To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: Copyright (C) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled \"GNU Free Documentation License\". If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the \u201cwith \u00e2\u20ac\u00a6 Texts.\u201d line with this: with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.","title":"Documentation license"},{"location":"licenses/gfdl/#gnu-free-documentation-license","text":"Version 1.3, 3 November 2008 Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.","title":"GNU Free Documentation License"},{"location":"licenses/gfdl/#0-preamble","text":"The purpose of this License is to make a manual, textbook, or other functional and useful document \u201cfree\u201d in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of \u201ccopyleft\u201d, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.","title":"0. PREAMBLE"},{"location":"licenses/gfdl/#1-applicability-and-definitions","text":"This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The \u201cDocument\u201d, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as \u201cyou\u201d. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. A \u201cModified Version\u201d of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. A \u201cSecondary Section\u201d is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document\u2019s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The \u201cInvariant Sections\u201d are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The \u201cCover Texts\u201d are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A \u201cTransparent\u201d copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not \u201cTransparent\u201d is called \u201cOpaque\u201d. Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The \u201cTitle Page\u201d means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, \u201cTitle Page\u201d means the text near the most prominent appearance of the work\u2019s title, preceding the beginning of the body of the text. The \u201cpublisher\u201d means any person or entity that distributes copies of the Document to the public. A section \u201cEntitled XYZ\u201d means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as \u201cAcknowledgements\u201d, \u201cDedications\u201d, \u201cEndorsements\u201d, or \u201cHistory\u201d.) To \u201cPreserve the Title\u201d of such a section when you modify the Document means that it remains a section \u201cEntitled XYZ\u201d according to this definition. The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.","title":"1. APPLICABILITY AND DEFINITIONS"},{"location":"licenses/gfdl/#2-verbatim-copying","text":"You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. You may also lend copies, under the same conditions stated above, and you may publicly display copies.","title":"2. VERBATIM COPYING"},{"location":"licenses/gfdl/#3-copying-in-quantity","text":"If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document\u2019s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.","title":"3. COPYING IN QUANTITY"},{"location":"licenses/gfdl/#4-modifications","text":"You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement. C. State on the Title page the name of the publisher of the Modified Version, as the publisher. D. Preserve all the copyright notices of the Document. E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document\u2019s license notice. H. Include an unaltered copy of this License. I. Preserve the section Entitled \u201cHistory\u201d, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled \u201cHistory\u201d in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the \u201cHistory\u201d section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission. K. For any section Entitled \u201cAcknowledgements\u201d or \u201cDedications\u201d, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. M. Delete any section Entitled \u201cEndorsements\u201d. Such a section may not be included in the Modified Version. N. Do not retitle any existing section to be Entitled \u201cEndorsements\u201d or to conflict in title with any Invariant Section. O. Preserve any Warranty Disclaimers. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version\u2019s license notice. These titles must be distinct from any other section titles. You may add a section Entitled \u201cEndorsements\u201d, provided it contains nothing but endorsements of your Modified Version by various parties\u00e2\u20ac\u201dfor example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.","title":"4. MODIFICATIONS"},{"location":"licenses/gfdl/#5-combining-documents","text":"You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections Entitled \u201cHistory\u201d in the various original documents, forming one section Entitled \u201cHistory\u201d; likewise combine any sections Entitled \u201cAcknowledgements\u201d, and any sections Entitled \u201cDedications\u201d. You must delete all sections Entitled \u201cEndorsements\u201d.","title":"5. COMBINING DOCUMENTS"},{"location":"licenses/gfdl/#6-collections-of-documents","text":"You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.","title":"6. COLLECTIONS OF DOCUMENTS"},{"location":"licenses/gfdl/#7-aggregation-with-independent-works","text":"A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an \u201caggregate\u201d if the copyright resulting from the compilation is not used to limit the legal rights of the compilation\u2019s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document\u2019s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.","title":"7. AGGREGATION WITH INDEPENDENT WORKS"},{"location":"licenses/gfdl/#8-translation","text":"Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. If a section in the Document is Entitled \u201cAcknowledgements\u201d, \u201cDedications\u201d, or \u201cHistory\u201d, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.","title":"8. TRANSLATION"},{"location":"licenses/gfdl/#9-termination","text":"You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License. However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.","title":"9. TERMINATION"},{"location":"licenses/gfdl/#10-future-revisions-of-this-license","text":"The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/ . Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License \u201cor any later version\u201d applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy\u2019s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.","title":"10. FUTURE REVISIONS OF THIS LICENSE"},{"location":"licenses/gfdl/#11-relicensing","text":"\u201cMassive Multiauthor Collaboration Site\u201d (or \u201cMMC Site\u201d) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A \u201cMassive Multiauthor Collaboration\u201d (or \u201cMMC\u201d) contained in the site means any set of copyrightable works thus published on the MMC site. \u201cCC-BY-SA\u201d means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization. \u201cIncorporate\u201d means to publish or republish a Document, in whole or in part, as part of another Document. An MMC is \u201celigible for relicensing\u201d if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008. The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.","title":"11. RELICENSING"},{"location":"licenses/gfdl/#addendum-how-to-use-this-license-for-your-documents","text":"To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: Copyright (C) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled \"GNU Free Documentation License\". If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the \u201cwith \u00e2\u20ac\u00a6 Texts.\u201d line with this: with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.","title":"ADDENDUM: How to use this License for your documents"},{"location":"licenses/gnu-gpl/","text":"GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program\u2013to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers\u2019 and authors\u2019 protection, the GPL clearly explains that there is no warranty for this free software. For both users\u2019 and authors\u2019 sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users\u2019 freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. \u201cThis License\u201d refers to version 3 of the GNU General Public License. \u201cCopyright\u201d also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. \u201cThe Program\u201d refers to any copyrightable work licensed under this License. Each licensee is addressed as \u201cyou\u201d. \u201cLicensees\u201d and \u201crecipients\u201d may be individuals or organizations. To \u201cmodify\u201d a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a \u201cmodified version\u201d of the earlier work or a work \u201cbased on\u201d the earlier work. A \u201ccovered work\u201d means either the unmodified Program or a work based on the Program. To \u201cpropagate\u201d a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To \u201cconvey\u201d a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays \u201cAppropriate Legal Notices\u201d to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The \u201csource code\u201d for a work means the preferred form of the work for making modifications to it. \u201cObject code\u201d means any non-source form of a work. A \u201cStandard Interface\u201d means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The \u201cSystem Libraries\u201d of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A \u201cMajor Component\u201d, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The \u201cCorresponding Source\u201d for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work\u2019s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users\u2019 Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work\u2019s users, your or third parties\u2019 legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program\u2019s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to \u201ckeep intact all notices\u201d. c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an \u201caggregate\u201d if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation\u2019s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A \u201cUser Product\u201d is either (1) a \u201cconsumer product\u201d, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, \u201cnormally used\u201d refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. \u201cInstallation Information\u201d for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. \u201cAdditional permissions\u201d are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered \u201cfurther restrictions\u201d within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An \u201centity transaction\u201d is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party\u2019s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A \u201ccontributor\u201d is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor\u2019s \u201ccontributor version\u201d. A contributor\u2019s \u201cessential patent claims\u201d are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, \u201ccontrol\u201d includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor\u2019s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a \u201cpatent license\u201d is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To \u201cgrant\u201d such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. \u201cKnowingly relying\u201d means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient\u2019s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is \u201cdiscriminatory\u201d if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others\u2019 Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License \u201cor any later version\u201d applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy\u2019s public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \u201cAS IS\u201d WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the \u201ccopyright\u201d line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w\u2019 and `show c\u2019 should show the appropriate parts of the General Public License. Of course, your program\u2019s commands might be different; for a GUI interface, you would use an \u201cabout box\u201d. You should also get your employer (if you work as a programmer) or school, if any, to sign a \u201ccopyright disclaimer\u201d for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see https://www.gnu.org/licenses/ . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read https://www.gnu.org/licenses/why-not-lgpl.html .","title":"GNU GPLv3"},{"location":"licenses/gnu-gpl/#gnu-general-public-license","text":"Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.","title":"GNU GENERAL PUBLIC LICENSE"},{"location":"licenses/gnu-gpl/#preamble","text":"The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program\u2013to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers\u2019 and authors\u2019 protection, the GPL clearly explains that there is no warranty for this free software. For both users\u2019 and authors\u2019 sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users\u2019 freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow.","title":"Preamble"},{"location":"licenses/gnu-gpl/#terms-and-conditions","text":"","title":"TERMS AND CONDITIONS"},{"location":"licenses/gnu-gpl/#0-definitions","text":"\u201cThis License\u201d refers to version 3 of the GNU General Public License. \u201cCopyright\u201d also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. \u201cThe Program\u201d refers to any copyrightable work licensed under this License. Each licensee is addressed as \u201cyou\u201d. \u201cLicensees\u201d and \u201crecipients\u201d may be individuals or organizations. To \u201cmodify\u201d a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a \u201cmodified version\u201d of the earlier work or a work \u201cbased on\u201d the earlier work. A \u201ccovered work\u201d means either the unmodified Program or a work based on the Program. To \u201cpropagate\u201d a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To \u201cconvey\u201d a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays \u201cAppropriate Legal Notices\u201d to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.","title":"0. Definitions."},{"location":"licenses/gnu-gpl/#1-source-code","text":"The \u201csource code\u201d for a work means the preferred form of the work for making modifications to it. \u201cObject code\u201d means any non-source form of a work. A \u201cStandard Interface\u201d means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The \u201cSystem Libraries\u201d of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A \u201cMajor Component\u201d, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The \u201cCorresponding Source\u201d for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work\u2019s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work.","title":"1. Source Code."},{"location":"licenses/gnu-gpl/#2-basic-permissions","text":"All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.","title":"2. Basic Permissions."},{"location":"licenses/gnu-gpl/#3-protecting-users-legal-rights-from-anti-circumvention-law","text":"No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work\u2019s users, your or third parties\u2019 legal rights to forbid circumvention of technological measures.","title":"3. Protecting Users' Legal Rights From Anti-Circumvention Law."},{"location":"licenses/gnu-gpl/#4-conveying-verbatim-copies","text":"You may convey verbatim copies of the Program\u2019s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.","title":"4. Conveying Verbatim Copies."},{"location":"licenses/gnu-gpl/#5-conveying-modified-source-versions","text":"You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to \u201ckeep intact all notices\u201d. c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an \u201caggregate\u201d if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation\u2019s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.","title":"5. Conveying Modified Source Versions."},{"location":"licenses/gnu-gpl/#6-conveying-non-source-forms","text":"You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A \u201cUser Product\u201d is either (1) a \u201cconsumer product\u201d, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, \u201cnormally used\u201d refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. \u201cInstallation Information\u201d for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.","title":"6. Conveying Non-Source Forms."},{"location":"licenses/gnu-gpl/#7-additional-terms","text":"\u201cAdditional permissions\u201d are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered \u201cfurther restrictions\u201d within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.","title":"7. Additional Terms."},{"location":"licenses/gnu-gpl/#8-termination","text":"You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.","title":"8. Termination."},{"location":"licenses/gnu-gpl/#9-acceptance-not-required-for-having-copies","text":"You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.","title":"9. Acceptance Not Required for Having Copies."},{"location":"licenses/gnu-gpl/#10-automatic-licensing-of-downstream-recipients","text":"Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An \u201centity transaction\u201d is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party\u2019s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.","title":"10. Automatic Licensing of Downstream Recipients."},{"location":"licenses/gnu-gpl/#11-patents","text":"A \u201ccontributor\u201d is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor\u2019s \u201ccontributor version\u201d. A contributor\u2019s \u201cessential patent claims\u201d are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, \u201ccontrol\u201d includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor\u2019s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a \u201cpatent license\u201d is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To \u201cgrant\u201d such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. \u201cKnowingly relying\u201d means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient\u2019s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is \u201cdiscriminatory\u201d if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.","title":"11. Patents."},{"location":"licenses/gnu-gpl/#12-no-surrender-of-others-freedom","text":"If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.","title":"12. No Surrender of Others' Freedom."},{"location":"licenses/gnu-gpl/#13-use-with-the-gnu-affero-general-public-license","text":"Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.","title":"13. Use with the GNU Affero General Public License."},{"location":"licenses/gnu-gpl/#14-revised-versions-of-this-license","text":"The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License \u201cor any later version\u201d applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy\u2019s public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.","title":"14. Revised Versions of this License."},{"location":"licenses/gnu-gpl/#15-disclaimer-of-warranty","text":"THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \u201cAS IS\u201d WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.","title":"15. Disclaimer of Warranty."},{"location":"licenses/gnu-gpl/#16-limitation-of-liability","text":"IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.","title":"16. Limitation of Liability."},{"location":"licenses/gnu-gpl/#17-interpretation-of-sections-15-and-16","text":"If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS","title":"17. Interpretation of Sections 15 and 16."},{"location":"licenses/gnu-gpl/#how-to-apply-these-terms-to-your-new-programs","text":"If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the \u201ccopyright\u201d line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w\u2019 and `show c\u2019 should show the appropriate parts of the General Public License. Of course, your program\u2019s commands might be different; for a GUI interface, you would use an \u201cabout box\u201d. You should also get your employer (if you work as a programmer) or school, if any, to sign a \u201ccopyright disclaimer\u201d for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see https://www.gnu.org/licenses/ . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read https://www.gnu.org/licenses/why-not-lgpl.html .","title":"How to Apply These Terms to Your New Programs"},{"location":"pipeline/","text":"Ramses - The Rx Asset Management System: Introduction Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . This first part of the Ramses documention intents to help you understand the general concepts and key features of Ramses without going into technical details. As Ramses is not made of one single application but of several components, the technical description and user guide of each piece of software is available individually in the second part of this documentation . Features Ramses has three different main features, which are closely related and for which each component plays its role: Pipeline automation , Production Tracking and Production Planning , along with the global administration of course. \u25b9 Administration . \u25b9 Pipeline . \u25b9 Production Tracking . \u25b9 Planning . The components Ramses is a complete framework made of several components, as you can see on the image above. Each component has to be installed individually, and not all components are mandatory to use Ramses . Here is the list of all the components along with a few notes about them. Component Relations Description Technical Documentation Ramses Server Serves the data to the Ramses Client . The server stores and serves all shared data between all workstations in the studio. The Ramses Clients installed on these workstations connect to it to retrieve tha data they need. \u25b9 Read the doc . Ramses Client Application Connects to the Ramses Server to share the data. Serves the data that the Ramses Add-ons need to automate the pipeline. The client application is the central node of the Ramses framework. All information is available through the application, and it is able to drive the Ramses Add-ons in the creative applications. Note that it can be used stand-alone in an offline mode without the server, for one-man bands. \u25b9 Read the doc . Ramses Add-ons Connect to the Ramses Client to get the data they need to automate the pipeline. The add-ons integrate Ramses into your favorite creative applications (3D or 2D Animation, designing, compositing software, etc.). They can automate your workflow, and they handle all the file versionning, while providing production tracking data to the Ramses client . \u25b9 Read the doc . Ramses Tree Read by the Ramses Add-ons and the Ramses Client . The Ramses Tree is the way Ramses stores and sorts your files. Thanks to a carefully crafted file and folder naming scheme and conventions, both the Ramses Add-ons and the Ramses Client can efficiently handle all your files and data. \u25b9 Read the doc . Hint Ramses is not meant to be available as a service : we believe you should stay in control of your own data without relying onto unknown people, even people as loving as us (and you won\u2019t have to pay mensual or annual fees just to use Ramses ). Even if you\u2019re running your own small studio or tiny collective, it\u2019s very easy to install and use the Ramses server, it can be done on any computer running Windows , Linux or Mac OS , or better, on any low-cost shared hosting with just a very small available space and a small SQL database. All the installation procedure is explained in the server documentation . This being said, we (will soon) also have a few options for servers we can install and manage for you at a very low cost . Installation In order to use Ramses , you have to install the components you need individually, one after each other. Component Installation notes Ramses Server Requires a standard AMP stack ( Apache , MySQL , PHP ). You can install the Ramses server easily: \u25b9 Installation guide Ramses Client The client is a simple application, installed the same way as other applications: \u25b9 Installation guide Ramses Add-ons Add-ons installation differs depending on the host application: \u25b9 Maya installation \u25b9 Other hosts coming soon!","title":"Introduction"},{"location":"pipeline/#ramses-the-rx-asset-management-system-introduction","text":"Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . This first part of the Ramses documention intents to help you understand the general concepts and key features of Ramses without going into technical details. As Ramses is not made of one single application but of several components, the technical description and user guide of each piece of software is available individually in the second part of this documentation .","title":"Ramses - The Rx Asset Management System: Introduction"},{"location":"pipeline/#features","text":"Ramses has three different main features, which are closely related and for which each component plays its role: Pipeline automation , Production Tracking and Production Planning , along with the global administration of course. \u25b9 Administration . \u25b9 Pipeline . \u25b9 Production Tracking . \u25b9 Planning .","title":"Features"},{"location":"pipeline/#the-components","text":"Ramses is a complete framework made of several components, as you can see on the image above. Each component has to be installed individually, and not all components are mandatory to use Ramses . Here is the list of all the components along with a few notes about them. Component Relations Description Technical Documentation Ramses Server Serves the data to the Ramses Client . The server stores and serves all shared data between all workstations in the studio. The Ramses Clients installed on these workstations connect to it to retrieve tha data they need. \u25b9 Read the doc . Ramses Client Application Connects to the Ramses Server to share the data. Serves the data that the Ramses Add-ons need to automate the pipeline. The client application is the central node of the Ramses framework. All information is available through the application, and it is able to drive the Ramses Add-ons in the creative applications. Note that it can be used stand-alone in an offline mode without the server, for one-man bands. \u25b9 Read the doc . Ramses Add-ons Connect to the Ramses Client to get the data they need to automate the pipeline. The add-ons integrate Ramses into your favorite creative applications (3D or 2D Animation, designing, compositing software, etc.). They can automate your workflow, and they handle all the file versionning, while providing production tracking data to the Ramses client . \u25b9 Read the doc . Ramses Tree Read by the Ramses Add-ons and the Ramses Client . The Ramses Tree is the way Ramses stores and sorts your files. Thanks to a carefully crafted file and folder naming scheme and conventions, both the Ramses Add-ons and the Ramses Client can efficiently handle all your files and data. \u25b9 Read the doc . Hint Ramses is not meant to be available as a service : we believe you should stay in control of your own data without relying onto unknown people, even people as loving as us (and you won\u2019t have to pay mensual or annual fees just to use Ramses ). Even if you\u2019re running your own small studio or tiny collective, it\u2019s very easy to install and use the Ramses server, it can be done on any computer running Windows , Linux or Mac OS , or better, on any low-cost shared hosting with just a very small available space and a small SQL database. All the installation procedure is explained in the server documentation . This being said, we (will soon) also have a few options for servers we can install and manage for you at a very low cost .","title":"The components"},{"location":"pipeline/#installation","text":"In order to use Ramses , you have to install the components you need individually, one after each other. Component Installation notes Ramses Server Requires a standard AMP stack ( Apache , MySQL , PHP ). You can install the Ramses server easily: \u25b9 Installation guide Ramses Client The client is a simple application, installed the same way as other applications: \u25b9 Installation guide Ramses Add-ons Add-ons installation differs depending on the host application: \u25b9 Maya installation \u25b9 Other hosts coming soon!","title":"Installation"},{"location":"pipeline/administration/","text":"Ramses Administration (Projects and Users) The administration panel, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . In order to use Ramses , at least one user and one project are needed; when using the Ramses Client Application , you can also manage other elements. Both users and projects are represented by folders in the Ramses Tree , and Ramses components will list them from the default folders if they can\u2019t get the information from the Ramses Client Application or Ramses Server . Users The list of users is available and can be managed in the Ramses Client Application , under the administration panel (for administrator users) , and by default each user is represented by a folder in the Ramses Tree as shown below. \u250c Ramses Folder \u2502 \u2514\u2500\u252c\u2500 Users # User files \u2502 # The name of the user folders are their individual ID \u2502 \u251c\u2500\u252c\u2500 Duduf # Files for a single user (ID) \u2502 \u2514\u2500\u2500\u2500 Config # Configuration files for this user \u2502 \u251c\u2500\u252c\u2500 John # ID \u2502 \u2514\u2500\u2500\u2500 Config \u2502 \u2514\u2500\u2500\u2500 ... Tip Without using the Ramses Client Application , you can create users by creating their folder in the default location in the Ramses Tree . Each user is represented by its name and ID , and has a role . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The role defines the rights the user has to manage Ramses , the projects, the assets, etc. There are four roles listed below. \u25b9 User management in the Ramses Client Application . Administrator The Administrator has all rights to configure and modify Ramses , especially but non exclusively: Creating, removing projects. Creating, modifying, removing template steps. Creating, modifying, removing users. The Administrator has all other rights from other roles too. Note Althought the administrator has the right to modify all users, he cannot remove himself nor change his own role. Another administrator has to do it. Project Admin The Project Administrator has the necessary rights to configure and modify projects, especially but non exclusively: Modifying projects. Creating, modifying, removing steps. Assigning Users to projects. Creating, modifying, removing Asset Groups. Creating, modifying, removing Sequences. Lead The lead is a user who can manage projects, and has less rights than the administrator : Creating, modifying, removing shots. Creating, modifying, removing assets. Assigning users to assets and shots. Standard User (User) The standard user cannot modify nor remove anything from Ramses , but interacts with shots and assets. Projects Projects represent the final artwork : a feature film or one of its sequence, an episode in a TV series, a short movie, a music video\u2026 They are made of Shots which are in turn made of Assets . Assets and Shots are produced through different Steps which are inter-dependent. Shots are grouped in Sequences , and a project contains at least one sequence. Assets are grouped in Asset Groups (e.g. characters, sets, props\u2026). Note It is not mandatory to use sequences, and for short projects (less than a hundred shots), it is often easier to just have a single sequence. The list of projects is available and can be managed in the Ramses Client Application , under the administration panel (for administrator users) , and by default each project is represented by a folder in the Ramses Tree as shown below. \u250c Ramses Folder \u2502 \u2514\u2500\u252c\u2500 Projects # Project files \u2502 # The name of the project folders are their individual ID \u2502 \u251c\u2500\u2500\u2500 TI # A project (ID) \u2502 \u251c\u2500\u2500\u2500 PPB # Another project (ID) \u2502 \u2514\u2500\u2500\u2500 ... Tip Without using the Ramses Client Application , you can create projects by creating their folder in the default location in the Ramses Tree . Each project is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The projects also have the characteristics of the final video ( width and height in pixels, framerate , duration \u2026). They also have a deadline defining the date when the project has to be finished and delivered. Users can be assigned to specific projects. \u25b9 Project management in the Ramses Client Application .","title":"Administration"},{"location":"pipeline/administration/#ramses-administration-projects-and-users","text":"The administration panel, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . In order to use Ramses , at least one user and one project are needed; when using the Ramses Client Application , you can also manage other elements. Both users and projects are represented by folders in the Ramses Tree , and Ramses components will list them from the default folders if they can\u2019t get the information from the Ramses Client Application or Ramses Server .","title":"Ramses Administration (Projects and Users)"},{"location":"pipeline/administration/#users","text":"The list of users is available and can be managed in the Ramses Client Application , under the administration panel (for administrator users) , and by default each user is represented by a folder in the Ramses Tree as shown below. \u250c Ramses Folder \u2502 \u2514\u2500\u252c\u2500 Users # User files \u2502 # The name of the user folders are their individual ID \u2502 \u251c\u2500\u252c\u2500 Duduf # Files for a single user (ID) \u2502 \u2514\u2500\u2500\u2500 Config # Configuration files for this user \u2502 \u251c\u2500\u252c\u2500 John # ID \u2502 \u2514\u2500\u2500\u2500 Config \u2502 \u2514\u2500\u2500\u2500 ... Tip Without using the Ramses Client Application , you can create users by creating their folder in the default location in the Ramses Tree . Each user is represented by its name and ID , and has a role . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The role defines the rights the user has to manage Ramses , the projects, the assets, etc. There are four roles listed below. \u25b9 User management in the Ramses Client Application .","title":"Users"},{"location":"pipeline/administration/#administrator","text":"The Administrator has all rights to configure and modify Ramses , especially but non exclusively: Creating, removing projects. Creating, modifying, removing template steps. Creating, modifying, removing users. The Administrator has all other rights from other roles too. Note Althought the administrator has the right to modify all users, he cannot remove himself nor change his own role. Another administrator has to do it.","title":"Administrator"},{"location":"pipeline/administration/#project-admin","text":"The Project Administrator has the necessary rights to configure and modify projects, especially but non exclusively: Modifying projects. Creating, modifying, removing steps. Assigning Users to projects. Creating, modifying, removing Asset Groups. Creating, modifying, removing Sequences.","title":"Project Admin"},{"location":"pipeline/administration/#lead","text":"The lead is a user who can manage projects, and has less rights than the administrator : Creating, modifying, removing shots. Creating, modifying, removing assets. Assigning users to assets and shots.","title":"Lead"},{"location":"pipeline/administration/#standard-user-user","text":"The standard user cannot modify nor remove anything from Ramses , but interacts with shots and assets.","title":"Standard User (User)"},{"location":"pipeline/administration/#projects","text":"Projects represent the final artwork : a feature film or one of its sequence, an episode in a TV series, a short movie, a music video\u2026 They are made of Shots which are in turn made of Assets . Assets and Shots are produced through different Steps which are inter-dependent. Shots are grouped in Sequences , and a project contains at least one sequence. Assets are grouped in Asset Groups (e.g. characters, sets, props\u2026). Note It is not mandatory to use sequences, and for short projects (less than a hundred shots), it is often easier to just have a single sequence. The list of projects is available and can be managed in the Ramses Client Application , under the administration panel (for administrator users) , and by default each project is represented by a folder in the Ramses Tree as shown below. \u250c Ramses Folder \u2502 \u2514\u2500\u252c\u2500 Projects # Project files \u2502 # The name of the project folders are their individual ID \u2502 \u251c\u2500\u2500\u2500 TI # A project (ID) \u2502 \u251c\u2500\u2500\u2500 PPB # Another project (ID) \u2502 \u2514\u2500\u2500\u2500 ... Tip Without using the Ramses Client Application , you can create projects by creating their folder in the default location in the Ramses Tree . Each project is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The projects also have the characteristics of the final video ( width and height in pixels, framerate , duration \u2026). They also have a deadline defining the date when the project has to be finished and delivered. Users can be assigned to specific projects. \u25b9 Project management in the Ramses Client Application .","title":"Projects"},{"location":"pipeline/pipeline/","text":"Pipeline The pipeline editor, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . The pipeline describes the way the production of the assets and the shots goes through each step . It actually describes each connection, each pipe between each step, keeping important information like the file type used and its color space for example. In combination with the Ramses Add-ons which integrate Ramses in your favorite creative software, Ramses is able to automate your pipeline , managing the versionning of the files, the exports, imports and all these manual tasks a robot could do for you. The pipeline is made of Steps which are connected together with Pipes . The pipeline also handles your Applications and File types . In the future, Ramses will handle color spaces too. For each pipe, each connection, you can define precisely which file types are to be used, so that the Ramses Add-ons can use this information to automate all exports and imports. The pipes are also used in Production tracking . Ramses Add-ons are also in charge of versionning and creating preview images and videos to be used in other components. The pipeline relies on the Ramses Tree to automatically manage the files and folders. A working folder All working folders should contain a few predefined subfolders, so that Ramses can efficiently handle the versionning and production tracking of all files, assets, and shots. This is a typical working folder (files are not shown): \u250c projectID_A_AssetID_StepID # The working folder, for an asset in this example \u2502 \u251c\u2500\u2500\u2500 _versions # The versionning folder, handled by Ramses. \u2502 # Contains the history and all versions \u251c\u2500\u2500\u2500 _published \u2502 # Contains the published files, to be imported by the next steps \u2514\u2500\u2500\u2500 _preview # Contains media files to be used to preview the work on this step (videos, images...) Ramses Add-ons automatically create and sort the files in these folders when working on an item, but you can manually create and use them, especially the _published and _preview subfolder. Any file added in these folders will be automatically detected and managed by Ramses . Even when not using a Ramses Add-on it is recommended to use this folder structure. All files inside these folders should be correctly named and respect all Ramses naming conventions . \u25b9 More information: The Ramses Tree . Creating a pipeline The creation of a pipeline is better made using the Ramses Client Application and its nodal Pipeline Editor , although it is also possible to use basic pipelines only with Ramses Add-ons or more complex ones thanks to the Add-on API and Ramses extensibility for developpers. A pipeline can be built quite quickly by following these steps: Set the project settings like its resolution and framerate. Create the steps (from scratch or using templates). List the applications which are going to be used. Assign applications to the steps. Connect the steps with pipes. (optional) Set the file types to be used through the pipes. (optional) Create Templates for the steps. (optional) Create default settings for publishing and importing items. (optional) Develop extensions for the Add-ons if you have specific needs for an advanced pipeline with a lot of automations. \u25b9 Pipeline editor in the Ramses Client Application . \u25b9 Available Add-ons . \u25b9 Add-on API for the extension or development of new Add-ons . Project settings From the Ramses Client Application , you can adjust the project settings. Specifically, the Resolution and Framerate can be used by the Add-ons to automatically setup the working files in the creative applications. List steps You can use the Ramses Client Application to list the steps needed to produce the project. Steps represent the stages the assets and shots have to go through before completion, for example Modeling , Rigging , Animation , Lighting \u2026 There are 4 different types of steps: Pre-Production includes all the steps of the work which has to be done to prepare and develop the project, but which will not actually be included in the project (for example: the storyboard, the script, etc.). Pre-production steps aren\u2019t linked to assets nor shots, but work on the project as a whole. Asset Production steps are the steps building assets which are needed to finalize the shots of the project (for example: the characters, props, sets, etc.) Shot Production steps are the steps where shots are built using assets (for example: animation, lighting, compositing, etc.) Post-Production includes all the steps from the edit to the delivery, where the work is made on the whole edit and not individual shots (for example: editing, sound design, music, etc.) The list of steps is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each step is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Project Root folder \u2502 \u251c\u2500\u252c\u2500 01-PRE-PROD \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_SCRIPT # Pre production step \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_STORYBOARD \u2502 \u251c\u2500\u252c\u2500 02-PROD \u2502 \u251c\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the mod step \u2502 \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the mod step \u2502 \u2514\u2500\u252c\u2500 PROJECTID_G_RIG # Common files for the rig step \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the rig step \u2502 \u2514\u2500\u252c\u2500 03-POST-PROD \u2514\u2500\u2500\u2500 PROJECTID_G_EDIT # Post production step Note These folders are not where the working files are stored ; they contain the common files, like libraries, examples, references, and the Templates used for the creation of new assets and shots. Working files are stored in the Assets and Shots subfolder of the project in the Ramses Tree . Tip Without using the Ramses Client Application , you can create steps by creating their folder in the default location in the project subfolder of the Ramses Tree . Each step is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The folder names for the steps respect the Ramses Naming Scheme : ProjectID_G_stepID . Steps are also associated with the applications used to produce the assets and shots (read below). They also have default values for production estimations (read the Planning section for more information). Add Applications In order to manage the assets and the files they use, Ramses keeps track of the Applications used in the production. For each Application , Ramses keeps also three lists of file types : Native types are the file types used natively by the applications; the ones which type can be created with a save command and which store data in a lossless manner. Import types are all the file types the application can import. Export types are all the file types the application can create, usually with an export or bake command for example. The Ramses client can open applications and open files in applications; Ramses Add-ons should be able to save and manage the versionning in an application, as long as import and export assets. \u25b9 Application management in the Ramses Client Application . File types In order to manage the assets and the files they use, Ramses keeps track of the File Types used in the production. Specific file types can be marked as preview types , which means they\u2019re light and standard and can be used to display or preview an asset, but can store data in a lossy manner. File types can be associated with specific applications and pipes . \u25b9 File type management in the Ramses Client Application . Templates Step folders contain a Templates subfolder which contains the template files to be used when creating a new asset or a new shot . This can be done directly from the assets and shots tables in the Ramses Client Application or from Ramses Add-ons . The Templates subfolder is a standard working folder, and templates can have versions, a preview subfolder, and must be published to be used. Tip You can manually add files in the Templates subfolder; if you also copy them in the _published folder, Ramses will automatically detect and use them for asset and shot creation (see the section above entitled \u201c A working folder \u201d). \u25b9 Step management in the Ramses Client Application . \u25b9 Template Step management in the Ramses Client Application . Use pipes to connect steps You can use the Pipeline editor in the Ramses Client Application to build the pipeline and connect steps. Each pipe is a connection between two steps. It keeps the file types used to export from and import to these steps, as long as the color space of the files. Ramses Add-ons can use this information to automate the process. For each pipe you can add specific file types to be used. Tip Configuring pipes and passing the information to the Ramses Add-ons makes the pipeline very customizable and modular, but it is not mandatory when extending or developping an Add-on to use this information. Pipes also handle triggers which run scripts in your applications when a status changes in the production tracking of the corresponding steps (when a file runs through the pipe ). Pipes also automate the production management and are able to automatically update statuses, notify users of changes and of the disponibility of new materials for example. \u25b9 Pipeline editor in the Ramses Client Application . Automate the pipeline Using Ramses Add-ons you can easily automate the workflow with a properly configured pipeline. Publish settings For each step, you can define default publishing settings, either by inputing them in the settings of the step in the Ramses Client Application or through the add-on itself. Using official Ramses Add-ons , these settings should be simple Yaml formatted texts, looking like this: some_setting: true another_setting: false a_list: - item1 - item2 a_value: 42 other_info: \"05/05/1818\" The Ramses Add-ons will read these settings when publishing from the corresponding step to automatically publish the right format with the right parameters. \u25b9 Step settings in the Ramses Client Application . \u25b9 Ramses Add-ons . Import settings When importing previously published items, Ramses can also automate some settings and get default parameters, with the same kind of Yaml formatted presets. The import settings can also be set in the Ramses Client Application or through the add-on itself. \u25b9 Pipe type settings in the Ramses Client Application . \u25b9 Ramses Add-ons .","title":"Pipeline"},{"location":"pipeline/pipeline/#pipeline","text":"The pipeline editor, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . The pipeline describes the way the production of the assets and the shots goes through each step . It actually describes each connection, each pipe between each step, keeping important information like the file type used and its color space for example. In combination with the Ramses Add-ons which integrate Ramses in your favorite creative software, Ramses is able to automate your pipeline , managing the versionning of the files, the exports, imports and all these manual tasks a robot could do for you. The pipeline is made of Steps which are connected together with Pipes . The pipeline also handles your Applications and File types . In the future, Ramses will handle color spaces too. For each pipe, each connection, you can define precisely which file types are to be used, so that the Ramses Add-ons can use this information to automate all exports and imports. The pipes are also used in Production tracking . Ramses Add-ons are also in charge of versionning and creating preview images and videos to be used in other components. The pipeline relies on the Ramses Tree to automatically manage the files and folders.","title":"Pipeline"},{"location":"pipeline/pipeline/#a-working-folder","text":"All working folders should contain a few predefined subfolders, so that Ramses can efficiently handle the versionning and production tracking of all files, assets, and shots. This is a typical working folder (files are not shown): \u250c projectID_A_AssetID_StepID # The working folder, for an asset in this example \u2502 \u251c\u2500\u2500\u2500 _versions # The versionning folder, handled by Ramses. \u2502 # Contains the history and all versions \u251c\u2500\u2500\u2500 _published \u2502 # Contains the published files, to be imported by the next steps \u2514\u2500\u2500\u2500 _preview # Contains media files to be used to preview the work on this step (videos, images...) Ramses Add-ons automatically create and sort the files in these folders when working on an item, but you can manually create and use them, especially the _published and _preview subfolder. Any file added in these folders will be automatically detected and managed by Ramses . Even when not using a Ramses Add-on it is recommended to use this folder structure. All files inside these folders should be correctly named and respect all Ramses naming conventions . \u25b9 More information: The Ramses Tree .","title":"A working folder"},{"location":"pipeline/pipeline/#creating-a-pipeline","text":"The creation of a pipeline is better made using the Ramses Client Application and its nodal Pipeline Editor , although it is also possible to use basic pipelines only with Ramses Add-ons or more complex ones thanks to the Add-on API and Ramses extensibility for developpers. A pipeline can be built quite quickly by following these steps: Set the project settings like its resolution and framerate. Create the steps (from scratch or using templates). List the applications which are going to be used. Assign applications to the steps. Connect the steps with pipes. (optional) Set the file types to be used through the pipes. (optional) Create Templates for the steps. (optional) Create default settings for publishing and importing items. (optional) Develop extensions for the Add-ons if you have specific needs for an advanced pipeline with a lot of automations. \u25b9 Pipeline editor in the Ramses Client Application . \u25b9 Available Add-ons . \u25b9 Add-on API for the extension or development of new Add-ons .","title":"Creating a pipeline"},{"location":"pipeline/pipeline/#project-settings","text":"From the Ramses Client Application , you can adjust the project settings. Specifically, the Resolution and Framerate can be used by the Add-ons to automatically setup the working files in the creative applications.","title":"Project settings"},{"location":"pipeline/pipeline/#list-steps","text":"You can use the Ramses Client Application to list the steps needed to produce the project. Steps represent the stages the assets and shots have to go through before completion, for example Modeling , Rigging , Animation , Lighting \u2026 There are 4 different types of steps: Pre-Production includes all the steps of the work which has to be done to prepare and develop the project, but which will not actually be included in the project (for example: the storyboard, the script, etc.). Pre-production steps aren\u2019t linked to assets nor shots, but work on the project as a whole. Asset Production steps are the steps building assets which are needed to finalize the shots of the project (for example: the characters, props, sets, etc.) Shot Production steps are the steps where shots are built using assets (for example: animation, lighting, compositing, etc.) Post-Production includes all the steps from the edit to the delivery, where the work is made on the whole edit and not individual shots (for example: editing, sound design, music, etc.) The list of steps is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each step is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Project Root folder \u2502 \u251c\u2500\u252c\u2500 01-PRE-PROD \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_SCRIPT # Pre production step \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_STORYBOARD \u2502 \u251c\u2500\u252c\u2500 02-PROD \u2502 \u251c\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the mod step \u2502 \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the mod step \u2502 \u2514\u2500\u252c\u2500 PROJECTID_G_RIG # Common files for the rig step \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the rig step \u2502 \u2514\u2500\u252c\u2500 03-POST-PROD \u2514\u2500\u2500\u2500 PROJECTID_G_EDIT # Post production step Note These folders are not where the working files are stored ; they contain the common files, like libraries, examples, references, and the Templates used for the creation of new assets and shots. Working files are stored in the Assets and Shots subfolder of the project in the Ramses Tree . Tip Without using the Ramses Client Application , you can create steps by creating their folder in the default location in the project subfolder of the Ramses Tree . Each step is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The folder names for the steps respect the Ramses Naming Scheme : ProjectID_G_stepID . Steps are also associated with the applications used to produce the assets and shots (read below). They also have default values for production estimations (read the Planning section for more information).","title":"List steps"},{"location":"pipeline/pipeline/#add-applications","text":"In order to manage the assets and the files they use, Ramses keeps track of the Applications used in the production. For each Application , Ramses keeps also three lists of file types : Native types are the file types used natively by the applications; the ones which type can be created with a save command and which store data in a lossless manner. Import types are all the file types the application can import. Export types are all the file types the application can create, usually with an export or bake command for example. The Ramses client can open applications and open files in applications; Ramses Add-ons should be able to save and manage the versionning in an application, as long as import and export assets. \u25b9 Application management in the Ramses Client Application .","title":"Add Applications"},{"location":"pipeline/pipeline/#file-types","text":"In order to manage the assets and the files they use, Ramses keeps track of the File Types used in the production. Specific file types can be marked as preview types , which means they\u2019re light and standard and can be used to display or preview an asset, but can store data in a lossy manner. File types can be associated with specific applications and pipes . \u25b9 File type management in the Ramses Client Application .","title":"File types"},{"location":"pipeline/pipeline/#templates","text":"Step folders contain a Templates subfolder which contains the template files to be used when creating a new asset or a new shot . This can be done directly from the assets and shots tables in the Ramses Client Application or from Ramses Add-ons . The Templates subfolder is a standard working folder, and templates can have versions, a preview subfolder, and must be published to be used. Tip You can manually add files in the Templates subfolder; if you also copy them in the _published folder, Ramses will automatically detect and use them for asset and shot creation (see the section above entitled \u201c A working folder \u201d). \u25b9 Step management in the Ramses Client Application . \u25b9 Template Step management in the Ramses Client Application .","title":"Templates"},{"location":"pipeline/pipeline/#use-pipes-to-connect-steps","text":"You can use the Pipeline editor in the Ramses Client Application to build the pipeline and connect steps. Each pipe is a connection between two steps. It keeps the file types used to export from and import to these steps, as long as the color space of the files. Ramses Add-ons can use this information to automate the process. For each pipe you can add specific file types to be used. Tip Configuring pipes and passing the information to the Ramses Add-ons makes the pipeline very customizable and modular, but it is not mandatory when extending or developping an Add-on to use this information. Pipes also handle triggers which run scripts in your applications when a status changes in the production tracking of the corresponding steps (when a file runs through the pipe ). Pipes also automate the production management and are able to automatically update statuses, notify users of changes and of the disponibility of new materials for example. \u25b9 Pipeline editor in the Ramses Client Application .","title":"Use pipes to connect steps"},{"location":"pipeline/pipeline/#automate-the-pipeline","text":"Using Ramses Add-ons you can easily automate the workflow with a properly configured pipeline.","title":"Automate the pipeline"},{"location":"pipeline/pipeline/#publish-settings","text":"For each step, you can define default publishing settings, either by inputing them in the settings of the step in the Ramses Client Application or through the add-on itself. Using official Ramses Add-ons , these settings should be simple Yaml formatted texts, looking like this: some_setting: true another_setting: false a_list: - item1 - item2 a_value: 42 other_info: \"05/05/1818\" The Ramses Add-ons will read these settings when publishing from the corresponding step to automatically publish the right format with the right parameters. \u25b9 Step settings in the Ramses Client Application . \u25b9 Ramses Add-ons .","title":"Publish settings"},{"location":"pipeline/pipeline/#import-settings","text":"When importing previously published items, Ramses can also automate some settings and get default parameters, with the same kind of Yaml formatted presets. The import settings can also be set in the Ramses Client Application or through the add-on itself. \u25b9 Pipe type settings in the Ramses Client Application . \u25b9 Ramses Add-ons .","title":"Import settings"},{"location":"pipeline/planning/","text":"Production Planning The schedule table, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . As Ramses is able to (automatically) estimate the time needed for the production of the individual assets and shots , it can help you plan the production, and keep track of the time needed to produce any project. At the step level, default estimations can be set to be used on shots and assets, depending on the difficulty of their productions. Then, each individual estimation can be customized for a finer evaluation of the time needed for the production. Estimations To establish a realistic schedule, it is important to be able to estimate the time needed to produce the project, as well as tracking the production to adjust these estimations if needed. Ramses helps you to quickly estimate this time needed, and then helps you to make it as precise as you need. The unit used for estimations by Ramses is the day (which can be divided into smaller parts of a day if you need). Counting in days is precise enough for planning a production, and this way you don\u2019t need to know exactly how many hours are (actually) worked in a day. Note There\u2019s no way with Ramses to link the production tracking data to individual users (meaning that there\u2019s no easy way to build statistics about users or compare their productivity). That\u2019s by design, don\u2019t ask for it. Step estimations For each step, it is possible to set a default estimation which will be used for all assets and shots. This estimation, usually set in days of work, can vary with the difficulty for the production of each specific asset or shot; Ramses lets you define an estimation for five predefined levels of difficulty: very easy , easy , medium , hard , very hard . This default estimation is used to automatically evaluate the time needed for the production of the whole step, depending on the assets or shots which have to be produced, at first based on a medium difficulty. Adjusting the difficulty per shot or asset will then automatically update the global estimation to raise the precision. For the production of shots , the estimations can also be optionnaly and automatically multiplied by the duration of the shot, so that the estimation can be made per second instead of per shot , and also by the number of assets used by the shot , for example to multiply the estimation by the number of characters in the shot. \u25b9 Step management in the Ramses Client Application . Asset and shots estimations The estimation set by default by the step and automatically computed based on the number of assets, the duration and the difficulty can always be individually overriden for each shot and asset, for a more precise control on the estimations. This is done through the Production Tracking \u25b9 Production tracking in the Ramses Client Application . Schedule Based on the estimations, Ramses evaluates the number of days of work needed to complete the work on each step for all assets and shots. It is then easier to prepare the production planning and establish a schedule, by assigning days of work to users and steps . Ramses will keep track of the number of days already assigned and missing (or extra) days to help you plan the production. In case of lateness on the production of a step (shown by Ramses ), it means the quantity or the diffuclty of the work was underestimated; all that needs to be done is then to adjust the estimations at the step level to update all assets and shots estimations, then check if the schedule can still be respected, or assign more users or days of work to the step. \u25b9 Schedule panel in the Ramses Client Application .","title":"Planning"},{"location":"pipeline/planning/#production-planning","text":"The schedule table, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . As Ramses is able to (automatically) estimate the time needed for the production of the individual assets and shots , it can help you plan the production, and keep track of the time needed to produce any project. At the step level, default estimations can be set to be used on shots and assets, depending on the difficulty of their productions. Then, each individual estimation can be customized for a finer evaluation of the time needed for the production.","title":"Production Planning"},{"location":"pipeline/planning/#estimations","text":"To establish a realistic schedule, it is important to be able to estimate the time needed to produce the project, as well as tracking the production to adjust these estimations if needed. Ramses helps you to quickly estimate this time needed, and then helps you to make it as precise as you need. The unit used for estimations by Ramses is the day (which can be divided into smaller parts of a day if you need). Counting in days is precise enough for planning a production, and this way you don\u2019t need to know exactly how many hours are (actually) worked in a day. Note There\u2019s no way with Ramses to link the production tracking data to individual users (meaning that there\u2019s no easy way to build statistics about users or compare their productivity). That\u2019s by design, don\u2019t ask for it.","title":"Estimations"},{"location":"pipeline/planning/#step-estimations","text":"For each step, it is possible to set a default estimation which will be used for all assets and shots. This estimation, usually set in days of work, can vary with the difficulty for the production of each specific asset or shot; Ramses lets you define an estimation for five predefined levels of difficulty: very easy , easy , medium , hard , very hard . This default estimation is used to automatically evaluate the time needed for the production of the whole step, depending on the assets or shots which have to be produced, at first based on a medium difficulty. Adjusting the difficulty per shot or asset will then automatically update the global estimation to raise the precision. For the production of shots , the estimations can also be optionnaly and automatically multiplied by the duration of the shot, so that the estimation can be made per second instead of per shot , and also by the number of assets used by the shot , for example to multiply the estimation by the number of characters in the shot. \u25b9 Step management in the Ramses Client Application .","title":"Step estimations"},{"location":"pipeline/planning/#asset-and-shots-estimations","text":"The estimation set by default by the step and automatically computed based on the number of assets, the duration and the difficulty can always be individually overriden for each shot and asset, for a more precise control on the estimations. This is done through the Production Tracking \u25b9 Production tracking in the Ramses Client Application .","title":"Asset and shots estimations"},{"location":"pipeline/planning/#schedule","text":"Based on the estimations, Ramses evaluates the number of days of work needed to complete the work on each step for all assets and shots. It is then easier to prepare the production planning and establish a schedule, by assigning days of work to users and steps . Ramses will keep track of the number of days already assigned and missing (or extra) days to help you plan the production. In case of lateness on the production of a step (shown by Ramses ), it means the quantity or the diffuclty of the work was underestimated; all that needs to be done is then to adjust the estimations at the step level to update all assets and shots estimations, then check if the schedule can still be respected, or assign more users or days of work to the step. \u25b9 Schedule panel in the Ramses Client Application .","title":"Schedule"},{"location":"pipeline/production/","text":"Production Tracking The asset table, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . Ramses keeps track of the whole production for you, by tracking each asset and each shot at each step of the production. This allows for a precise information about the production of the whole project, and Ramses can summarize all this information in nice graphics. Ramses measures the time spent on the production of each asset and each shot, and the user can set a completion ratio along with setting the state of the production for each step. These values are closely related to the estimations used for production planning and Ramses is able to measure the lateness of the production in real time. To help users track the production, users can comment each task, and each task can be assigned to a specific user . States States are part of assets and shots status , along with comments and estimations . They also define a percentage of completion of the work for the corresponding step , to be used by default when setting a production status to the specific state. They can be configured globally to be used everywhere there\u2019s a need to show a statuss. Each state is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. They also have a color to be used to display them in the user interface. By default, Ramses includes a few predefined states, and some of them cannot be removed as they are needed by Ramses automations. Others are examples and can be customized or removed. These are the predefined states: ID Name Completion Mandatory Description NO Nothing to do 0% Yes There\u2019s nothing to do at this step. STB Stand by 0% Yes Something is missing, let\u2019s wait a bit. TODO Ready to do 0% Yes This step is ready, one can work on this. QST Question 20% No More information is needed to continue working on this. WIP Work in progress 50% Yes This is currently in production. CHK Waiting for approval 80% No This is ready to be reviewed. RDR Rendering 90% No This is currently rendering, soon we\u2019ll be able to watch this beautiful work! CBB Could be better 95% No This works like that, but if possible it can still be improved. OK Finished 100% Yes This has been reviewed and validated. \u25b9 State management in the Ramses Client Application . Assets An Asset is produced independently from the shots and can be used in several shots. They are the characters, sets, props, and any other re-usable item in the production. The list of assets is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each asset is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Root \u2502 \u2514\u2500\u252c\u2500 04-ASSETS \u251c\u2500\u252c\u2500 Characters # An asset group \u2502 \u2502 \u2502 \u251c\u2500\u252c\u2500 PROJECTID_A_TRISTAN # An Asset \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_DESIGN # An asset production step \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_RIG \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_TEX \u2502 \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_ISOLDE # An Asset \u2502 \u251c\u2500\u2500\u2500 Props # A Group of Assets \u2502 \u2514\u2500\u2500\u2500 Sets # A Group of Assets Tip Without using the Ramses Client Application , you can create assets by creating their folder in the default location in the project subfolder of the Ramses Tree . Each asset is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. They\u2019re grouped in Asset Groups to make them easier to sort, and produced through Asset Production Steps . They also have tags to be able to search for specific assets. \u25b9 Asset management in the Ramses Client Application . Shots A Shot is produced using assets and stored in a Sequence . The list of shots is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each shot is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Root \u2502 \u2514\u2500\u252c\u2500 05-SHOTS \u2502 \u251c\u2500\u252c\u2500 PROJECTID_S_01-001 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_ANIM # A shot production step \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_LIGHT \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_01-001_COMP \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-002 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-003 # A Shot \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_02-001 # A Shot Tip Without using the Ramses Client Application , you can create shots by creating their folder in the default location in the project subfolder of the Ramses Tree . Each shot is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. Each shot contains a list of assets which are needed for its production. Shots have a duration , usually shown either in seconds or frames, and the addition of all their duration is the duration of the project. \u25b9 Shot management in the Ramses Client Application . Production status of assets and shots All assets and shots have a production status, which is summarized in an asset table and a shot table in the Ramses Client Application . This status consists of a state , a comment and a completion ratio . Ramses also associates the time spent for the production of the item and the estimation to the status (read the Planning section for more information about estimations). All this information is added and summarized at the step level to show the completion for each step, each asset and each shot. Ramses also keeps track of the whole production at the project level with general statistics. Note There\u2019s no way with Ramses to link the production tracking data to individual users (meaning that there\u2019s no easy way to build statistics about users or compare their productivity). That\u2019s by design, don\u2019t ask for it. Ramses is also able to extract a lateness value from all the available information, available at all levels (shots, assets, steps and whole project). All the history of successive states, comments, completion ratio, etc. is always available. The combination of an asset or a shot and a step can be assigned to a specific user . For use with pipeline automations , status are also associated with specific versions of the files, and store the publication status. When using Ramses Add-ons , the state of a specific version is kept in the file name of the corresponding version file, thanks to the Ramses naming scheme \u25b9 Production tracking in the Ramses Client Application .","title":"Production tracking"},{"location":"pipeline/production/#production-tracking","text":"The asset table, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . Ramses keeps track of the whole production for you, by tracking each asset and each shot at each step of the production. This allows for a precise information about the production of the whole project, and Ramses can summarize all this information in nice graphics. Ramses measures the time spent on the production of each asset and each shot, and the user can set a completion ratio along with setting the state of the production for each step. These values are closely related to the estimations used for production planning and Ramses is able to measure the lateness of the production in real time. To help users track the production, users can comment each task, and each task can be assigned to a specific user .","title":"Production Tracking"},{"location":"pipeline/production/#states","text":"States are part of assets and shots status , along with comments and estimations . They also define a percentage of completion of the work for the corresponding step , to be used by default when setting a production status to the specific state. They can be configured globally to be used everywhere there\u2019s a need to show a statuss. Each state is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. They also have a color to be used to display them in the user interface. By default, Ramses includes a few predefined states, and some of them cannot be removed as they are needed by Ramses automations. Others are examples and can be customized or removed. These are the predefined states: ID Name Completion Mandatory Description NO Nothing to do 0% Yes There\u2019s nothing to do at this step. STB Stand by 0% Yes Something is missing, let\u2019s wait a bit. TODO Ready to do 0% Yes This step is ready, one can work on this. QST Question 20% No More information is needed to continue working on this. WIP Work in progress 50% Yes This is currently in production. CHK Waiting for approval 80% No This is ready to be reviewed. RDR Rendering 90% No This is currently rendering, soon we\u2019ll be able to watch this beautiful work! CBB Could be better 95% No This works like that, but if possible it can still be improved. OK Finished 100% Yes This has been reviewed and validated. \u25b9 State management in the Ramses Client Application .","title":"States"},{"location":"pipeline/production/#assets","text":"An Asset is produced independently from the shots and can be used in several shots. They are the characters, sets, props, and any other re-usable item in the production. The list of assets is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each asset is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Root \u2502 \u2514\u2500\u252c\u2500 04-ASSETS \u251c\u2500\u252c\u2500 Characters # An asset group \u2502 \u2502 \u2502 \u251c\u2500\u252c\u2500 PROJECTID_A_TRISTAN # An Asset \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_DESIGN # An asset production step \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_RIG \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_TEX \u2502 \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_ISOLDE # An Asset \u2502 \u251c\u2500\u2500\u2500 Props # A Group of Assets \u2502 \u2514\u2500\u2500\u2500 Sets # A Group of Assets Tip Without using the Ramses Client Application , you can create assets by creating their folder in the default location in the project subfolder of the Ramses Tree . Each asset is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. They\u2019re grouped in Asset Groups to make them easier to sort, and produced through Asset Production Steps . They also have tags to be able to search for specific assets. \u25b9 Asset management in the Ramses Client Application .","title":"Assets"},{"location":"pipeline/production/#shots","text":"A Shot is produced using assets and stored in a Sequence . The list of shots is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each shot is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Root \u2502 \u2514\u2500\u252c\u2500 05-SHOTS \u2502 \u251c\u2500\u252c\u2500 PROJECTID_S_01-001 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_ANIM # A shot production step \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_LIGHT \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_01-001_COMP \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-002 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-003 # A Shot \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_02-001 # A Shot Tip Without using the Ramses Client Application , you can create shots by creating their folder in the default location in the project subfolder of the Ramses Tree . Each shot is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. Each shot contains a list of assets which are needed for its production. Shots have a duration , usually shown either in seconds or frames, and the addition of all their duration is the duration of the project. \u25b9 Shot management in the Ramses Client Application .","title":"Shots"},{"location":"pipeline/production/#production-status-of-assets-and-shots","text":"All assets and shots have a production status, which is summarized in an asset table and a shot table in the Ramses Client Application . This status consists of a state , a comment and a completion ratio . Ramses also associates the time spent for the production of the item and the estimation to the status (read the Planning section for more information about estimations). All this information is added and summarized at the step level to show the completion for each step, each asset and each shot. Ramses also keeps track of the whole production at the project level with general statistics. Note There\u2019s no way with Ramses to link the production tracking data to individual users (meaning that there\u2019s no easy way to build statistics about users or compare their productivity). That\u2019s by design, don\u2019t ask for it. Ramses is also able to extract a lateness value from all the available information, available at all levels (shots, assets, steps and whole project). All the history of successive states, comments, completion ratio, etc. is always available. The combination of an asset or a shot and a step can be assigned to a specific user . For use with pipeline automations , status are also associated with specific versions of the files, and store the publication status. When using Ramses Add-ons , the state of a specific version is kept in the file name of the corresponding version file, thanks to the Ramses naming scheme \u25b9 Production tracking in the Ramses Client Application .","title":"Production status of assets and shots"},{"location":"quickstart/","text":"Quick start guide Here\u2019s all you need to know before you start using Ramses . Follow these few steps and you\u2019ll be able to benefit from all it\u2019s features very quickly. Introduction Ramses can help you automate your workflow , plan and track your production. To benefit from all Ramses features, you just need to install the Ramses Application on your workstations. To help you manage your files and automate your workflow, you can also install optional Ramses Add-ons . They can be scripts, extensions, plugins, add-ons for your creative software and how you use them and their features can vary depending on the host software. To sync all the Ramses Data across workstations and between multiple users, you\u2019ll need to connect to an optional Ramses Server . You can either install your own or rent a server managed by RxLaboratory (or any other provider you trust). Note 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\u2019s 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. Tips Although Ramses is made to be as simple as possible to use, it\u2019s a production tool which both helps and needs you to be organized, and you\u2019ll have to familiarize yourself with its organization. Read this documentation before installing everything and clicking everywhere! The Principles section and the Ramses Tree section are especially important. In files and folders , it is important to respect the Ramses naming scheme ; take some time to familiarize yourself with it. On some systems ( Linux and sometimes Mac OS depending on its settings), the text case matters in file and folder names. Even on Windows , it is safer to assume that the name Tristan is different than tristan . Ramses is just a piece of software. It\u2019s dumb. The folder name _preview is not the same as preview . Be careful with naming conventions and folder structure . 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. You must have a Ramses main folder , which stores at least some configuration files. In default configurations, this folder actually stores everything you need : user files, project files, etc. In this case, it should contain at least two subfolders: Users and Projects . The Projects subfolder is the most important one: it is there you\u2019ll work and save all your data. You may store your project files in separate folders , either locally or in a shared location; in this case, for each project, you\u2019ll have to know where its folder is. It\u2019s in this specific location that you\u2019ll work and save your data instead of the Ramses main folder. \u25b9 More details about the Ramses Tree . 1.A - Project folders In short, a project folder should contain at least these subfolders. 00-ADMIN contains the administration files. Ramses doesn\u2019t handle these yet. 01-PRE-PROD contains pre-production step files (with a subfolder for each step). 02-PROD contains production step common files (libraries, templates, etc, with a subfolder for each step), but not the working files. 03-POST-PROD contains post-production step files (with a subfolder for each step. 04-ASSETS contains asset working files (with a subfolder for each group of assets). 05-SHOTS contains shot working files (with a subfolder for each shot). 06-EXPORTS contains media files for the whole project. 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. \u25b9 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\u2019re 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. \u25b9 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 \u2026), read the doc for more information.","title":"Quick start"},{"location":"quickstart/#quick-start-guide","text":"Here\u2019s all you need to know before you start using Ramses . Follow these few steps and you\u2019ll be able to benefit from all it\u2019s features very quickly.","title":"Quick start guide"},{"location":"quickstart/#introduction","text":"Ramses can help you automate your workflow , plan and track your production. To benefit from all Ramses features, you just need to install the Ramses Application on your workstations. To help you manage your files and automate your workflow, you can also install optional Ramses Add-ons . They can be scripts, extensions, plugins, add-ons for your creative software and how you use them and their features can vary depending on the host software. To sync all the Ramses Data across workstations and between multiple users, you\u2019ll need to connect to an optional Ramses Server . You can either install your own or rent a server managed by RxLaboratory (or any other provider you trust). Note 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\u2019s 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.","title":"Introduction"},{"location":"quickstart/#tips","text":"Although Ramses is made to be as simple as possible to use, it\u2019s a production tool which both helps and needs you to be organized, and you\u2019ll have to familiarize yourself with its organization. Read this documentation before installing everything and clicking everywhere! The Principles section and the Ramses Tree section are especially important. In files and folders , it is important to respect the Ramses naming scheme ; take some time to familiarize yourself with it. On some systems ( Linux and sometimes Mac OS depending on its settings), the text case matters in file and folder names. Even on Windows , it is safer to assume that the name Tristan is different than tristan . Ramses is just a piece of software. It\u2019s dumb. The folder name _preview is not the same as preview . Be careful with naming conventions and folder structure .","title":"Tips"},{"location":"quickstart/#1-check-the-ramses-folder-the-ramses-tree","text":"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. You must have a Ramses main folder , which stores at least some configuration files. In default configurations, this folder actually stores everything you need : user files, project files, etc. In this case, it should contain at least two subfolders: Users and Projects . The Projects subfolder is the most important one: it is there you\u2019ll work and save all your data. You may store your project files in separate folders , either locally or in a shared location; in this case, for each project, you\u2019ll have to know where its folder is. It\u2019s in this specific location that you\u2019ll work and save your data instead of the Ramses main folder. \u25b9 More details about the Ramses Tree .","title":"1 - Check the Ramses folder, the Ramses Tree"},{"location":"quickstart/#1a-project-folders","text":"In short, a project folder should contain at least these subfolders. 00-ADMIN contains the administration files. Ramses doesn\u2019t handle these yet. 01-PRE-PROD contains pre-production step files (with a subfolder for each step). 02-PROD contains production step common files (libraries, templates, etc, with a subfolder for each step), but not the working files. 03-POST-PROD contains post-production step files (with a subfolder for each step. 04-ASSETS contains asset working files (with a subfolder for each group of assets). 05-SHOTS contains shot working files (with a subfolder for each shot). 06-EXPORTS contains media files for the whole project. 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. \u25b9 More details about the file and folder structure .","title":"1.A - Project folders"},{"location":"quickstart/#2-the-ramses-application","text":"The Ramses Client Application is the main User Interface of Ramses .","title":"2 - The Ramses Application"},{"location":"quickstart/#2a-installation","text":"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.","title":"2.A - Installation"},{"location":"quickstart/#2b-settings","text":"","title":"2.B - Settings"},{"location":"quickstart/#2c-create-a-database","text":"","title":"2.C - Create a database"},{"location":"quickstart/#2d-project-settings","text":"If you\u2019re 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. \u25b9 Project settings are detailed here .","title":"2.D - Project settings"},{"location":"quickstart/#3-install-the-ramses-add-ons","text":"Finally, you can install the Ramses Add-ons you need. Installation differs depending on the host application ( Maya , Blender , After Effects \u2026), read the doc for more information.","title":"3 - Install the Ramses Add-Ons"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Ramses - The Rx Asset Management System Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . What\u2019s this? Ramses , the Rx Asset Management System, is a complete framework to help you, your team, your studio, track the production of your films. It is meant to be used both by freelancers, small or big teams. Let\u2019s have a look at a few key features. \u25b9 Read the changelog to know exactly what\u2019s already available and what\u2019s planned (along with known issues) \u25b9 Free and open source Ramses is licensed under the GNU General Public License v3, which means you\u2019re free to do anything you\u2019d like with it, use it the way you want, modify it, and share your modifications. \u25b9 Production Planning Ramses helps you easily plan your production , and estimate how long you\u2019ll need to produce your project. For each shot and asset of the project, you\u2019ll be able to (automatically) estimate how long it will take to produce, and Ramses will keep track of all estimations for you so you can plan accordingly. \u25b8 Read more \u25b9 Production Tracking At any time, Ramses can tell you where you are in the production, how late (or not) you are, and warn you if something\u2019s going wrong. You can always keep a close (or overall) look at the production , and check which assets and shots are longer or shorter to produce, and the state in which they are at any time. \u25b8 Read more \u25b9 Pipeline automation In combination with the Ramses Add-ons which integrate Ramses in your favorite creative software, Ramses is able to automate your pipeline , managing the versionning of the files, the exports, imports and all these manual tasks a robot could do for you. An example: the Autodesk Maya shelf of the Ramses Maya Add-on. With a nice and modern nodal view, it\u2019s easy to design your pipeline, connecting each step and setting how the data should go from one step to the other. All this information will be used both by the Ramses production tracking algorithms and the Add-ons to help you focus on your real work: creation . \u25b8 Read more \u25b9 (Very) Easy-to-use A tool like Ramses is here to help, not to give you a headache. All user interface components have been carefully crafted to be beautiful, but most of all to be intuitive and practical . Everything has to be clear, precise, and meaningful. Of course, there\u2019s this comprehensive documentation if you have any doubt\u2026 \u25b9 And also\u2026 Why would one want to track one\u2019s production from a web browser? Ramses comes with its own native application for Linux , Mac OS and Windows . It\u2019s designed to by very light and unintrusive, fast and responsive. It ususally takes about ten times less memory than a usual web-browser with a single tab opened. Ramses is extensible . Although it already comes with some add-ons for your creative software, if you have specific needs, you can use the provided Python and Adobe ExtendScript API , to implement your own add-ons which fully integrate with both Ramses and your creative applications. The Daemon and the Server API are also fully documented. And, after all, Ramses is open source! Ramses can manage all your files : the idea is that you won\u2019t ever need to search for any file through the system\u2019s explorer. \u25b9 The future Ramses is (far from) not finished . And probably never will: it is going to evolve, and there are a lot of other planned features and improvements on their way! \u25b9 Read the changelog for more details about what\u2019s going on, and known issues Here are some of the features which are not available yet but which will be available in the future. The Dashboard will be an area where each user accesses all its important data and schedule. It comes with notifications so you won\u2019t miss any change concerning your assets, shots and steps. Project Planning : a simple but indispensable tool to easily plan the production of the project, at the very beginning of the production. With this planning tool you will be able to set the important dates of the production, the deadlines for each step, all in an easy-to-use and visual panel. Status automation : when a character is rigged, it means it\u2019s ready to be animated. Status automation will automatically update the states of all the items according to the pipeline design, and your custom rules. Data export and import : if you\u2019re planning important software update, or for your backups at the end of a production, it may be useful to export and re-import your data. File tools will provide automatic ways to manage your files, create new assets and shots from already existing files, clean the tree, backup, remove temporary data, batch rename files and folders\u2026 Editing tools to manage your shots from your edits. Automatically set shot duration, order and other metadata by just importing your edit. A lot of UI improvements and tweaks are planned too, and work will be done to improve the performance of the Ramses Client Application even further. Syncthing integration will provide a free, open, and secure way to synchronize all files and data of your production accross multiple workstations, servers, NAS, etc. There\u2019s also a lot of ongoing work to extend the supported creative applications through Ramses Add-ons. \u25b9 Read the Add-ons section for a detailed list of existing and planned add-ons License Software The software this documentation is referring to is licensed under the GNU General Public License . Copyright (C) 2020 Nicolas Dufresne and Contributors. This program is free software; you can redistribute them and/or modify them under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program . If not, see http://www.gnu.org/licenses/ . Icons and other graphical elements All graphical elements, especially icons, are from RxUI by Nicolas Dufresne and RxLaboratory are licensed under CC BY-NC-SA 4.0 . Copyright (C) 2021 Nicolas Dufresne and Contributors. This Documentation Copyright (C) 2020 Nicolas Dufresne and Contributors. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled \u201c Documentation License \u201d.","title":"v0.7 (Beta)"},{"location":"#ramses-the-rx-asset-management-system","text":"Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues .","title":"Ramses - The Rx Asset Management System"},{"location":"#whats-this","text":"Ramses , the Rx Asset Management System, is a complete framework to help you, your team, your studio, track the production of your films. It is meant to be used both by freelancers, small or big teams. Let\u2019s have a look at a few key features. \u25b9 Read the changelog to know exactly what\u2019s already available and what\u2019s planned (along with known issues)","title":"What's this?"},{"location":"#free-and-open-source","text":"Ramses is licensed under the GNU General Public License v3, which means you\u2019re free to do anything you\u2019d like with it, use it the way you want, modify it, and share your modifications.","title":"\u25b9 Free and open source"},{"location":"#production-planning","text":"Ramses helps you easily plan your production , and estimate how long you\u2019ll need to produce your project. For each shot and asset of the project, you\u2019ll be able to (automatically) estimate how long it will take to produce, and Ramses will keep track of all estimations for you so you can plan accordingly. \u25b8 Read more","title":"\u25b9 Production Planning"},{"location":"#production-tracking","text":"At any time, Ramses can tell you where you are in the production, how late (or not) you are, and warn you if something\u2019s going wrong. You can always keep a close (or overall) look at the production , and check which assets and shots are longer or shorter to produce, and the state in which they are at any time. \u25b8 Read more","title":"\u25b9 Production Tracking"},{"location":"#pipeline-automation","text":"In combination with the Ramses Add-ons which integrate Ramses in your favorite creative software, Ramses is able to automate your pipeline , managing the versionning of the files, the exports, imports and all these manual tasks a robot could do for you. An example: the Autodesk Maya shelf of the Ramses Maya Add-on. With a nice and modern nodal view, it\u2019s easy to design your pipeline, connecting each step and setting how the data should go from one step to the other. All this information will be used both by the Ramses production tracking algorithms and the Add-ons to help you focus on your real work: creation . \u25b8 Read more","title":"\u25b9 Pipeline automation"},{"location":"#very-easy-to-use","text":"A tool like Ramses is here to help, not to give you a headache. All user interface components have been carefully crafted to be beautiful, but most of all to be intuitive and practical . Everything has to be clear, precise, and meaningful. Of course, there\u2019s this comprehensive documentation if you have any doubt\u2026","title":"\u25b9 (Very) Easy-to-use"},{"location":"#and-also","text":"Why would one want to track one\u2019s production from a web browser? Ramses comes with its own native application for Linux , Mac OS and Windows . It\u2019s designed to by very light and unintrusive, fast and responsive. It ususally takes about ten times less memory than a usual web-browser with a single tab opened. Ramses is extensible . Although it already comes with some add-ons for your creative software, if you have specific needs, you can use the provided Python and Adobe ExtendScript API , to implement your own add-ons which fully integrate with both Ramses and your creative applications. The Daemon and the Server API are also fully documented. And, after all, Ramses is open source! Ramses can manage all your files : the idea is that you won\u2019t ever need to search for any file through the system\u2019s explorer.","title":"\u25b9 And also..."},{"location":"#the-future","text":"Ramses is (far from) not finished . And probably never will: it is going to evolve, and there are a lot of other planned features and improvements on their way! \u25b9 Read the changelog for more details about what\u2019s going on, and known issues Here are some of the features which are not available yet but which will be available in the future. The Dashboard will be an area where each user accesses all its important data and schedule. It comes with notifications so you won\u2019t miss any change concerning your assets, shots and steps. Project Planning : a simple but indispensable tool to easily plan the production of the project, at the very beginning of the production. With this planning tool you will be able to set the important dates of the production, the deadlines for each step, all in an easy-to-use and visual panel. Status automation : when a character is rigged, it means it\u2019s ready to be animated. Status automation will automatically update the states of all the items according to the pipeline design, and your custom rules. Data export and import : if you\u2019re planning important software update, or for your backups at the end of a production, it may be useful to export and re-import your data. File tools will provide automatic ways to manage your files, create new assets and shots from already existing files, clean the tree, backup, remove temporary data, batch rename files and folders\u2026 Editing tools to manage your shots from your edits. Automatically set shot duration, order and other metadata by just importing your edit. A lot of UI improvements and tweaks are planned too, and work will be done to improve the performance of the Ramses Client Application even further. Syncthing integration will provide a free, open, and secure way to synchronize all files and data of your production accross multiple workstations, servers, NAS, etc. There\u2019s also a lot of ongoing work to extend the supported creative applications through Ramses Add-ons. \u25b9 Read the Add-ons section for a detailed list of existing and planned add-ons","title":"\u25b9 The future"},{"location":"#license","text":"","title":"License"},{"location":"#software","text":"The software this documentation is referring to is licensed under the GNU General Public License . Copyright (C) 2020 Nicolas Dufresne and Contributors. This program is free software; you can redistribute them and/or modify them under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program . If not, see http://www.gnu.org/licenses/ .","title":"Software"},{"location":"#icons-and-other-graphical-elements","text":"All graphical elements, especially icons, are from RxUI by Nicolas Dufresne and RxLaboratory are licensed under CC BY-NC-SA 4.0 . Copyright (C) 2021 Nicolas Dufresne and Contributors.","title":"Icons and other graphical elements"},{"location":"#this-documentation","text":"Copyright (C) 2020 Nicolas Dufresne and Contributors. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled \u201c Documentation License \u201d.","title":"This Documentation"},{"location":"changelog-api/","text":"Ramses API Changelog 0.7.0-Beta New 0.7.0 compatibility update. 0.6.0-Beta New 0.6.0 compatibility update. 0.5.0-Beta New Changed and simplified data exchange. Added step general settings","title":"API"},{"location":"changelog-api/#ramses-api-changelog","text":"","title":"Ramses API Changelog"},{"location":"changelog-api/#070-beta","text":"","title":"0.7.0-Beta"},{"location":"changelog-api/#new","text":"0.7.0 compatibility update.","title":"New"},{"location":"changelog-api/#060-beta","text":"","title":"0.6.0-Beta"},{"location":"changelog-api/#new_1","text":"0.6.0 compatibility update.","title":"New"},{"location":"changelog-api/#050-beta","text":"","title":"0.5.0-Beta"},{"location":"changelog-api/#new_2","text":"Changed and simplified data exchange. Added step general settings","title":"New"},{"location":"changelog-app/","text":"Ramses Application Changelog 0.7.0-Beta New New syncing methods with the Ramses Server which are slower but more reliable, especially with big sets of data. Improvements Performance improvements, especially with big sets of data Fixes Fixed potential crash when loading some items from the Ramses Scripting API . Fixed potential crash when adding entries to the schedule. Fixed potential crash when loading specific databases. Fixed schedule entries which may not be correctly shown. No data was lost, it was just a display issue. 0.6.0-Beta New It is now possible to set the port to use to connect to the server. Database manager/cleaner (for administrators) Improvements A local database can now connect only to the server it was intended to. The application can now show the server logs. Better log and display of errors Set to offline in case of server errors. Fixes Fixed performance issues with the schedule. The resolution of the projects is now correctly saved. 0.5.0-Beta New Many UI and preformance improvements. Implemented the Offline mode Changed and simplified data exchange. Added step general settings 0.3.0-Alpha New Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password \u201cpassword\u201d and you\u2019ll have to update all passwords for all users from that account to re-enable their accounts. The Client shows the current RxLab\u2019s funding status. The schedule now has a dedicated line to add notes/comments. Added publish settings to steps, to be used with add-ons. added a log level selector to the console. Improvements The status of the connexion (offline, connected, secured) is now shown on the status bar. A warning is logged when the connexion is not secured. Changing the file type of a step automatically updates the custom settings accordingly.","title":"Application"},{"location":"changelog-app/#ramses-application-changelog","text":"","title":"Ramses Application Changelog"},{"location":"changelog-app/#070-beta","text":"","title":"0.7.0-Beta"},{"location":"changelog-app/#new","text":"New syncing methods with the Ramses Server which are slower but more reliable, especially with big sets of data.","title":"New"},{"location":"changelog-app/#improvements","text":"Performance improvements, especially with big sets of data","title":"Improvements"},{"location":"changelog-app/#fixes","text":"Fixed potential crash when loading some items from the Ramses Scripting API . Fixed potential crash when adding entries to the schedule. Fixed potential crash when loading specific databases. Fixed schedule entries which may not be correctly shown. No data was lost, it was just a display issue.","title":"Fixes"},{"location":"changelog-app/#060-beta","text":"","title":"0.6.0-Beta"},{"location":"changelog-app/#new_1","text":"It is now possible to set the port to use to connect to the server. Database manager/cleaner (for administrators)","title":"New"},{"location":"changelog-app/#improvements_1","text":"A local database can now connect only to the server it was intended to. The application can now show the server logs. Better log and display of errors Set to offline in case of server errors.","title":"Improvements"},{"location":"changelog-app/#fixes_1","text":"Fixed performance issues with the schedule. The resolution of the projects is now correctly saved.","title":"Fixes"},{"location":"changelog-app/#050-beta","text":"","title":"0.5.0-Beta"},{"location":"changelog-app/#new_2","text":"Many UI and preformance improvements. Implemented the Offline mode Changed and simplified data exchange. Added step general settings","title":"New"},{"location":"changelog-app/#030-alpha","text":"","title":"0.3.0-Alpha"},{"location":"changelog-app/#new_3","text":"Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password \u201cpassword\u201d and you\u2019ll have to update all passwords for all users from that account to re-enable their accounts. The Client shows the current RxLab\u2019s funding status. The schedule now has a dedicated line to add notes/comments. Added publish settings to steps, to be used with add-ons. added a log level selector to the console.","title":"New"},{"location":"changelog-app/#improvements_2","text":"The status of the connexion (offline, connected, secured) is now shown on the status bar. A warning is logged when the connexion is not secured. Changing the file type of a step automatically updates the custom settings accordingly.","title":"Improvements"},{"location":"changelog-maya/","text":"Ramses Laya Add-on Changelog 0.7.0-Beta Fixes Fixed \u2018save scene as\u2019 failing with random items. 0.6.0-Beta Fixes Fixed \u2018save scene as\u2019 with incorrect step settings 0.5.2-Beta Fixes Fixed \u2018save scene as\u2019 when the corresponding step doesn\u2019t have any general setting 0.5.1-Beta Fixes Removed duplicate formats in import settings Don\u2019t add selection to sets during scene setup Fixed publish with missing shaders 0.5.0-Beta New Completely changed (and simplified) the server API to support syncing with clients. Warning: this update is not compatible with older versions. As we\u2019re moving from Alpha to Beta test, there\u2019s no way to migrate your data when updating this time, as we were just testing the framework. Now that we\u2019re in Beta test, this is fixed and future updates won\u2019t break compatibility anymore. 0.3.0-Alpha New Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password \u201cpassword\u201d and you\u2019ll have to update all passwords for all users from that account to re-enable their accounts. The schedule now has a dedicated line to add notes/comments. Added publish settings to steps, to be used with add-ons.","title":"Maya"},{"location":"changelog-maya/#ramses-laya-add-on-changelog","text":"","title":"Ramses Laya Add-on Changelog"},{"location":"changelog-maya/#070-beta","text":"","title":"0.7.0-Beta"},{"location":"changelog-maya/#fixes","text":"Fixed \u2018save scene as\u2019 failing with random items.","title":"Fixes"},{"location":"changelog-maya/#060-beta","text":"","title":"0.6.0-Beta"},{"location":"changelog-maya/#fixes_1","text":"Fixed \u2018save scene as\u2019 with incorrect step settings","title":"Fixes"},{"location":"changelog-maya/#052-beta","text":"","title":"0.5.2-Beta"},{"location":"changelog-maya/#fixes_2","text":"Fixed \u2018save scene as\u2019 when the corresponding step doesn\u2019t have any general setting","title":"Fixes"},{"location":"changelog-maya/#051-beta","text":"","title":"0.5.1-Beta"},{"location":"changelog-maya/#fixes_3","text":"Removed duplicate formats in import settings Don\u2019t add selection to sets during scene setup Fixed publish with missing shaders","title":"Fixes"},{"location":"changelog-maya/#050-beta","text":"","title":"0.5.0-Beta"},{"location":"changelog-maya/#new","text":"Completely changed (and simplified) the server API to support syncing with clients. Warning: this update is not compatible with older versions. As we\u2019re moving from Alpha to Beta test, there\u2019s no way to migrate your data when updating this time, as we were just testing the framework. Now that we\u2019re in Beta test, this is fixed and future updates won\u2019t break compatibility anymore.","title":"New"},{"location":"changelog-maya/#030-alpha","text":"","title":"0.3.0-Alpha"},{"location":"changelog-maya/#new_1","text":"Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password \u201cpassword\u201d and you\u2019ll have to update all passwords for all users from that account to re-enable their accounts. The schedule now has a dedicated line to add notes/comments. Added publish settings to steps, to be used with add-ons.","title":"New"},{"location":"changelog-server/","text":"Ramses Server Changelog 0.7.0-Beta Starting with this version, the Ramses Server is compatible only with versions of MySQL more recent than 8.0, though it can still use SQLite too. New New syncing methods which are slower but more reliable, especially with big sets of data. Improved performance with big sets of data. When using SQLite, \u2018VACUUM\u2019 is run at regular intervals to optimize the size of the file and fix potential issues with failed queries. Refuse client connexions if they\u2019re using the wrong version. Fixes Accepts requests with missing \u2018Content-Type\u2019 header. Assumes it\u2019s JSON by default. 0.6.0-Beta New We now provide tested Docker configurations to easily install and run Ramses Docker containers . Each instance of a Ramses Server now had a unique universal identifier (UUID) to make sure a client won\u2019t connect to a wrong server by mistake. Added new server-side logs. The login requests now returns details (data) about the connected user (if login is successful). Ability to deactivate the session timeout. Fixes Fixed the user table in case a (removed) username already exists when creating a new user. Fixed installation issues when using SQLite . 0.5.1-Beta New Added (debug) logs to the replies which can be shown by clients. Fixes Fixed issues when table prefixes start with a number. Fixed connection issues when the URL ends with a / Ignore some sync errors when not in Dev mode 0.5.0-Beta New Changed and simplified data exchange. Added step general settings 0.3.0-Alpha New The Rubika Flavor is merged into the official add-on. Added update command Added publish settings Added import and update settings","title":"Server"},{"location":"changelog-server/#ramses-server-changelog","text":"","title":"Ramses Server Changelog"},{"location":"changelog-server/#070-beta","text":"Starting with this version, the Ramses Server is compatible only with versions of MySQL more recent than 8.0, though it can still use SQLite too.","title":"0.7.0-Beta"},{"location":"changelog-server/#new","text":"New syncing methods which are slower but more reliable, especially with big sets of data. Improved performance with big sets of data. When using SQLite, \u2018VACUUM\u2019 is run at regular intervals to optimize the size of the file and fix potential issues with failed queries. Refuse client connexions if they\u2019re using the wrong version.","title":"New"},{"location":"changelog-server/#fixes","text":"Accepts requests with missing \u2018Content-Type\u2019 header. Assumes it\u2019s JSON by default.","title":"Fixes"},{"location":"changelog-server/#060-beta","text":"","title":"0.6.0-Beta"},{"location":"changelog-server/#new_1","text":"We now provide tested Docker configurations to easily install and run Ramses Docker containers . Each instance of a Ramses Server now had a unique universal identifier (UUID) to make sure a client won\u2019t connect to a wrong server by mistake. Added new server-side logs. The login requests now returns details (data) about the connected user (if login is successful). Ability to deactivate the session timeout.","title":"New"},{"location":"changelog-server/#fixes_1","text":"Fixed the user table in case a (removed) username already exists when creating a new user. Fixed installation issues when using SQLite .","title":"Fixes"},{"location":"changelog-server/#051-beta","text":"","title":"0.5.1-Beta"},{"location":"changelog-server/#new_2","text":"Added (debug) logs to the replies which can be shown by clients.","title":"New"},{"location":"changelog-server/#fixes_2","text":"Fixed issues when table prefixes start with a number. Fixed connection issues when the URL ends with a / Ignore some sync errors when not in Dev mode","title":"Fixes"},{"location":"changelog-server/#050-beta","text":"","title":"0.5.0-Beta"},{"location":"changelog-server/#new_3","text":"Changed and simplified data exchange. Added step general settings","title":"New"},{"location":"changelog-server/#030-alpha","text":"","title":"0.3.0-Alpha"},{"location":"changelog-server/#new_4","text":"The Rubika Flavor is merged into the official add-on. Added update command Added publish settings Added import and update settings","title":"New"},{"location":"changelog/","text":"Ramses Changelog By component \u25b9 Ramses Application \u25b9 Ramses Maya Add-on \u25b9 Ramses Server \u25b9 Ramses API Versions Ramses uses semantic versionning to keep track of changes and versions. Versions numbers always have this form: M.m.p where M is the major version number, m is the minor version number and p is the patch number. Ramses Components should be considered compatible together if and only if they share the same major and minor version numbers , although if only the minor version number differs everything should still work. That means if you update a component to a new major or minor version, all other components should be updated too. For example, a 0.6.0 application will work perfectly with a 0.6.2 server, but it may have minor issues with a 0.7.0 server and it will not work with a 1.1.0 server. Note Versions ending with -Alpha or -Beta are released for testing purposes only and should not be used in production, unless you know what you\u2019re doing. In versions labeled Alpha , the APIs may still vary a lot, especially for versions still in 0.x . Changes are mentionned in this changelog. Planned Features The detailed list of planned features and enhancements is available on Github . The Dashboard will be an area where each user accesses all its important data and schedule. It comes with notifications so you won\u2019t miss any change concerning your assets, shots and steps. Project Planning : a simple but indispensable tool to easily plan the production of the project, at the very beginning of the production. With this planning tool you will be able to set the important dates of the production, the deadlines for each step, all in an easy-to-use and visual panel. Status automation : when a character is rigged, it means it\u2019s ready to be animated. Status automation will automatically update the states of all the items according to the pipeline design, and your custom rules. Data export and import : if you\u2019re planning important software update, or for your backups at the end of a production, it may be useful to export and re-import your data. File tools will provide automatic ways to manage your files, create new assets and shots from already existing files, clean the tree, backup, remove temporary data, batch rename files and folders\u2026 Video Editing tools to manage your shots from your edits. Automatically set shot duration, order and other metadata by just importing your edit from a Final Cut XML , EDL or CSV file. A lot of UI improvements and tweaks are planned too, and work will be done to improve the performance of the Ramses Client Application even further. Folder monitoring will provide a way to handle versionning and production tracking even if there\u2019s no Ramses Add-on available for the application being used. Syncthing integration will provide a free, open, and secure way to synchronize all files and data of your production accross multiple workstations, servers, NAS, etc.","title":"General"},{"location":"changelog/#ramses-changelog","text":"","title":"Ramses Changelog"},{"location":"changelog/#by-component","text":"\u25b9 Ramses Application \u25b9 Ramses Maya Add-on \u25b9 Ramses Server \u25b9 Ramses API","title":"By component"},{"location":"changelog/#versions","text":"Ramses uses semantic versionning to keep track of changes and versions. Versions numbers always have this form: M.m.p where M is the major version number, m is the minor version number and p is the patch number. Ramses Components should be considered compatible together if and only if they share the same major and minor version numbers , although if only the minor version number differs everything should still work. That means if you update a component to a new major or minor version, all other components should be updated too. For example, a 0.6.0 application will work perfectly with a 0.6.2 server, but it may have minor issues with a 0.7.0 server and it will not work with a 1.1.0 server. Note Versions ending with -Alpha or -Beta are released for testing purposes only and should not be used in production, unless you know what you\u2019re doing. In versions labeled Alpha , the APIs may still vary a lot, especially for versions still in 0.x . Changes are mentionned in this changelog.","title":"Versions"},{"location":"changelog/#planned-features","text":"The detailed list of planned features and enhancements is available on Github . The Dashboard will be an area where each user accesses all its important data and schedule. It comes with notifications so you won\u2019t miss any change concerning your assets, shots and steps. Project Planning : a simple but indispensable tool to easily plan the production of the project, at the very beginning of the production. With this planning tool you will be able to set the important dates of the production, the deadlines for each step, all in an easy-to-use and visual panel. Status automation : when a character is rigged, it means it\u2019s ready to be animated. Status automation will automatically update the states of all the items according to the pipeline design, and your custom rules. Data export and import : if you\u2019re planning important software update, or for your backups at the end of a production, it may be useful to export and re-import your data. File tools will provide automatic ways to manage your files, create new assets and shots from already existing files, clean the tree, backup, remove temporary data, batch rename files and folders\u2026 Video Editing tools to manage your shots from your edits. Automatically set shot duration, order and other metadata by just importing your edit from a Final Cut XML , EDL or CSV file. A lot of UI improvements and tweaks are planned too, and work will be done to improve the performance of the Ramses Client Application even further. Folder monitoring will provide a way to handle versionning and production tracking even if there\u2019s no Ramses Add-on available for the application being used. Syncthing integration will provide a free, open, and secure way to synchronize all files and data of your production accross multiple workstations, servers, NAS, etc.","title":"Planned Features"},{"location":"credits/","text":"Credits Ramses, which is and stays free, could not exist without your support and contributions . Many thanks to all people who made this possible . Copyright \u00a9 2021-2022 Nicolas Dufresne, RxLaboratory and Contributors. All Rights Reserved - https://rxlaboratory.org Special thanks to all the supporters of Duduf on Patreon . Development Lead developper Nicolas \u201cDuduf\u201d Dufresne Developpers and code contributors Lisa Lain\u00e9 (Python API) Jean-Philippe Luchez (Python API) Testers Juan David Almanza Ana Arce Daniel Arce Fran\u00e7ois Bonni\u00e8re Micka\u00ebl Gantois Philippe Meis Camilo Jos\u00e9 Rivera Varona Rubika - Supinfocom, the Promotheus & the Promhub Translations Third-party libraries and other code Qt licensed under the GNU GPLv3 OpenSSL licensed under the OpenSSL License and the SSLeay License Documentation Text Nicolas Dufresne Pictures and Media Files Funding Rainbox Productions All the 583 backers from the RxOT Crowdfunding Campaign and especially: Adam Aguirre, Adam Buritsch, Adam Knight, Adrien Boutin, Adrien du Repaire, aembury, aescripts + aeplugins , A\u00efda del Solar, Alejandro R. Gonzalez, Aleksander Saharovsky, Alex Beekman, Alexandre FAVRE, alietout, Amit Gicelter, Ana Arce, Ana\u00efs Guigue, Andreas Tanner, andrewrakestraw, Anez Florez Corpus, Anne Frumin, ANTOINE BIEBER, Antoine Dueso, Antonis Petroulias, Antony Pastor, Archita Ghosh, Armelle Renac, Atelier Graphoui, audrey sysaykeo, Aur\u00e9lien Delamare, aur\u00e9lien malagoli, Autret Claude, Baptiste Cochard, Bartosz B\u0105k, basimabu, Bastien Bironneau, Bastien Delmare, Ben Fligans, Benjamin Cohen-Jonathan, Benjamin Trancart, benoit jodry, Bethany Vaughan, Breece Kelsey, Brent N Walker, Brian Kolm, Bruno Quintin, Busson Remy, Calinski julien, Cam Hayduk, Cameron Gough, Carlos Arandia, Caroline Maire, Cedric Layrac, C\u00e9dric Serres, C\u00e9lia Tocco, Celine Sanno, Ching Mok, Chlo\u00e9 Chatellier, chris kieffer, Christophe \u2018IKESU\u2019 Clarey, Claire Dejoie, cl\u00e9ment Laporte, Cl\u00e9ment Vernet, Coleen Lochabay, Colin Brain, Com\u2019of design, damien.bracciotti , Dan Hollacher, Daniel Arce, Daniel Budka, David Hoizey, David Polizelli Hoffmann, david.baril, Davide Bedocchi, Derek Lau, djstep1, Dmitry Abdeev, Ebube Onyema, Elen Le Tannou, Elisabeth Springer, Emiliano Martinez, Emilien Gillet, Eric Bardot, Eric Beaup\u00e8re, Eric Paoli Infanzon, Eriks Lapins, eva.lacuskova, eva.lacuskova, Fabien Nowak, Fanny Moulin, Fernando Ferreira da Costa Junior, Florent Bonneviale, Florent Guilbaud, Francis Banguet, Fran\u00e7ois QUILLARD, Fred Luzet, fuerst.pascal, George Bowler, Germain Cauvy, Giedrius Budrys, gil, Gilles Pfeiffer, Giz Beardon, greg.araya, GRELIER Florentine, Guave Studios GmbH Guave Motion, GU\u00c9RET Matthieu, Guido Mariano, Guilbert Sylvain, Guillaume Mariotti, Guillaume Marrou, Guillaume Polveche, Guillaume Rousseau, Gustavo Almenara, Gustavo Miaciro, Gwendal Le Naour, gyom h, H Robert Marquet \u201cBob\u201d, H\u00e5kon Lundvall, Harlem Harl, Herv\u00e9 Dumont, Hiromi Ishibashi, Hristina Braykova, Ilya Gusinski, INSITE SCOP, Jacek Jefimiuk, Jack Kasprzak, Jakub Adam Makowski, Jared Mark Graham, Jason Jantzen, Javier Villalba, Jean-Baptiste Quaghebeur, Jean-Baptiste Sanno, Jean-Damien Gros, Jean-Philippe Albaret, Jean-Philippe Jambert, Jeff Cooney, Jeremi Picard, Jeremy Pluvinage, Jesse Kerman, Joachim Schwarz, Joakim Ottosson, Joe Brooks, Joel PiTrel, Johannes Krohn, John Nelson, Jonas Hummelstrand, jonasgreulich, Jose Carlos Conde Acuaviva, jose gerardo arce lopez, joshua.gslaby, Juan David Almanza Lamo, Juanca Flores, Julie Faussard, Julien Brugi\u00e8re, Julien Gouz, Julien Pilarski, Julien Pilipczuk, Karyl GAUTIER, Kate Jessop, Keizo Abe, kim nari, Kirby Conn, Kris Bosmans, Krista van der Wilk, Lars , Latham Arnott, Laura Marchant, Laura Palmer, Laurent Kanadiou Freyre, Lea Str, Lemesre Julien Erase-studio, Lenny Pomerantz, LES FILMS DU NORD, Liguori Nicolas, Luca Pecori, Luigi De Frenza, Maeva Pensivy, Manuel Viqueira Carballal, Marc Messiaen, Marco Oggero, Maresch & Sturm, Mario Burbach, Mario Hounkanrin, Marion PATIN, Martial Coulon, Martin Pageot, Martine Carton, matanarbel, Mathieu Faure, Mathieu JACOULET, Mathieu Travi, Mathilde Boudet, Matt Lloyd, Matthew Fernandez, matthewacarrick, Matthias Jach, Matthieu Fremeaux, megamonkees , Merlin Pardo, Michael Gorbachev, Michael Helmrich, Mickael Carton, Micka\u00ebl Hernandez, morgan, Motion Caf\u00e9, Motion Design Studio BRUSSOBAUM, MrGlox , muftix, Mysteropodes Drouin, Neil Ingle, Nic Dean, nicolas bougere, Nicolas Castelli, Nicolas Chaunu, Nicolas Dehaut, Nicolas DIDION, Nicolas Dufresne, Nicolas Grandry, nicolas matelot, nicolas.palmier, nicole alman, nirl28, Norbert Radvanyi, Nothing to Hide, Nuno Trindade, Nycolas Gorizian, Oana Nechifor, Olivier Escher, Olivier Jean, Olivier Patt\u00e9, onillon.thierry, P Yalaoui, Pauline DE, Payage Mickael, pdicamillo12, Philip P Betts, Philipp Reinhardt, Philippe Mignot, Philippe VECI, Pierre Cornille, Pierre Jond, pierre marteel, Pierre Munier, Pierre W. Borne, Pierre-Alain L\u00e9croart, Pierre-Baptiste Harrivelle, QingRu Yu, Rapha\u00eblle Prud\u2019homme, R\u00e9mi Rongier, Renaud DANIEL, Renaud Mazotti, Ren\u00e9 Andritsch, Ricardo Abraham Ibarra Duarte, Ricardo Arce, Robin CARLO, Rodrigo Dominguez Salazar, Romy Tokic, Ronald Anzenberger, Ronny Andr\u00e4, Ronny Andr\u00e4, Roth Fr\u00e9d\u00e9ric, Roxana Rodriguez, Ruben Alejandro Trejo Segura, Ruben Gim\u00e9nez, ruldewuold, Ryan Sears, SAINT RAYMOND, Sam Burkardt, Samuel Van Ingen, samy tichadou, Saul Yance Echegaray, S\u00e9bastien GAETTA, Sebastien Mesnage, Sebastien Vincent, Sergey Vodianov, Shao H, shirley natasha pinto, Simon Hervieu, Simon Stojanovski, Songz Meng, Sonya Robine, Sorrentino Ana\u00efs, Spenser Williams, Stein WILD, Stephane Neau, St\u00e9phane Zissu, Stephanie Leonard, Stephen Richard, Steve Pratt, Sylvain Kauffmann, Tao Mao, THAN TRONG Frederic, Thiago Maia, Thomas Crausaz, Thomas Duphil, Thomas Prinzivalli, thrawn, Tiago Castro, Tim Martyn, Tom Conner, Tomas \u00c4rlemo, Tom\u00e1\u0161 Hon\u011bk, Tomas Spokauskas, traffic.in.the.skies, Trebalag Ludovic, Ty Bardi, Vadim Luks, Valentin Nozahic, Val\u00e9rie WINTZ, Valleron Nicolas, vendu, Veronica Delgado, Vicidomini Lionel, Viliam Snirc, Viliam Snirc, Villain Cedric, Vitaliy Movsha, Voignier lisa, Warren D M Reed, wlazinski matthieu, Xavier Golfier, Yan-Ali Tabarand, Yavor Popov, Yaya Gadon, Yohan Le Diraison, Yohann GAMBA, Yoran Legemble, Zach Prichard, Zden\u011bk Dovole, Z\u00e9t\u00e9ny V\u00f6r\u00f6s. Thank you! Without your generous support, Ramses would not exist.","title":"Credits"},{"location":"credits/#credits","text":"Ramses, which is and stays free, could not exist without your support and contributions . Many thanks to all people who made this possible . Copyright \u00a9 2021-2022 Nicolas Dufresne, RxLaboratory and Contributors. All Rights Reserved - https://rxlaboratory.org Special thanks to all the supporters of Duduf on Patreon .","title":"Credits"},{"location":"credits/#development","text":"","title":"Development"},{"location":"credits/#lead-developper","text":"Nicolas \u201cDuduf\u201d Dufresne","title":"Lead developper"},{"location":"credits/#developpers-and-code-contributors","text":"Lisa Lain\u00e9 (Python API) Jean-Philippe Luchez (Python API)","title":"Developpers and code contributors"},{"location":"credits/#testers","text":"Juan David Almanza Ana Arce Daniel Arce Fran\u00e7ois Bonni\u00e8re Micka\u00ebl Gantois Philippe Meis Camilo Jos\u00e9 Rivera Varona Rubika - Supinfocom, the Promotheus & the Promhub","title":"Testers"},{"location":"credits/#translations","text":"","title":"Translations"},{"location":"credits/#third-party-libraries-and-other-code","text":"Qt licensed under the GNU GPLv3 OpenSSL licensed under the OpenSSL License and the SSLeay License","title":"Third-party libraries and other code"},{"location":"credits/#documentation","text":"","title":"Documentation"},{"location":"credits/#text","text":"Nicolas Dufresne","title":"Text"},{"location":"credits/#pictures-and-media-files","text":"","title":"Pictures and Media Files"},{"location":"credits/#funding","text":"Rainbox Productions All the 583 backers from the RxOT Crowdfunding Campaign and especially: Adam Aguirre, Adam Buritsch, Adam Knight, Adrien Boutin, Adrien du Repaire, aembury, aescripts + aeplugins , A\u00efda del Solar, Alejandro R. Gonzalez, Aleksander Saharovsky, Alex Beekman, Alexandre FAVRE, alietout, Amit Gicelter, Ana Arce, Ana\u00efs Guigue, Andreas Tanner, andrewrakestraw, Anez Florez Corpus, Anne Frumin, ANTOINE BIEBER, Antoine Dueso, Antonis Petroulias, Antony Pastor, Archita Ghosh, Armelle Renac, Atelier Graphoui, audrey sysaykeo, Aur\u00e9lien Delamare, aur\u00e9lien malagoli, Autret Claude, Baptiste Cochard, Bartosz B\u0105k, basimabu, Bastien Bironneau, Bastien Delmare, Ben Fligans, Benjamin Cohen-Jonathan, Benjamin Trancart, benoit jodry, Bethany Vaughan, Breece Kelsey, Brent N Walker, Brian Kolm, Bruno Quintin, Busson Remy, Calinski julien, Cam Hayduk, Cameron Gough, Carlos Arandia, Caroline Maire, Cedric Layrac, C\u00e9dric Serres, C\u00e9lia Tocco, Celine Sanno, Ching Mok, Chlo\u00e9 Chatellier, chris kieffer, Christophe \u2018IKESU\u2019 Clarey, Claire Dejoie, cl\u00e9ment Laporte, Cl\u00e9ment Vernet, Coleen Lochabay, Colin Brain, Com\u2019of design, damien.bracciotti , Dan Hollacher, Daniel Arce, Daniel Budka, David Hoizey, David Polizelli Hoffmann, david.baril, Davide Bedocchi, Derek Lau, djstep1, Dmitry Abdeev, Ebube Onyema, Elen Le Tannou, Elisabeth Springer, Emiliano Martinez, Emilien Gillet, Eric Bardot, Eric Beaup\u00e8re, Eric Paoli Infanzon, Eriks Lapins, eva.lacuskova, eva.lacuskova, Fabien Nowak, Fanny Moulin, Fernando Ferreira da Costa Junior, Florent Bonneviale, Florent Guilbaud, Francis Banguet, Fran\u00e7ois QUILLARD, Fred Luzet, fuerst.pascal, George Bowler, Germain Cauvy, Giedrius Budrys, gil, Gilles Pfeiffer, Giz Beardon, greg.araya, GRELIER Florentine, Guave Studios GmbH Guave Motion, GU\u00c9RET Matthieu, Guido Mariano, Guilbert Sylvain, Guillaume Mariotti, Guillaume Marrou, Guillaume Polveche, Guillaume Rousseau, Gustavo Almenara, Gustavo Miaciro, Gwendal Le Naour, gyom h, H Robert Marquet \u201cBob\u201d, H\u00e5kon Lundvall, Harlem Harl, Herv\u00e9 Dumont, Hiromi Ishibashi, Hristina Braykova, Ilya Gusinski, INSITE SCOP, Jacek Jefimiuk, Jack Kasprzak, Jakub Adam Makowski, Jared Mark Graham, Jason Jantzen, Javier Villalba, Jean-Baptiste Quaghebeur, Jean-Baptiste Sanno, Jean-Damien Gros, Jean-Philippe Albaret, Jean-Philippe Jambert, Jeff Cooney, Jeremi Picard, Jeremy Pluvinage, Jesse Kerman, Joachim Schwarz, Joakim Ottosson, Joe Brooks, Joel PiTrel, Johannes Krohn, John Nelson, Jonas Hummelstrand, jonasgreulich, Jose Carlos Conde Acuaviva, jose gerardo arce lopez, joshua.gslaby, Juan David Almanza Lamo, Juanca Flores, Julie Faussard, Julien Brugi\u00e8re, Julien Gouz, Julien Pilarski, Julien Pilipczuk, Karyl GAUTIER, Kate Jessop, Keizo Abe, kim nari, Kirby Conn, Kris Bosmans, Krista van der Wilk, Lars , Latham Arnott, Laura Marchant, Laura Palmer, Laurent Kanadiou Freyre, Lea Str, Lemesre Julien Erase-studio, Lenny Pomerantz, LES FILMS DU NORD, Liguori Nicolas, Luca Pecori, Luigi De Frenza, Maeva Pensivy, Manuel Viqueira Carballal, Marc Messiaen, Marco Oggero, Maresch & Sturm, Mario Burbach, Mario Hounkanrin, Marion PATIN, Martial Coulon, Martin Pageot, Martine Carton, matanarbel, Mathieu Faure, Mathieu JACOULET, Mathieu Travi, Mathilde Boudet, Matt Lloyd, Matthew Fernandez, matthewacarrick, Matthias Jach, Matthieu Fremeaux, megamonkees , Merlin Pardo, Michael Gorbachev, Michael Helmrich, Mickael Carton, Micka\u00ebl Hernandez, morgan, Motion Caf\u00e9, Motion Design Studio BRUSSOBAUM, MrGlox , muftix, Mysteropodes Drouin, Neil Ingle, Nic Dean, nicolas bougere, Nicolas Castelli, Nicolas Chaunu, Nicolas Dehaut, Nicolas DIDION, Nicolas Dufresne, Nicolas Grandry, nicolas matelot, nicolas.palmier, nicole alman, nirl28, Norbert Radvanyi, Nothing to Hide, Nuno Trindade, Nycolas Gorizian, Oana Nechifor, Olivier Escher, Olivier Jean, Olivier Patt\u00e9, onillon.thierry, P Yalaoui, Pauline DE, Payage Mickael, pdicamillo12, Philip P Betts, Philipp Reinhardt, Philippe Mignot, Philippe VECI, Pierre Cornille, Pierre Jond, pierre marteel, Pierre Munier, Pierre W. Borne, Pierre-Alain L\u00e9croart, Pierre-Baptiste Harrivelle, QingRu Yu, Rapha\u00eblle Prud\u2019homme, R\u00e9mi Rongier, Renaud DANIEL, Renaud Mazotti, Ren\u00e9 Andritsch, Ricardo Abraham Ibarra Duarte, Ricardo Arce, Robin CARLO, Rodrigo Dominguez Salazar, Romy Tokic, Ronald Anzenberger, Ronny Andr\u00e4, Ronny Andr\u00e4, Roth Fr\u00e9d\u00e9ric, Roxana Rodriguez, Ruben Alejandro Trejo Segura, Ruben Gim\u00e9nez, ruldewuold, Ryan Sears, SAINT RAYMOND, Sam Burkardt, Samuel Van Ingen, samy tichadou, Saul Yance Echegaray, S\u00e9bastien GAETTA, Sebastien Mesnage, Sebastien Vincent, Sergey Vodianov, Shao H, shirley natasha pinto, Simon Hervieu, Simon Stojanovski, Songz Meng, Sonya Robine, Sorrentino Ana\u00efs, Spenser Williams, Stein WILD, Stephane Neau, St\u00e9phane Zissu, Stephanie Leonard, Stephen Richard, Steve Pratt, Sylvain Kauffmann, Tao Mao, THAN TRONG Frederic, Thiago Maia, Thomas Crausaz, Thomas Duphil, Thomas Prinzivalli, thrawn, Tiago Castro, Tim Martyn, Tom Conner, Tomas \u00c4rlemo, Tom\u00e1\u0161 Hon\u011bk, Tomas Spokauskas, traffic.in.the.skies, Trebalag Ludovic, Ty Bardi, Vadim Luks, Valentin Nozahic, Val\u00e9rie WINTZ, Valleron Nicolas, vendu, Veronica Delgado, Vicidomini Lionel, Viliam Snirc, Viliam Snirc, Villain Cedric, Vitaliy Movsha, Voignier lisa, Warren D M Reed, wlazinski matthieu, Xavier Golfier, Yan-Ali Tabarand, Yavor Popov, Yaya Gadon, Yohan Le Diraison, Yohann GAMBA, Yoran Legemble, Zach Prichard, Zden\u011bk Dovole, Z\u00e9t\u00e9ny V\u00f6r\u00f6s. Thank you! Without your generous support, Ramses would not exist.","title":"Funding"},{"location":"components/","text":"Documentation Ramses is a complete framework made of different components interacting together. This makes it very modular and scalable to any kind of production, from the freelancer working at home to the biggest studios.","title":"Introduction"},{"location":"components/#documentation","text":"Ramses is a complete framework made of different components interacting together. This makes it very modular and scalable to any kind of production, from the freelancer working at home to the biggest studios.","title":"Documentation"},{"location":"components/addons/","text":"Add-ons Warning Ramses is still under active development , and this documentation is still being written. For now, the only Add-on available 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 \u2026). 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\u2019re welcome to contribute with your own! Available Add-ons Host Application Language Status Details \u25ba API Python A Beta version is already available. \u25ba API ExtendScript For Adobe Creative Cloud API UXP For Adobe Creative Cloud UXP is a new scripting environment for Adobe Software. Ramses won\u2019t officially support it until it is mature enough, which is not the case as of September 2022. This being said, the ExtendScript API may be compatible with UXP . Adobe After Effects ExtendScript Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Adobe Illustrator ExtendScript Low-priority Adobe Photoshop ExtendScript Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets \u25ba Autodesk Maya Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Blender Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Cinema 4D ? Houdini ? Inkscape Python Low-priority Krita Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets The Foundry Nuke Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Legend: | Available | In development | Planned | Not supported yet, but you can develop your own add-on and contribute ! Introduction Here are some guidelines and descriptions about how these add-ons should work. We\u2019re 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 . 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 . Note To be written\u2026 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: Save : [Ctrl] + [S] Save new version : [Ctrl] + [Alt] + [S] Publish : [Ctrl] + [Shift] + [P] These shortcuts have been chosen to avoid conflicts in most host applications but can be changed to something else if they\u2019re 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 UI guidelines. The panel must display buttons for all available commands. Note To be improved and completed\u2026 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, at least: Location of the Ramses Client executable file ( .exe on Windows , .app on MacOS , .appimage or binary on Linux ) Listening port of the Ramses Daemon Whether to connect to the daemon or not. Ramses data path (the folder containing the files) Development options (verbosity/debug mode) Note: the settings are saved in a shared location (user documents folder ?) between all add-ons so that they\u2019re configured only once. They\u2019re in an easy-to-edit JSON text file.","title":"General Information"},{"location":"components/addons/#add-ons","text":"Warning Ramses is still under active development , and this documentation is still being written. For now, the only Add-on available 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 \u2026). 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\u2019re welcome to contribute with your own!","title":"Add-ons"},{"location":"components/addons/#available-add-ons","text":"Host Application Language Status Details \u25ba API Python A Beta version is already available. \u25ba API ExtendScript For Adobe Creative Cloud API UXP For Adobe Creative Cloud UXP is a new scripting environment for Adobe Software. Ramses won\u2019t officially support it until it is mature enough, which is not the case as of September 2022. This being said, the ExtendScript API may be compatible with UXP . Adobe After Effects ExtendScript Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Adobe Illustrator ExtendScript Low-priority Adobe Photoshop ExtendScript Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets \u25ba Autodesk Maya Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Blender Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Cinema 4D ? Houdini ? Inkscape Python Low-priority Krita Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets The Foundry Nuke Python Versionning , status and comments. Preview : easy playblast or thumbnail Pipeline : publish, import, replace, update assets Pipeline : Advanced customization using publish and import settings and presets Legend: | Available | In development | Planned | Not supported yet, but you can develop your own add-on and contribute !","title":"Available Add-ons"},{"location":"components/addons/#introduction","text":"Here are some guidelines and descriptions about how these add-ons should work. We\u2019re 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 . 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.","title":"Introduction"},{"location":"components/addons/#available-commands","text":"Some of these commands manage files in the Ramses Tree , see the corresponding documentation . Note To be written\u2026","title":"Available Commands"},{"location":"components/addons/#ui-ux","text":"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.","title":"UI / UX"},{"location":"components/addons/#integrated-commands","text":"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: Save : [Ctrl] + [S] Save new version : [Ctrl] + [Alt] + [S] Publish : [Ctrl] + [Shift] + [P] These shortcuts have been chosen to avoid conflicts in most host applications but can be changed to something else if they\u2019re still conflicting with something important.","title":"Integrated commands"},{"location":"components/addons/#ui-panel","text":"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 UI guidelines. The panel must display buttons for all available commands. Note To be improved and completed\u2026","title":"UI Panel"},{"location":"components/addons/#settings","text":"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, at least: Location of the Ramses Client executable file ( .exe on Windows , .app on MacOS , .appimage or binary on Linux ) Listening port of the Ramses Daemon Whether to connect to the daemon or not. Ramses data path (the folder containing the files) Development options (verbosity/debug mode) Note: the settings are saved in a shared location (user documents folder ?) between all add-ons so that they\u2019re configured only once. They\u2019re in an easy-to-edit JSON text file.","title":"Settings"},{"location":"components/addons/maya-extend/","text":"Extending the Ramses Maya Add-on You can easily add features to the Ramses Maya Add-On , especially by registering your own scripts/methods to be run when a status changes, when a scene is being published, or to import items. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Getting started Technically, the simplest and recommended way to extend the Ramses Maya Add-On is to add your own module(s) inside the Add-on iteself. It is very easy and this way you do not need to register your script or plug-in with Maya , Ramses takes care of that for you. Install the Add-On First, install the Ramses Maya Add-On as described here . These folders should be available: icons : The icons used by the Add-On plug-ins : The actual Python code dumaf : Some useful Python code for Maya ramses : The Ramses Scripting API as a Python module ramses_maya : The Add-On itself shelves : The Ramses Maya shelf Create your module All you need to do to easily extend the Ramses Maya Add-On is to create your own module in the plug-ins folder. Create a subfolder in the plug-ins folder, containing an empty __init__.py file. You can also optionally add your own shelf in the shelves folder. The new tree should look like this: icons plug-ins dumaf ramses ramses_maya your_new_module : contains __init__.py shelves : optionally add shelf_YourModule.mel In the new your_new_module/__init__.py file, you will import or code all the methods you want to expose and make available in Maya, for example to be used in a shelf or any other Python script. You can also register your Ramses callbacks there (read below for more information about Ramses callbacks). Here is an example of such an __init__.py file, assuming you have two other files ( anotherFile.py and aSecondFile.py ) in the same folder, containing the actual code and methods to import: from .anotherFile import aPublicMethod from .aSecondFile import aPublishMethod, anImportMethod # Now, 'aPublicMethod' can be called from everyhwere in Maya # And we can register the publish and import method as callbacks for Ramses. # For this, we need to import the Ramses Module (API) from ramses import Ramses # Now we just have to add the callbacks: ramses = Ramses.instance() # The publish method ramses.publishScripts.append( aPublishMethod ) # The import method ramses.importScripts.append( anImportMethod ) Import the module Finally, you just have to import your new module in the ramses_maya module: add a simple import at the end of the ramses_maya/__init__.py file, which should look like this: from .ram_cmds import cmds_classes from ramses import log, LogLevel import your_new_module Both the new module and the shelf will be automatically registered by the Ramses Maya Add-On when it\u2019s loaded in Maya . Callbacks Ramses stores three lists of callbacks you can extend. Ramses.publishScripts contains the functions to be called when a scene is being published. When Ramses publishes a scene, it calls all the scripts listed there. There already is a script which provides the default implementation; you can either remove it to disable it completely, or just add your own which will be run after (or before if you insert it at the beginning of the list). Each callback you add to this list must take a few arguments. Read the Scripting API Reference for more information. Ramses.statusScripts contains the functions to be called when a scene status changes. When Ramses updates a status, it first copies the scene file to the version folder and calls the Daemon (if available) to notify the update, and then calls all the scripts listed there. Each callback you add to this list must take two arguments. Read the Scripting API Reference for more information. Ramses.importScripts contains the functions to be called when the user selects an item (shot or asset) to import. There already is a script which provides the default implementation for importing items; you can either remove it to disable it completely, or just add your own which will be run after (or before if you insert it at the beginning of the list). . Each callback you add to this list must take a few arguments. Read the Scripting API Reference for more information. There are two ways to register your methods: by using a Maya command, or by forking the provided Add-On to add your functions. Once the callbacks have been registered, they are automatically called when the user interacts with the add-on and wants to update/import/publish an item. You can also explicitly call them by calling these three methods: Ramses.updateStatus( item, status, stepShortName ) Ramses.importItem( item, filePath, stepShortName ) Ramses.publish( item, filePath, stepShortName ) Read the Scripting API Reference for more information. Adding your custom callbacks To register your callbacks, you just have to append them in the corresponding Ramses lists: # We need to import the Ramses Module (API) from ramses import Ramses # Now we just have to add the callbacks ramses = Ramses.instance() # First, remove callbacks provided by the Ramses addon, # to replace them with our own ramses.publishScripts = [] ramses.importScripts = [] ramses.statusScripts = [] # A publish method ramses.publishScripts.append( aPublishMethod ) # An import method ramses.importScripts.append( anImportMethod ) # A status method ramses.statusScripts.append( aStatusMethod ) Now, all these methods will be automatically called each time a status changes, an item is published, or an item is imported. Detailed Example In this example, three files are added, with the import, status, and publish methods. The file plug-ins/your_new_module/myPublishCallbacks.py creates the callbacks used to publish shots and assets. # myPublishCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def publishAsset(item, filePath, step): \"\"\"Callback used to publish Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the filePath and the Step doSomething( item.shortName(), item.group(), filePath, step.shortName()) # etc. def publishShot(item, filePath, step): \"\"\"Callback used to publish Shots only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.SHOT: return # Now we can do what we need using the RamShot object, the filePath and the Step doSomething( item.shortName(), item.duration(), filePath, step.shortName()) # etc. The file plug-ins/your_new_module/myStatusCallbacks.py creates the callbacks used when a status changes. # myStatusCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def updateAsset(item, status, step): \"\"\"Callback used to update Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the RamStatus object and the RamStep object doSomething( item.shortName(), item.group(), status.completionRatio, status.user, step.shortName()) # etc. def updateShot(item, filePath, publishFolderPath): \"\"\"Callback used to update Shots only\"\"\" # The item must be a RamShot if item.itemType() != ram.ItemType.SHOT: return # Now we can do what we need using the RamAsset object, the RamStatus object and the RamStep object doSomething( item.shortName(), item.group(), status.completionRatio, status.user, step.shortName()) # etc. The file plug-ins/your_new_module/myImportCallbacks.py creates the callbacks used to import items. # myImportCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def importAsset(item, filePath, step): \"\"\"Callback used to import Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the RamStep object and the file path doSomething( item.shortName(), item.group(), step.shortName(), filePath) # etc. The file plug-ins/your_new_module/otherMethods.py creates a few other methods, for example to be used in a Maya shelf . # otherMethods.py def methodForAShelf(): doSomething() Finally, we just need to import these files in the plug-ins/your_new_module/__init__.py file of our custom module. We can register them here. # __init__.py from myImportCallbacks import importAsset from myStatusCallbacks import updateAsset, updateShot from myPublishCallbacks import publishAsset, publishShot from otherMethods import methodForAShelf from ramses import Ramses # Get the ramses instance ramses = Ramses.instance() # First, remove callbacks provided by the Ramses addon, # to replace them with our own ramses.publishScripts = [] ramses.importScripts = [] ramses.statusScripts = [] # Add the callbacks to the publish list ramses.publishScripts.append( publishAsset ) ramses.publishScripts.append( publishShot ) # Add the callbacks to the status list ramses.statusScripts.append( updateAsset ) ramses.statusScripts.append( updateShot ) # Add the callbacks to the status list ramses.importScripts.append( importAsset ) And don\u2019t forget to import your new module in plug-ins/ramses_maya/__init__.py : # plug-ins/ramses_maya/__init__.py from .ram_cmds import cmds_classes from ramses import log, LogLevel import your_new_module Don\u2019t change anything else in the file! Now you can also use methodForAShelf() in an existing or new shelf , which can be stored in the shelves folder if you want it to be deployed with your extension.","title":"Extensibility"},{"location":"components/addons/maya-extend/#extending-the-ramses-maya-add-on","text":"You can easily add features to the Ramses Maya Add-On , especially by registering your own scripts/methods to be run when a status changes, when a scene is being published, or to import items. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions.","title":"Extending the Ramses Maya Add-on"},{"location":"components/addons/maya-extend/#getting-started","text":"Technically, the simplest and recommended way to extend the Ramses Maya Add-On is to add your own module(s) inside the Add-on iteself. It is very easy and this way you do not need to register your script or plug-in with Maya , Ramses takes care of that for you.","title":"Getting started"},{"location":"components/addons/maya-extend/#install-the-add-on","text":"First, install the Ramses Maya Add-On as described here . These folders should be available: icons : The icons used by the Add-On plug-ins : The actual Python code dumaf : Some useful Python code for Maya ramses : The Ramses Scripting API as a Python module ramses_maya : The Add-On itself shelves : The Ramses Maya shelf","title":"Install the Add-On"},{"location":"components/addons/maya-extend/#create-your-module","text":"All you need to do to easily extend the Ramses Maya Add-On is to create your own module in the plug-ins folder. Create a subfolder in the plug-ins folder, containing an empty __init__.py file. You can also optionally add your own shelf in the shelves folder. The new tree should look like this: icons plug-ins dumaf ramses ramses_maya your_new_module : contains __init__.py shelves : optionally add shelf_YourModule.mel In the new your_new_module/__init__.py file, you will import or code all the methods you want to expose and make available in Maya, for example to be used in a shelf or any other Python script. You can also register your Ramses callbacks there (read below for more information about Ramses callbacks). Here is an example of such an __init__.py file, assuming you have two other files ( anotherFile.py and aSecondFile.py ) in the same folder, containing the actual code and methods to import: from .anotherFile import aPublicMethod from .aSecondFile import aPublishMethod, anImportMethod # Now, 'aPublicMethod' can be called from everyhwere in Maya # And we can register the publish and import method as callbacks for Ramses. # For this, we need to import the Ramses Module (API) from ramses import Ramses # Now we just have to add the callbacks: ramses = Ramses.instance() # The publish method ramses.publishScripts.append( aPublishMethod ) # The import method ramses.importScripts.append( anImportMethod )","title":"Create your module"},{"location":"components/addons/maya-extend/#import-the-module","text":"Finally, you just have to import your new module in the ramses_maya module: add a simple import at the end of the ramses_maya/__init__.py file, which should look like this: from .ram_cmds import cmds_classes from ramses import log, LogLevel import your_new_module Both the new module and the shelf will be automatically registered by the Ramses Maya Add-On when it\u2019s loaded in Maya .","title":"Import the module"},{"location":"components/addons/maya-extend/#callbacks","text":"Ramses stores three lists of callbacks you can extend. Ramses.publishScripts contains the functions to be called when a scene is being published. When Ramses publishes a scene, it calls all the scripts listed there. There already is a script which provides the default implementation; you can either remove it to disable it completely, or just add your own which will be run after (or before if you insert it at the beginning of the list). Each callback you add to this list must take a few arguments. Read the Scripting API Reference for more information. Ramses.statusScripts contains the functions to be called when a scene status changes. When Ramses updates a status, it first copies the scene file to the version folder and calls the Daemon (if available) to notify the update, and then calls all the scripts listed there. Each callback you add to this list must take two arguments. Read the Scripting API Reference for more information. Ramses.importScripts contains the functions to be called when the user selects an item (shot or asset) to import. There already is a script which provides the default implementation for importing items; you can either remove it to disable it completely, or just add your own which will be run after (or before if you insert it at the beginning of the list). . Each callback you add to this list must take a few arguments. Read the Scripting API Reference for more information. There are two ways to register your methods: by using a Maya command, or by forking the provided Add-On to add your functions. Once the callbacks have been registered, they are automatically called when the user interacts with the add-on and wants to update/import/publish an item. You can also explicitly call them by calling these three methods: Ramses.updateStatus( item, status, stepShortName ) Ramses.importItem( item, filePath, stepShortName ) Ramses.publish( item, filePath, stepShortName ) Read the Scripting API Reference for more information.","title":"Callbacks"},{"location":"components/addons/maya-extend/#adding-your-custom-callbacks","text":"To register your callbacks, you just have to append them in the corresponding Ramses lists: # We need to import the Ramses Module (API) from ramses import Ramses # Now we just have to add the callbacks ramses = Ramses.instance() # First, remove callbacks provided by the Ramses addon, # to replace them with our own ramses.publishScripts = [] ramses.importScripts = [] ramses.statusScripts = [] # A publish method ramses.publishScripts.append( aPublishMethod ) # An import method ramses.importScripts.append( anImportMethod ) # A status method ramses.statusScripts.append( aStatusMethod ) Now, all these methods will be automatically called each time a status changes, an item is published, or an item is imported.","title":"Adding your custom callbacks"},{"location":"components/addons/maya-extend/#detailed-example","text":"In this example, three files are added, with the import, status, and publish methods. The file plug-ins/your_new_module/myPublishCallbacks.py creates the callbacks used to publish shots and assets. # myPublishCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def publishAsset(item, filePath, step): \"\"\"Callback used to publish Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the filePath and the Step doSomething( item.shortName(), item.group(), filePath, step.shortName()) # etc. def publishShot(item, filePath, step): \"\"\"Callback used to publish Shots only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.SHOT: return # Now we can do what we need using the RamShot object, the filePath and the Step doSomething( item.shortName(), item.duration(), filePath, step.shortName()) # etc. The file plug-ins/your_new_module/myStatusCallbacks.py creates the callbacks used when a status changes. # myStatusCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def updateAsset(item, status, step): \"\"\"Callback used to update Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the RamStatus object and the RamStep object doSomething( item.shortName(), item.group(), status.completionRatio, status.user, step.shortName()) # etc. def updateShot(item, filePath, publishFolderPath): \"\"\"Callback used to update Shots only\"\"\" # The item must be a RamShot if item.itemType() != ram.ItemType.SHOT: return # Now we can do what we need using the RamAsset object, the RamStatus object and the RamStep object doSomething( item.shortName(), item.group(), status.completionRatio, status.user, step.shortName()) # etc. The file plug-ins/your_new_module/myImportCallbacks.py creates the callbacks used to import items. # myImportCallbacks.py import ramses as ram # Get the ramses instance ramses = ram.Ramses.instance() def importAsset(item, filePath, step): \"\"\"Callback used to import Assets only\"\"\" # The item must be a RamAsset if item.itemType() != ram.ItemType.ASSET: return # Now we can do what we need using the RamAsset object, the RamStep object and the file path doSomething( item.shortName(), item.group(), step.shortName(), filePath) # etc. The file plug-ins/your_new_module/otherMethods.py creates a few other methods, for example to be used in a Maya shelf . # otherMethods.py def methodForAShelf(): doSomething() Finally, we just need to import these files in the plug-ins/your_new_module/__init__.py file of our custom module. We can register them here. # __init__.py from myImportCallbacks import importAsset from myStatusCallbacks import updateAsset, updateShot from myPublishCallbacks import publishAsset, publishShot from otherMethods import methodForAShelf from ramses import Ramses # Get the ramses instance ramses = Ramses.instance() # First, remove callbacks provided by the Ramses addon, # to replace them with our own ramses.publishScripts = [] ramses.importScripts = [] ramses.statusScripts = [] # Add the callbacks to the publish list ramses.publishScripts.append( publishAsset ) ramses.publishScripts.append( publishShot ) # Add the callbacks to the status list ramses.statusScripts.append( updateAsset ) ramses.statusScripts.append( updateShot ) # Add the callbacks to the status list ramses.importScripts.append( importAsset ) And don\u2019t forget to import your new module in plug-ins/ramses_maya/__init__.py : # plug-ins/ramses_maya/__init__.py from .ram_cmds import cmds_classes from ramses import log, LogLevel import your_new_module Don\u2019t change anything else in the file! Now you can also use methodForAShelf() in an existing or new shelf , which can be stored in the shelves folder if you want it to be deployed with your extension.","title":"Detailed Example"},{"location":"components/addons/maya-import/","text":"Importing assets When importing or replacing assets, there are a few options. The same way publish settings can use presets or be set directly in the Ramses Client Application , Ramses will look for presets and default settings when importing the assets. In the first tab, you can optionally select an existing preset. Presets are stored in a folder inside the Maya module folder. You can save or load a preset with Edit \u25ba Save preset... and Edit \u25ba Load preset... . When a preset is saved in the default folder, it is listed in the box in this tab. Ramses provides a few presets by default, they\u2019re good examples of what you can do. Alembic - Reference and shaders imports an alembic file as a reference, along with Maya shader libraries. Alembic and shaders imports an alembic file, and Maya shader libraries as a reference. Maya - Lock transform imports a Maya file, and locks the transformations of the imported asset. Maya - Reference references a Maya file. Maya simply imports a Maya file. You can safely delete these presets from the preset folder if you don\u2019t need them. Format settings For each format to import, you can set some settings. The text on the right can be copied to any pipe type in the Ramses Client Application . When importing an asset, Ramses will first look for these settings, and if they\u2019re found, it won\u2019t show the settings dialog unless the user checked the box Edit import options when importing the asset. Files can be imported as references . All transformations of all nodes can be locked . By default, a namespace is created to store the imported objects. This can be deactivated. Use with caution as name conflicts can generate errors on import/update! Imported objects are grouped in a transform node. By default, a shape (a square around the objects as a nurbsCurve ) is created to easily manipulate them in the viewport. When importing a shader library, shaders can automatically be applied on the selected nodes. Ramses will use the node names to apply the shaders: the selected nodes must have the exact same name as the nodes in the scene used to publish the shaders. Shaders When importing a shader library , as published with the publish method of the Add-On , Ramses will automatically assign these shaders to any mesh imported along with the shaders; this is a quick way to import both Alembic meshes and their shaders for example: just import both files at once. If you just want to assign the shaders to existing geometry, just select on or several nodes containing the meshes, and Ramses will try to assign the imported shaders to them, using the names of the transform nodes containing the meshes. If the shaders are not correctly assigned, check the names of the nodes. Namespaces are ignored when matching nodes with their shader. If you need to replace or reassign shaders already imported, the quick and easy way is to remove them from the scene, select the meshes, and import them again. All the shaders will be automatically re-assigned. All Settings These are all the available settings: format: '*' # The file format these settings apply to. Either a wildcard '*' or the file extension (without the leading \".\") apply_shaders: true as_reference: false lock_transformations: true create_namespace: true no_root_shape: false These settings can be set directly in the Ramses Application\u2019s pipeline editor , or directly using the pipe editor , in the settings field.","title":"Import settings"},{"location":"components/addons/maya-import/#importing-assets","text":"When importing or replacing assets, there are a few options. The same way publish settings can use presets or be set directly in the Ramses Client Application , Ramses will look for presets and default settings when importing the assets. In the first tab, you can optionally select an existing preset. Presets are stored in a folder inside the Maya module folder. You can save or load a preset with Edit \u25ba Save preset... and Edit \u25ba Load preset... . When a preset is saved in the default folder, it is listed in the box in this tab. Ramses provides a few presets by default, they\u2019re good examples of what you can do. Alembic - Reference and shaders imports an alembic file as a reference, along with Maya shader libraries. Alembic and shaders imports an alembic file, and Maya shader libraries as a reference. Maya - Lock transform imports a Maya file, and locks the transformations of the imported asset. Maya - Reference references a Maya file. Maya simply imports a Maya file. You can safely delete these presets from the preset folder if you don\u2019t need them.","title":"Importing assets"},{"location":"components/addons/maya-import/#format-settings","text":"For each format to import, you can set some settings. The text on the right can be copied to any pipe type in the Ramses Client Application . When importing an asset, Ramses will first look for these settings, and if they\u2019re found, it won\u2019t show the settings dialog unless the user checked the box Edit import options when importing the asset. Files can be imported as references . All transformations of all nodes can be locked . By default, a namespace is created to store the imported objects. This can be deactivated. Use with caution as name conflicts can generate errors on import/update! Imported objects are grouped in a transform node. By default, a shape (a square around the objects as a nurbsCurve ) is created to easily manipulate them in the viewport. When importing a shader library, shaders can automatically be applied on the selected nodes. Ramses will use the node names to apply the shaders: the selected nodes must have the exact same name as the nodes in the scene used to publish the shaders.","title":"Format settings"},{"location":"components/addons/maya-import/#shaders","text":"When importing a shader library , as published with the publish method of the Add-On , Ramses will automatically assign these shaders to any mesh imported along with the shaders; this is a quick way to import both Alembic meshes and their shaders for example: just import both files at once. If you just want to assign the shaders to existing geometry, just select on or several nodes containing the meshes, and Ramses will try to assign the imported shaders to them, using the names of the transform nodes containing the meshes. If the shaders are not correctly assigned, check the names of the nodes. Namespaces are ignored when matching nodes with their shader. If you need to replace or reassign shaders already imported, the quick and easy way is to remove them from the scene, select the meshes, and import them again. All the shaders will be automatically re-assigned.","title":"Shaders"},{"location":"components/addons/maya-import/#all-settings","text":"These are all the available settings: format: '*' # The file format these settings apply to. Either a wildcard '*' or the file extension (without the leading \".\") apply_shaders: true as_reference: false lock_transformations: true create_namespace: true no_root_shape: false These settings can be set directly in the Ramses Application\u2019s pipeline editor , or directly using the pipe editor , in the settings field.","title":"All Settings"},{"location":"components/addons/maya-pipeline/","text":"The Maya pipeline With Ramses and its Maya Add-on, the Maya pipeline is easy-to-use but you have access to all parameters when publishing and importing files. Using presets and/or the Ramses Client Application you can completely automate the pipeline according to your specific needs. \u25b9 Read more about the pipeline . \u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"Maya pipeline"},{"location":"components/addons/maya-pipeline/#the-maya-pipeline","text":"With Ramses and its Maya Add-on, the Maya pipeline is easy-to-use but you have access to all parameters when publishing and importing files. Using presets and/or the Ramses Client Application you can completely automate the pipeline according to your specific needs. \u25b9 Read more about the pipeline . \u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"The Maya pipeline"},{"location":"components/addons/maya-publish/","text":"Setting the publishing parameters Use the Publish settings button from the Add-on \u2018s shelf to access all available parameters for publishing in Maya. From this dialog, you can build your own presets, or set some settings as defaults for any specific step in your pipeline . In the first tab, select the step for which your setting the publishing parameters, and optionally select an existing preset. Presets are stored in a folder inside the Maya module folder. You can save or load a preset with Edit \u25ba Save preset... and Edit \u25ba Load preset... . When a preset is saved in the default folder, it is listed in the box in this tab. Ramses provides a few presets by default, they\u2019re good examples of what you can do. Animation.abc can be used for publishing animation and cameras as a lightweight alembic file. Arnold.ass is a simple preset to publish the selected nodes as an Arnold Scene Source . Geometry.abc is meant for publishing mesh nodes without animation. Shaders are automatically published separately as a Maya Binary . Rig.ma can be used to publish rigged characters and props, and more generally any kind of Maya scene, as a Maya ASCII file. Shaders.mb publishes only the shaders from the selected nodes. Simple.mb is a general preset which can be used with any kind of scene. You can safely delete these presets from the preset folder if you don\u2019t need them. The text area on the right shows the preset as a text. This text can be saved or used directly in the publish settings of any step in the Ramses Client Application , to be automatically used when publishing files for the given step. In this case, this settings window will not be shown anymore when publishing files, unless the user checks the Edit publish settings box when saving the scene. If the Ramses Client Application is running, you don\u2019t necessarily need to use presets; clicking on the Save settings button will set the current settings to the selected step. They can then also be edited directly in the Ramses Client Application . This text uses the Yaml syntax, which can easily be edited manually. Pre-Publish settings Before publishing, Ramses can run some checks and clean the scene. Import all references , to avoid nested references Remove namespaces , to simplify node names when importing Remove all hidden nodes Delete all histories Leave only a single shape per transform node . Extra shapes should not be needed. Remove all empty groups Remove all keyframes and animation Types : you can choose to keep (white list) or remove (black list) specific node types. To check the types of the nodes to complete the list, use the Mel/Python command nodeType . Freeze transformations of all the nodes , except those containing specific strings in their name. Maya scene Select either Binary or ASCII file . All hidden node visibilities can be automatically locked . All transformations can be locked . You can select how joints will be displayed in the published file. Maya scene - Shader library Select either Binary or ASCII file . When publishing a shader library, Ramses keeps the list of nodes the shaders are applied to, and is able to re-assign them when importing the library in any scene. Alembic You can choose to keep only renderable nodes and remove all other shapes. Use the handles control to add some time before and after the scene\u2019s time range. You can change the frame step to make the exported file lighter or more detailed (e.g. for precise motion blur). You can automatically filter Euler rotations . Arnold Scene Source There are no options for this format. All Settings These are all the available settings: delete_history: false formats: # Format specific options - mb: # Maya Binary options joints: disable # one of \"disable\", \"hide\", \"lock\", \"keep\" lock_hidden_nodes: true lock_transformations: false only_shaders: true - abc: # Alembic options animation: frame_step: 1.0 handle_in: 0 # in frames handle_out: 0 filter_euler_rotations: true renderable_only: true - ass # Arnold secne source options (emtpy, no options) freeze_transform: case_sensitive: false whitelist: - _eye_ - _eyes_ import_references: true remove_animation: false remove_empty_groups: true remove_extra_shapes: false remove_hidden_nodes: false remove_namespaces: true types: list: - bezierCurve - nurbsCurve - nurbsSurface - locator mode: remove # either \"remove\" or \"keep\" These settings can be set directly in the Ramses Application\u2019s step editor , in the Publish settings tab.","title":"Publish settings"},{"location":"components/addons/maya-publish/#setting-the-publishing-parameters","text":"Use the Publish settings button from the Add-on \u2018s shelf to access all available parameters for publishing in Maya. From this dialog, you can build your own presets, or set some settings as defaults for any specific step in your pipeline . In the first tab, select the step for which your setting the publishing parameters, and optionally select an existing preset. Presets are stored in a folder inside the Maya module folder. You can save or load a preset with Edit \u25ba Save preset... and Edit \u25ba Load preset... . When a preset is saved in the default folder, it is listed in the box in this tab. Ramses provides a few presets by default, they\u2019re good examples of what you can do. Animation.abc can be used for publishing animation and cameras as a lightweight alembic file. Arnold.ass is a simple preset to publish the selected nodes as an Arnold Scene Source . Geometry.abc is meant for publishing mesh nodes without animation. Shaders are automatically published separately as a Maya Binary . Rig.ma can be used to publish rigged characters and props, and more generally any kind of Maya scene, as a Maya ASCII file. Shaders.mb publishes only the shaders from the selected nodes. Simple.mb is a general preset which can be used with any kind of scene. You can safely delete these presets from the preset folder if you don\u2019t need them. The text area on the right shows the preset as a text. This text can be saved or used directly in the publish settings of any step in the Ramses Client Application , to be automatically used when publishing files for the given step. In this case, this settings window will not be shown anymore when publishing files, unless the user checks the Edit publish settings box when saving the scene. If the Ramses Client Application is running, you don\u2019t necessarily need to use presets; clicking on the Save settings button will set the current settings to the selected step. They can then also be edited directly in the Ramses Client Application . This text uses the Yaml syntax, which can easily be edited manually.","title":"Setting the publishing parameters"},{"location":"components/addons/maya-publish/#pre-publish-settings","text":"Before publishing, Ramses can run some checks and clean the scene. Import all references , to avoid nested references Remove namespaces , to simplify node names when importing Remove all hidden nodes Delete all histories Leave only a single shape per transform node . Extra shapes should not be needed. Remove all empty groups Remove all keyframes and animation Types : you can choose to keep (white list) or remove (black list) specific node types. To check the types of the nodes to complete the list, use the Mel/Python command nodeType . Freeze transformations of all the nodes , except those containing specific strings in their name.","title":"Pre-Publish settings"},{"location":"components/addons/maya-publish/#maya-scene","text":"Select either Binary or ASCII file . All hidden node visibilities can be automatically locked . All transformations can be locked . You can select how joints will be displayed in the published file.","title":"Maya scene"},{"location":"components/addons/maya-publish/#maya-scene-shader-library","text":"Select either Binary or ASCII file . When publishing a shader library, Ramses keeps the list of nodes the shaders are applied to, and is able to re-assign them when importing the library in any scene.","title":"Maya scene - Shader library"},{"location":"components/addons/maya-publish/#alembic","text":"You can choose to keep only renderable nodes and remove all other shapes. Use the handles control to add some time before and after the scene\u2019s time range. You can change the frame step to make the exported file lighter or more detailed (e.g. for precise motion blur). You can automatically filter Euler rotations .","title":"Alembic"},{"location":"components/addons/maya-publish/#arnold-scene-source","text":"There are no options for this format.","title":"Arnold Scene Source"},{"location":"components/addons/maya-publish/#all-settings","text":"These are all the available settings: delete_history: false formats: # Format specific options - mb: # Maya Binary options joints: disable # one of \"disable\", \"hide\", \"lock\", \"keep\" lock_hidden_nodes: true lock_transformations: false only_shaders: true - abc: # Alembic options animation: frame_step: 1.0 handle_in: 0 # in frames handle_out: 0 filter_euler_rotations: true renderable_only: true - ass # Arnold secne source options (emtpy, no options) freeze_transform: case_sensitive: false whitelist: - _eye_ - _eyes_ import_references: true remove_animation: false remove_empty_groups: true remove_extra_shapes: false remove_hidden_nodes: false remove_namespaces: true types: list: - bezierCurve - nurbsCurve - nurbsSurface - locator mode: remove # either \"remove\" or \"keep\" These settings can be set directly in the Ramses Application\u2019s step editor , in the Publish settings tab.","title":"All Settings"},{"location":"components/addons/maya-scenesetup/","text":"Scene setup / General parameters The Maya Add-on is able to automatically setup the maya scenes for the assets and the shots, to select the right camera, set the correct rendering resolution, set the correct timeline start and end time\u2026 Click the Scene Setup button to setup the scene. These parameters are retrieved from the shot or asset and project data; you can also customize these settings for each step. You can add these settings via the Ramses Application, using the step editor \u2018s general settings, like in this example: This text uses the Yaml syntax. These are the available settings: shot: handle_in: 24 # The handle to add before the shot start time, in frames handle_out: 24 # The handle to add after the shot end time, in frames first_image_number: 101 # The number of the first frame in the timeline (including the handle_in)","title":"Scene setup"},{"location":"components/addons/maya-scenesetup/#scene-setup-general-parameters","text":"The Maya Add-on is able to automatically setup the maya scenes for the assets and the shots, to select the right camera, set the correct rendering resolution, set the correct timeline start and end time\u2026 Click the Scene Setup button to setup the scene. These parameters are retrieved from the shot or asset and project data; you can also customize these settings for each step. You can add these settings via the Ramses Application, using the step editor \u2018s general settings, like in this example: This text uses the Yaml syntax. These are the available settings: shot: handle_in: 24 # The handle to add before the shot start time, in frames handle_out: 24 # The handle to add after the shot end time, in frames first_image_number: 101 # The number of the first frame in the timeline (including the handle_in)","title":"Scene setup / General parameters"},{"location":"components/addons/maya/","text":"Ramses Maya Add-on Ramses comes with an official add-on for Autodesk Maya , which actually consists in a Python plug-in and a custom shelf packaged in a simple single module. It is an example of an implementation of an add-on using the Ramses Python API but it is already well suited for use in production. As well as all other Ramses Add-ons , the Ramses Maya Add-on includes the main features like versionning, publishing and production tracking with Ramses , but it can be extended to automate your workflow . This Add-on can be used with or without being connected to the Ramses Daemon (and the Ramses Client Application ). If it is connected to the Daemon , it will automatically update the production tracking data. Installation Download and unzip the module. To quickly deploy the module on several workstations, choose a shared location; the module can then be shared with all workstations and updated at once. Edit Ramses.mod with a text editor, and replace the path in the first line with the absolute path where you\u2019ve unzipped the module. This is how the content of this file looks like: + Ramses 0.0.1-dev D:\\your\\path\\to\\the\\module PYTHONPATH+:=plug-ins MAYA_SHELF_PATH+:=shelves Do not change anything else in the file. In order to prevent unintended modifications to the Ramses shelf, you can set its read-only attribute: Right click on the shelves/shelf_Ramses.mel file and select Properties . Check the Read only box. Copy Ramses.mod in one of your modules paths e.g. C:\\Users\\User\\Documents\\Maya\\modules . You may need to create the modules folder if it does not exist yet. Repeat this operation on all workstations where you need the module. Restart Maya . Activate the Ramses plug-in from Maya \u2018s plug-in manager. You may need to restart Maya again so that the Ramses shelf is loaded. Features All features of the Ramses add-on are available through the new shelf. They are also registered as Mel and Python Maya commands. All these features are detailed in the next sections. To handle all file naming and sorting, Ramses includes commands to replace all the default Save , Save As and Open functions. Using (almost) only the Ramses commands ensures your files will always be correctly named and in the right location. It also helps Ramses track the production. Feature Maya Command Description Open the Ramses App ramOpenRamses Launches the Ramses Client Application (if its path is correctly set in the settings). Save ramSave Saves and backups the current scene; this save command is also used for production tracking. Comment ramSave Associates a comment wit the current scene file. Incremental Save ramSaveVersion Saves and increments the version of the current scene. Update Status / Publish ramSaveVersion Saves and increments the version of the current scene, while updating its current production tracking status. Optionally publishes the asset/shot. Create Preview ramPreview Creates a preview (thumbnail or playblast) of the current scene. Save as ramSaveAs Saves the scene as a new Asset, Shot or General item. Template ramPublishTemplate Saves the current scene as a new template for the current step. Setup scene ramSetupScene Setups the scene to make it Ramses-friendly. Open ramOpen Opens an Asset, Shot or Template. Import ramOpen Imports an Asset, Shot or Template. Replace ramOpen Replaces selected nodes with another Asset, Shot or Template. Update ramUpdate Updates assets and shots included in the scene. Retrieve Version ramRetrieveVersion Retrieves and restores a previous version of the current scene. Publish settings ramPublishSettings Sets the default publish settings for steps. Settings ramSettings Opens the settings dialog for the Ramses Add-on . Save The Ramses Save command starts by saving the current scene, and then runs a few checks before backuping the file into the _versions subfolder: Naming Scheme : checks if the file is correctly named and located. If not, Ramses will run the Save as command instead to ensure the name is correct. Version : checks if the version has to be incremented. That\u2019s the case if the current scene is a restored previous version, or if the latest increment occured before the timeout set in the settings. Depending on these checks, Ramses will automatically associate a comment with the corresponding version to warn of any changes. The Mel and Python corresponding command is: ramSave . It can take two parameters: -set_comment or -sc : boolean used to set a comment associated to the current version file. -comment or -c : string is the comment to be associated if -sc is True . # Python import maya.cmds as cmds # Save the current file cmds.ramSave() # Save the file with a comment (show the comment dialog) cmds.ramSave(set_comment = True) # Save the file with a custom comment cmds.ramSave(sc = True, comment = \"A new comment!\") Comment The Comment command saves the current scene the same way as the Save command, and adds a comment associated with the current version. This comment is displayed with the corresponding version in all version selection dialogs, both in the add-on itself and in the Ramses Client Application , as shown below. A list of versions with a few comments, as shown in the Ramses Maya Add-on . A list of versions with a few comments, as shown in the Ramses Client Application . The Mel and Python corresponding command is: ramSave with its two parameters -sc and c . Read the Save section for details. # Python import maya.cmds as cmds # Save the file with a custom comment cmds.ramSave(sc = True, comment = \"A new comment!\") Incremental Save The Incremental Save runs the save command and forces it to increment to a new version. The Mel and Python corresponding command is: ramSaveVersion with the parameter updateStatus set to False . Read the Update Status section for details. # Python import maya.cmds as cmds # Incremental save cmds.ramSaveVersion( updateStatus=False ) Update Status and Publish The Update Status runs the Incremental Save command and updates the current production status of the current Asset or Shot. A dialog is shown with a few options to update the status, and to choose to also publish the scene, and create a preview for it. This dialog may differ depending on the use of the Ramses Client Application or not. This is the status dialog when connected to the Ramses Client Application . You can set the new State with the drop down list at the top left; the list of the states is retrieved from the Ramses Daemon . The slider and percentage is used to set a new Completion Ratio . The Comment field is used to update the comment displayed in the production tracking tools and tables of Ramses . All this information is automatically fed to the Ramses Daemon which updates the information for everyone. This is the status dialog when the Ramses Client Application isn't available. When not connected to the Daemon , there is still an option to set a State from a default limited list. Check the Publication button to publish the current scene. Check the Preview button to create a preview (thumbnail or playblast) for the current scene. Read the Preview section for more details. The Update Status and Save button updates the status, publishes the scene, and creates the preview, while the Skip and Just Save button just increments the version and saves. The Mel and Python corresponding command is: ramSaveVersion . It can take three parameters: -updateStatus or -us : boolean . When True (default), the status dialog is shown to let the user update the status. -publish or -p : boolean activates the publication of the scene. -preview or -pv : boolean activates the creation of a preview. # Python import maya.cmds as cmds # Shows the update status dialog cmds.ramSaveVersion() # Incremental save cmds.ramSaveVersion(updateStatus = False) # Publishes the file without showing the status dialog cmds.ramSaveVersion(publish = True, us = False) # Publishes and creates a preview without showing the status dialog cmds.ramSaveVersion(publish = True, preview = True, us = False) Publish The publication of the scene is done in several steps: If the Ramses Daemon is available, Ramses checks if there are publish settings available. If no settings were found, or if the user checked the box to edit the settings, a dialog window is shown to let the user adjust the publish settings. The Scene is saved in the _published subfolder. This is the folder from which the scene and published files can be imported or referenced into other Assets and Shots. One or several files are published, according to the settings. Ramses then calls any potential publish function registered by the pipeline tools or an extension of the Add-On. \u25b9 Read the publishing guide for Maya for more information about the Maya pipeline. Preview The Preview command allows you to quickly create either an image (thumbnail) or a video (playblast) preview of the current scene, automatically saved in the _preview subfolder. There are a few options to adjust how the image or video are rendered. Ramses auto-selects the first renderable camera in the scene. To always automatically use the right camera, either add it in the render settings (and remove any other unneeded camera), or check the renderable option in the Ouput Settings section of its attributes. The size is a percentage of the resolution of the render settings of the scene. You can then adjust all the render options; checking both Only Polygons and Show Motion Trails allows to hide all animation controllers (if they\u2019re curves as usual) but keep the motion trails. By default, Ramses overwrites any previous image or video for the current scene, except if you set a new comment when making the preview. Note that the Ramses Client Application uses the preview with an empty comment as a thumbnail to display the asset or the shot in the user interface. Ramses also automatically burns useful meta-data in the image, like the frame number, the focal length, the comment, etc. The Mel and Python corresponding command is: ramPreview . # Python import maya.cmds as cmds # Shows the preview dialog cmds.ramPreview() Playblasts When rendering the playblasts, Ramses does not only renders them as usual Maya playblasts: you don\u2019t need to install Quicktime on windows anymore to export videos. Ramses automatically renders the playblasts in a very lightweight MP4 video, crafted especially for reviewing animations, with an intra-frame encoding setting which enables frame by frame playblack on every video player, with great performance. Ramses will also automatically play the video as soon as it\u2019s encoded using ffplay , a very efficient and lightweight video player. It may seem complicated at first as it does not have any User Interface, but it is easily controlled with a few shortcuts: To scroll in the video, [Right Click] anywhere on the video and drag the mouse horizontally. The left border of the frame represents the beginning of the video, while the right border represents the end. You can go forwards and backwards with the [\u2190] and [\u2192] keys of your keyboard by a few frames. Use [\u2191] and [\u2193] to go to the start or the end of the video. Use [Space] to play and pause the video. Use [S] for frame-by-frame playing. Hit [Q] to quickly quit the player. Save As The Save As command can be used to create a new Asset or Shot, or save any other new file, while automatically naming and locating it. Ramses automatically selects the current Project . Select the type of item to save; either an Asset , a Shot or another general item. The list of Steps , Asset Groups and Items is automatically built either by asking the Ramses Daemon if the add-on is used with the Ramses Client Application or by looking into the folder structure, but it is possible to create a new one by just entering a new name. The Resource is used to differenciate several files for the same Asset or Shot. An empty Resource is considered the main and default working file for the item, but you can add any other file by just adding a small resource name. When selecting Other as type, the file will be saved in the main folder of the corresponding step. Read the section about the Ramses Tree for more information. The Mel and Python corresponding command is: ramSaveAs . # Python import maya.cmds as cmds # Shows the save as dialog cmds.ramSaveAs() Template Use the Template command to create a new template file to be used with a specific step. Use the Name to have several templates for the same step. Hint This command just creates the new template, but does not publish it. You still have to publish it using the Update Status command afterwards. Templates can then be used to create new scenes for specific Shots or Assets from the Ramses Client Application . Templates are also available with the Open / Import command of the add-on. The Mel and Python corresponding command is: ramPublishTemplate . # Python import maya.cmds as cmds # Shows the publish template dialog cmds.ramPublishTemplate() Setup scene The Setup scene command runs some checks on the current scene and makes sure everything works according to the current project. Ramses will automatically add the Ramses_Publish and Ramses_DelOnPublish sets if they\u2019re missing, and checks these values to optionally fix them: The frame rate (if the current scene is a Shot) The duration (if the current scene is a Shot) The rendering resolution The camera used in the render settings The name of the selected camera These checks are automatically run when the scene is saved. The Mel and Python corresponding command is: ramSetupScene . # Python import maya.cmds as cmds # Checks the scene settings and shows a dialog if something is wrong cmds.ramSetupScene() Open, Import, Replace The Open and Import command automatically finds available scenes from your projects. It is not needed to go down all the hierarchy to select a file to open; if you just select an item and a step, Ramses will automatically open or import the corresponding latest version of the main resource. It works the same way when importing items: you don\u2019t need to go all the way down to select the files you want to import; by selecting just the main file, Ramses will import everything available, or, if you\u2019re using an extension of the Add-on , it will pass all the files to the extension so it can automatically manage the import for you. When importing an item, Ramses will also trigger custom import scripts registered by the pipeline tools or an extension of the Maya Add-on . This is one way of automating your workflow, by just registering scripts to be called when publishing and importing items. The Mel and Python corresponding command is: ramOpen . It can take two parameters: import or -i : boolean. When True , the dialog is opened in import mode. replace or -r : boolean. When True , the dialog is opened in replace mode. # Python import maya.cmds as cmds # Shows the open dialog cmds.ramOpen() # Shows the import dialog cmds.ramOpen(i=true) # Shows the replace dialog cmds.ramOpen(r=true) Update Use the Update command to update (or downgrade) the assets included in the scene. For each asset, you can select which version to use in the scene and automatically replace it. The update command is able to update to a newer or downgrade to a previous version. The Mel and Python corresponding command is: ramUpdate . # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() Retrieve Version The Retrieve version command can be used to check and restore a previous version of the current scene. The Mel and Python corresponding command is: ramRetrieveVersion . # Python import maya.cmds as cmds # Shows the retrieve version dialog cmds.ramRetrieveVersion() Publish Settings \u25b9 Read the publishing guide for Maya for more information about the Maya pipeline. Settings Versionning The Auto-Increment option sets how many time can be spent before Ramses automatically increments the version of the file when saving. Use this option to be sure you can get back to an earlier version of your work even if you forget to increment the version. the Save hotkey option replaces the default \u201c Save Scene \u201d [Ctrl + S] hotkey from Maya by the Save command from Ramses . This is recommended to enable all production tracking features of Ramses and ensure an automatic backup of your work. Note that checking this box does not replace the File/Save menu entry so you can still use the default Maya Save command. the Save as hotkey option replaces the default \u201c Save Scene As \u201d [Ctrl + Shift + S] hotkey from Maya by the Save As command from Ramses . Note that checking this box does not replace the File/Save as... menu entry so you can still use the default Maya Save as command. the Open hotkey option replaces the default \u201c Open Scene\u2026 \u201d [Ctrl + O] hotkey from Maya by the Open command from Ramses . Note that checking this box does not replace the File/Open Scene... menu entry so you can still use the default Maya Open* command. Folders Set the main Ramses folder location . This is mandatory if you\u2019re using the add-on without the Ramses Client Application . Ramses Application Check the Connected box so that the Ramses Add-on will work with the Ramses Client Application for production tracking features. In order for this to work, you\u2019ll need to set the path to the Ramses.exe file inside the installation folder of the Ramses Client Application . The Ramses Daemon Port is the local networking port used by the Ramses Daemon to communicate with the add-ons. It must be the same value as the one set in the Ramses Client Application ; the default value is the birthdate of Karl Marx : 18185 (May, 5th 1818). Development Change the Log Level to adjust how many information is printed in the console to help you debug your scripts when you\u2019re developping using the Ramses Python API or if you\u2019re extending the add-on .","title":"Maya Add-on"},{"location":"components/addons/maya/#ramses-maya-add-on","text":"Ramses comes with an official add-on for Autodesk Maya , which actually consists in a Python plug-in and a custom shelf packaged in a simple single module. It is an example of an implementation of an add-on using the Ramses Python API but it is already well suited for use in production. As well as all other Ramses Add-ons , the Ramses Maya Add-on includes the main features like versionning, publishing and production tracking with Ramses , but it can be extended to automate your workflow . This Add-on can be used with or without being connected to the Ramses Daemon (and the Ramses Client Application ). If it is connected to the Daemon , it will automatically update the production tracking data.","title":"Ramses Maya Add-on"},{"location":"components/addons/maya/#installation","text":"Download and unzip the module. To quickly deploy the module on several workstations, choose a shared location; the module can then be shared with all workstations and updated at once. Edit Ramses.mod with a text editor, and replace the path in the first line with the absolute path where you\u2019ve unzipped the module. This is how the content of this file looks like: + Ramses 0.0.1-dev D:\\your\\path\\to\\the\\module PYTHONPATH+:=plug-ins MAYA_SHELF_PATH+:=shelves Do not change anything else in the file. In order to prevent unintended modifications to the Ramses shelf, you can set its read-only attribute: Right click on the shelves/shelf_Ramses.mel file and select Properties . Check the Read only box. Copy Ramses.mod in one of your modules paths e.g. C:\\Users\\User\\Documents\\Maya\\modules . You may need to create the modules folder if it does not exist yet. Repeat this operation on all workstations where you need the module. Restart Maya . Activate the Ramses plug-in from Maya \u2018s plug-in manager. You may need to restart Maya again so that the Ramses shelf is loaded.","title":"Installation"},{"location":"components/addons/maya/#features","text":"All features of the Ramses add-on are available through the new shelf. They are also registered as Mel and Python Maya commands. All these features are detailed in the next sections. To handle all file naming and sorting, Ramses includes commands to replace all the default Save , Save As and Open functions. Using (almost) only the Ramses commands ensures your files will always be correctly named and in the right location. It also helps Ramses track the production. Feature Maya Command Description Open the Ramses App ramOpenRamses Launches the Ramses Client Application (if its path is correctly set in the settings). Save ramSave Saves and backups the current scene; this save command is also used for production tracking. Comment ramSave Associates a comment wit the current scene file. Incremental Save ramSaveVersion Saves and increments the version of the current scene. Update Status / Publish ramSaveVersion Saves and increments the version of the current scene, while updating its current production tracking status. Optionally publishes the asset/shot. Create Preview ramPreview Creates a preview (thumbnail or playblast) of the current scene. Save as ramSaveAs Saves the scene as a new Asset, Shot or General item. Template ramPublishTemplate Saves the current scene as a new template for the current step. Setup scene ramSetupScene Setups the scene to make it Ramses-friendly. Open ramOpen Opens an Asset, Shot or Template. Import ramOpen Imports an Asset, Shot or Template. Replace ramOpen Replaces selected nodes with another Asset, Shot or Template. Update ramUpdate Updates assets and shots included in the scene. Retrieve Version ramRetrieveVersion Retrieves and restores a previous version of the current scene. Publish settings ramPublishSettings Sets the default publish settings for steps. Settings ramSettings Opens the settings dialog for the Ramses Add-on .","title":"Features"},{"location":"components/addons/maya/#save","text":"The Ramses Save command starts by saving the current scene, and then runs a few checks before backuping the file into the _versions subfolder: Naming Scheme : checks if the file is correctly named and located. If not, Ramses will run the Save as command instead to ensure the name is correct. Version : checks if the version has to be incremented. That\u2019s the case if the current scene is a restored previous version, or if the latest increment occured before the timeout set in the settings. Depending on these checks, Ramses will automatically associate a comment with the corresponding version to warn of any changes. The Mel and Python corresponding command is: ramSave . It can take two parameters: -set_comment or -sc : boolean used to set a comment associated to the current version file. -comment or -c : string is the comment to be associated if -sc is True . # Python import maya.cmds as cmds # Save the current file cmds.ramSave() # Save the file with a comment (show the comment dialog) cmds.ramSave(set_comment = True) # Save the file with a custom comment cmds.ramSave(sc = True, comment = \"A new comment!\")","title":"Save"},{"location":"components/addons/maya/#comment","text":"The Comment command saves the current scene the same way as the Save command, and adds a comment associated with the current version. This comment is displayed with the corresponding version in all version selection dialogs, both in the add-on itself and in the Ramses Client Application , as shown below. A list of versions with a few comments, as shown in the Ramses Maya Add-on . A list of versions with a few comments, as shown in the Ramses Client Application . The Mel and Python corresponding command is: ramSave with its two parameters -sc and c . Read the Save section for details. # Python import maya.cmds as cmds # Save the file with a custom comment cmds.ramSave(sc = True, comment = \"A new comment!\")","title":"Comment"},{"location":"components/addons/maya/#incremental-save","text":"The Incremental Save runs the save command and forces it to increment to a new version. The Mel and Python corresponding command is: ramSaveVersion with the parameter updateStatus set to False . Read the Update Status section for details. # Python import maya.cmds as cmds # Incremental save cmds.ramSaveVersion( updateStatus=False )","title":"Incremental Save"},{"location":"components/addons/maya/#update-status-and-publish","text":"The Update Status runs the Incremental Save command and updates the current production status of the current Asset or Shot. A dialog is shown with a few options to update the status, and to choose to also publish the scene, and create a preview for it. This dialog may differ depending on the use of the Ramses Client Application or not. This is the status dialog when connected to the Ramses Client Application . You can set the new State with the drop down list at the top left; the list of the states is retrieved from the Ramses Daemon . The slider and percentage is used to set a new Completion Ratio . The Comment field is used to update the comment displayed in the production tracking tools and tables of Ramses . All this information is automatically fed to the Ramses Daemon which updates the information for everyone. This is the status dialog when the Ramses Client Application isn't available. When not connected to the Daemon , there is still an option to set a State from a default limited list. Check the Publication button to publish the current scene. Check the Preview button to create a preview (thumbnail or playblast) for the current scene. Read the Preview section for more details. The Update Status and Save button updates the status, publishes the scene, and creates the preview, while the Skip and Just Save button just increments the version and saves. The Mel and Python corresponding command is: ramSaveVersion . It can take three parameters: -updateStatus or -us : boolean . When True (default), the status dialog is shown to let the user update the status. -publish or -p : boolean activates the publication of the scene. -preview or -pv : boolean activates the creation of a preview. # Python import maya.cmds as cmds # Shows the update status dialog cmds.ramSaveVersion() # Incremental save cmds.ramSaveVersion(updateStatus = False) # Publishes the file without showing the status dialog cmds.ramSaveVersion(publish = True, us = False) # Publishes and creates a preview without showing the status dialog cmds.ramSaveVersion(publish = True, preview = True, us = False)","title":"Update Status and Publish"},{"location":"components/addons/maya/#publish","text":"The publication of the scene is done in several steps: If the Ramses Daemon is available, Ramses checks if there are publish settings available. If no settings were found, or if the user checked the box to edit the settings, a dialog window is shown to let the user adjust the publish settings. The Scene is saved in the _published subfolder. This is the folder from which the scene and published files can be imported or referenced into other Assets and Shots. One or several files are published, according to the settings. Ramses then calls any potential publish function registered by the pipeline tools or an extension of the Add-On. \u25b9 Read the publishing guide for Maya for more information about the Maya pipeline.","title":"Publish"},{"location":"components/addons/maya/#preview","text":"The Preview command allows you to quickly create either an image (thumbnail) or a video (playblast) preview of the current scene, automatically saved in the _preview subfolder. There are a few options to adjust how the image or video are rendered. Ramses auto-selects the first renderable camera in the scene. To always automatically use the right camera, either add it in the render settings (and remove any other unneeded camera), or check the renderable option in the Ouput Settings section of its attributes. The size is a percentage of the resolution of the render settings of the scene. You can then adjust all the render options; checking both Only Polygons and Show Motion Trails allows to hide all animation controllers (if they\u2019re curves as usual) but keep the motion trails. By default, Ramses overwrites any previous image or video for the current scene, except if you set a new comment when making the preview. Note that the Ramses Client Application uses the preview with an empty comment as a thumbnail to display the asset or the shot in the user interface. Ramses also automatically burns useful meta-data in the image, like the frame number, the focal length, the comment, etc. The Mel and Python corresponding command is: ramPreview . # Python import maya.cmds as cmds # Shows the preview dialog cmds.ramPreview()","title":"Preview"},{"location":"components/addons/maya/#playblasts","text":"When rendering the playblasts, Ramses does not only renders them as usual Maya playblasts: you don\u2019t need to install Quicktime on windows anymore to export videos. Ramses automatically renders the playblasts in a very lightweight MP4 video, crafted especially for reviewing animations, with an intra-frame encoding setting which enables frame by frame playblack on every video player, with great performance. Ramses will also automatically play the video as soon as it\u2019s encoded using ffplay , a very efficient and lightweight video player. It may seem complicated at first as it does not have any User Interface, but it is easily controlled with a few shortcuts: To scroll in the video, [Right Click] anywhere on the video and drag the mouse horizontally. The left border of the frame represents the beginning of the video, while the right border represents the end. You can go forwards and backwards with the [\u2190] and [\u2192] keys of your keyboard by a few frames. Use [\u2191] and [\u2193] to go to the start or the end of the video. Use [Space] to play and pause the video. Use [S] for frame-by-frame playing. Hit [Q] to quickly quit the player.","title":"Playblasts"},{"location":"components/addons/maya/#save-as","text":"The Save As command can be used to create a new Asset or Shot, or save any other new file, while automatically naming and locating it. Ramses automatically selects the current Project . Select the type of item to save; either an Asset , a Shot or another general item. The list of Steps , Asset Groups and Items is automatically built either by asking the Ramses Daemon if the add-on is used with the Ramses Client Application or by looking into the folder structure, but it is possible to create a new one by just entering a new name. The Resource is used to differenciate several files for the same Asset or Shot. An empty Resource is considered the main and default working file for the item, but you can add any other file by just adding a small resource name. When selecting Other as type, the file will be saved in the main folder of the corresponding step. Read the section about the Ramses Tree for more information. The Mel and Python corresponding command is: ramSaveAs . # Python import maya.cmds as cmds # Shows the save as dialog cmds.ramSaveAs()","title":"Save As"},{"location":"components/addons/maya/#template","text":"Use the Template command to create a new template file to be used with a specific step. Use the Name to have several templates for the same step. Hint This command just creates the new template, but does not publish it. You still have to publish it using the Update Status command afterwards. Templates can then be used to create new scenes for specific Shots or Assets from the Ramses Client Application . Templates are also available with the Open / Import command of the add-on. The Mel and Python corresponding command is: ramPublishTemplate . # Python import maya.cmds as cmds # Shows the publish template dialog cmds.ramPublishTemplate()","title":"Template"},{"location":"components/addons/maya/#setup-scene","text":"The Setup scene command runs some checks on the current scene and makes sure everything works according to the current project. Ramses will automatically add the Ramses_Publish and Ramses_DelOnPublish sets if they\u2019re missing, and checks these values to optionally fix them: The frame rate (if the current scene is a Shot) The duration (if the current scene is a Shot) The rendering resolution The camera used in the render settings The name of the selected camera These checks are automatically run when the scene is saved. The Mel and Python corresponding command is: ramSetupScene . # Python import maya.cmds as cmds # Checks the scene settings and shows a dialog if something is wrong cmds.ramSetupScene()","title":"Setup scene"},{"location":"components/addons/maya/#open-import-replace","text":"The Open and Import command automatically finds available scenes from your projects. It is not needed to go down all the hierarchy to select a file to open; if you just select an item and a step, Ramses will automatically open or import the corresponding latest version of the main resource. It works the same way when importing items: you don\u2019t need to go all the way down to select the files you want to import; by selecting just the main file, Ramses will import everything available, or, if you\u2019re using an extension of the Add-on , it will pass all the files to the extension so it can automatically manage the import for you. When importing an item, Ramses will also trigger custom import scripts registered by the pipeline tools or an extension of the Maya Add-on . This is one way of automating your workflow, by just registering scripts to be called when publishing and importing items. The Mel and Python corresponding command is: ramOpen . It can take two parameters: import or -i : boolean. When True , the dialog is opened in import mode. replace or -r : boolean. When True , the dialog is opened in replace mode. # Python import maya.cmds as cmds # Shows the open dialog cmds.ramOpen() # Shows the import dialog cmds.ramOpen(i=true) # Shows the replace dialog cmds.ramOpen(r=true)","title":"Open,  Import,  Replace"},{"location":"components/addons/maya/#update","text":"Use the Update command to update (or downgrade) the assets included in the scene. For each asset, you can select which version to use in the scene and automatically replace it. The update command is able to update to a newer or downgrade to a previous version. The Mel and Python corresponding command is: ramUpdate . # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate()","title":"Update"},{"location":"components/addons/maya/#retrieve-version","text":"The Retrieve version command can be used to check and restore a previous version of the current scene. The Mel and Python corresponding command is: ramRetrieveVersion . # Python import maya.cmds as cmds # Shows the retrieve version dialog cmds.ramRetrieveVersion()","title":"Retrieve Version"},{"location":"components/addons/maya/#publish-settings","text":"\u25b9 Read the publishing guide for Maya for more information about the Maya pipeline.","title":"Publish Settings"},{"location":"components/addons/maya/#settings","text":"","title":"Settings"},{"location":"components/addons/maya/#versionning","text":"The Auto-Increment option sets how many time can be spent before Ramses automatically increments the version of the file when saving. Use this option to be sure you can get back to an earlier version of your work even if you forget to increment the version. the Save hotkey option replaces the default \u201c Save Scene \u201d [Ctrl + S] hotkey from Maya by the Save command from Ramses . This is recommended to enable all production tracking features of Ramses and ensure an automatic backup of your work. Note that checking this box does not replace the File/Save menu entry so you can still use the default Maya Save command. the Save as hotkey option replaces the default \u201c Save Scene As \u201d [Ctrl + Shift + S] hotkey from Maya by the Save As command from Ramses . Note that checking this box does not replace the File/Save as... menu entry so you can still use the default Maya Save as command. the Open hotkey option replaces the default \u201c Open Scene\u2026 \u201d [Ctrl + O] hotkey from Maya by the Open command from Ramses . Note that checking this box does not replace the File/Open Scene... menu entry so you can still use the default Maya Open* command.","title":"Versionning"},{"location":"components/addons/maya/#folders","text":"Set the main Ramses folder location . This is mandatory if you\u2019re using the add-on without the Ramses Client Application .","title":"Folders"},{"location":"components/addons/maya/#ramses-application","text":"Check the Connected box so that the Ramses Add-on will work with the Ramses Client Application for production tracking features. In order for this to work, you\u2019ll need to set the path to the Ramses.exe file inside the installation folder of the Ramses Client Application . The Ramses Daemon Port is the local networking port used by the Ramses Daemon to communicate with the add-ons. It must be the same value as the one set in the Ramses Client Application ; the default value is the birthdate of Karl Marx : 18185 (May, 5th 1818).","title":"Ramses Application"},{"location":"components/addons/maya/#development","text":"Change the Log Level to adjust how many information is printed in the console to help you debug your scripts when you\u2019re developping using the Ramses Python API or if you\u2019re extending the add-on .","title":"Development"},{"location":"components/client/","text":"Ramses Client Application The Ramses Client Application is the heart of the Ramses framework - which has actually many hearts, one per workstation. It is the application which gets and displays data from all other components , the Ramses Add-ons , the Ramses Server and the Ramses Tree It is especially in charge of global administration , project administration , pipeline creation , production tracking and planning . \u25b9 Installation . \u25b9 Settings and overview . \u25b9 Administration . \u25b9 Project administration . \u25b9 Pipeline creation . \u25b9 Production tracking . \u25b9 Planning and schedule .","title":"Introduction"},{"location":"components/client/#ramses-client-application","text":"The Ramses Client Application is the heart of the Ramses framework - which has actually many hearts, one per workstation. It is the application which gets and displays data from all other components , the Ramses Add-ons , the Ramses Server and the Ramses Tree It is especially in charge of global administration , project administration , pipeline creation , production tracking and planning . \u25b9 Installation . \u25b9 Settings and overview . \u25b9 Administration . \u25b9 Project administration . \u25b9 Pipeline creation . \u25b9 Production tracking . \u25b9 Planning and schedule .","title":"Ramses Client Application"},{"location":"components/client/admin/","text":"Administration panel The adminstration panel is accessible only to Administrator users . This is where the global settings of the Ramses framework can be adjusted, and where re-usable elements across all projects (templates, states, applications\u2026) can be managed. \u25b9 User management . \u25b9 Project management . \u25b9 Template step management . \u25b9 Template asset group management . \u25b9 State management . \u25b9 File type management . \u25b9 Application management .","title":"Introduction"},{"location":"components/client/admin/#administration-panel","text":"The adminstration panel is accessible only to Administrator users . This is where the global settings of the Ramses framework can be adjusted, and where re-usable elements across all projects (templates, states, applications\u2026) can be managed. \u25b9 User management . \u25b9 Project management . \u25b9 Template step management . \u25b9 Template asset group management . \u25b9 State management . \u25b9 File type management . \u25b9 Application management .","title":"Administration panel"},{"location":"components/client/applications/","text":"Application management This panel is used to list and manage all the applications Ramses needs to know for the pipeline management. Read the section about the Pipeline for more details about how applications are used. List The list on the left lists all the applications, and you can use the Search field to filter them by name or ID . Use the button to create a new application. The button removes the selected applications from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new applications. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected applications. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Ramses comes with a predefined list of applications, but this list is completely customizable: you can remove and add as many applications as you need. Edition Name is the state\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the application, describing it. Executable file is the path to the executable binary used to launch the application. The blue button opens a file selector to change the file path. The Native , Import and Export buttons display three lists of file types to be associated with the application: Native file types are the ones which can be edited (read and written while keeping them editable) with the application. Import file types are files which can be read by the application. Export file types are files which can be written by the application, but losing the ability to edit it later. The button contains a list of available file types, and an entry to quickly create a new file type without having to switch to the file types tab. The button unassigns the selected file types from the application but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the edit button to edit them in a side docked panel. Read the file type management section for more details about file type edition. Tip The executable file field is optional. To open a specific file, if this field is left empty, Ramses will use the default application from the system instead, so it may be quicker and easier to set the file association at the system level. Using this field can be handy in case you\u2019re using different versions of the same software, or if you want to override default file association, in which case Ramses needs the actual executable file path. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Applications"},{"location":"components/client/applications/#application-management","text":"This panel is used to list and manage all the applications Ramses needs to know for the pipeline management. Read the section about the Pipeline for more details about how applications are used.","title":"Application management"},{"location":"components/client/applications/#list","text":"The list on the left lists all the applications, and you can use the Search field to filter them by name or ID . Use the button to create a new application. The button removes the selected applications from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new applications. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected applications. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Ramses comes with a predefined list of applications, but this list is completely customizable: you can remove and add as many applications as you need.","title":"List"},{"location":"components/client/applications/#edition","text":"Name is the state\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the application, describing it. Executable file is the path to the executable binary used to launch the application. The blue button opens a file selector to change the file path. The Native , Import and Export buttons display three lists of file types to be associated with the application: Native file types are the ones which can be edited (read and written while keeping them editable) with the application. Import file types are files which can be read by the application. Export file types are files which can be written by the application, but losing the ability to edit it later. The button contains a list of available file types, and an entry to quickly create a new file type without having to switch to the file types tab. The button unassigns the selected file types from the application but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the edit button to edit them in a side docked panel. Read the file type management section for more details about file type edition. Tip The executable file field is optional. To open a specific file, if this field is left empty, Ramses will use the default application from the system instead, so it may be quicker and easier to set the file association at the system level. Using this field can be handy in case you\u2019re using different versions of the same software, or if you want to override default file association, in which case Ramses needs the actual executable file path. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/assetgroups/","text":"Asset group settings This panel is used to list and manage all the asset groups of the project. Asset groups are used to help you sort and filter the assets of the project . They\u2019re also used in the Ramses Tree . List The list on the left lists all the asset groups of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each asset group can be displayed. The folder button on the top right corner for each asset group in the list opens the asset group folder in your file explorer. Use the button to create a new asset group (either from scratch or using a template). The button removes the selected asset groups from the project 1 . You can use the [Shift + A] shortcut key to quickly add new asset groups. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected asset groups. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Name is the asset group\u2019s display name. It can\u2019t be changed after the asset group folder has been created . ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the asset group and describing it. The button opens the asset group folder in your file explorer. This folder contains the individual asset folders. Assets contained in the group are listed in the bottom section. The button instantly creates a new asset contained in the current group. The button removes the selected assets from the project 1 . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific asset folder, and the edit button to edit them in a side docked panel. Read the asset settings section for more details about asset edition. Tip To change the name of the asset group, you can temporarilly rename its corresponding folder, change the name in Ramses , and finally rename the folder after the new name. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9","title":"Asset Groups"},{"location":"components/client/assetgroups/#asset-group-settings","text":"This panel is used to list and manage all the asset groups of the project. Asset groups are used to help you sort and filter the assets of the project . They\u2019re also used in the Ramses Tree .","title":"Asset group settings"},{"location":"components/client/assetgroups/#list","text":"The list on the left lists all the asset groups of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each asset group can be displayed. The folder button on the top right corner for each asset group in the list opens the asset group folder in your file explorer. Use the button to create a new asset group (either from scratch or using a template). The button removes the selected asset groups from the project 1 . You can use the [Shift + A] shortcut key to quickly add new asset groups. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected asset groups. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/assetgroups/#edition","text":"Name is the asset group\u2019s display name. It can\u2019t be changed after the asset group folder has been created . ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the asset group and describing it. The button opens the asset group folder in your file explorer. This folder contains the individual asset folders. Assets contained in the group are listed in the bottom section. The button instantly creates a new asset contained in the current group. The button removes the selected assets from the project 1 . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific asset folder, and the edit button to edit them in a side docked panel. Read the asset settings section for more details about asset edition. Tip To change the name of the asset group, you can temporarilly rename its corresponding folder, change the name in Ramses , and finally rename the folder after the new name. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9","title":"Edition"},{"location":"components/client/assets/","text":"Asset settings This panel is used to list and manage all the assets of the project . There is no production tracking from this panel, as it is used only to edit asset settings. List The list on the left lists all the assets of the project, and you can use the Search field to filter them by name or ID . The top selector filters the assets according to their containing group . When changing the size of the rows in the list, more details about each asset can be displayed. The folder button on the top right corner for each asset in the list opens the asset folder in your file explorer. Use the button to create a new asset in the current group. The button removes the selected asset from the project 1 . You can use the [Shift + A] shortcut key to quickly add new assets. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected assets. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Name is the asset\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the asset folder has been created . Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the asset and describing it. Tags can be used later to search for specific assets. It is a comma separated list of any text. You can change the Asset group which contains this asset. The button opens the asset folder in your file explorer. This folder contains the individual working files, each in its step subfolder. For more details, read the Ramses Tree section. Hint In the current version of Ramses , when changing the asset group, the asset folder won\u2019t be automatically moved. This may change in a future version. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Assets"},{"location":"components/client/assets/#asset-settings","text":"This panel is used to list and manage all the assets of the project . There is no production tracking from this panel, as it is used only to edit asset settings.","title":"Asset settings"},{"location":"components/client/assets/#list","text":"The list on the left lists all the assets of the project, and you can use the Search field to filter them by name or ID . The top selector filters the assets according to their containing group . When changing the size of the rows in the list, more details about each asset can be displayed. The folder button on the top right corner for each asset in the list opens the asset folder in your file explorer. Use the button to create a new asset in the current group. The button removes the selected asset from the project 1 . You can use the [Shift + A] shortcut key to quickly add new assets. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected assets. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/assets/#edition","text":"Name is the asset\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the asset folder has been created . Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the asset and describing it. Tags can be used later to search for specific assets. It is a comma separated list of any text. You can change the Asset group which contains this asset. The button opens the asset folder in your file explorer. This folder contains the individual working files, each in its step subfolder. For more details, read the Ramses Tree section. Hint In the current version of Ramses , when changing the asset group, the asset folder won\u2019t be automatically moved. This may change in a future version. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/filetypes/","text":"File type management This panel is used to list and manage all the file types Ramses needs to know for the pipeline management. Read the section about the Pipeline for more details about how file types are used. List The list on the left lists all the file types, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each file type can be displayed. The file types are sorted by main extension. Use the button to create a new file type. The button removes the selected file types from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new file types. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected file types. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Ramses comes with a predefined list of file types, but this list is completely customizable: you can remove and add as many types as you need. Edition Name is the file type\u2019s display name. Main extension is the extension used by default for the file type. You must not include the leading dot . . Comment can be any text associated to the file type, describing it. All extensions is a comma separated list of all the extensions this file can use. You don\u2019t need to include the leading dot. The main extension must be repeated in this field . Previewable can be checked to let Ramses know that the file can be used for previews (it is lightweight and can be displayed by standard players/image viewers). Note A file can have multiple extensions, like JPEG for example which can use jpg , jpeg , or jpe . When it has multiple extensions, this means a specific file can be renamed to change the extension and it will still work exactly the same way. On the contrary, even if two files can be opened with the same software they may not be the same type with different extensions; for example, both .ma and .mb files are Maya files, but they\u2019re two different types anyway; renaming an ma file to mb will break it. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"File Types"},{"location":"components/client/filetypes/#file-type-management","text":"This panel is used to list and manage all the file types Ramses needs to know for the pipeline management. Read the section about the Pipeline for more details about how file types are used.","title":"File type management"},{"location":"components/client/filetypes/#list","text":"The list on the left lists all the file types, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each file type can be displayed. The file types are sorted by main extension. Use the button to create a new file type. The button removes the selected file types from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new file types. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected file types. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Ramses comes with a predefined list of file types, but this list is completely customizable: you can remove and add as many types as you need.","title":"List"},{"location":"components/client/filetypes/#edition","text":"Name is the file type\u2019s display name. Main extension is the extension used by default for the file type. You must not include the leading dot . . Comment can be any text associated to the file type, describing it. All extensions is a comma separated list of all the extensions this file can use. You don\u2019t need to include the leading dot. The main extension must be repeated in this field . Previewable can be checked to let Ramses know that the file can be used for previews (it is lightweight and can be displayed by standard players/image viewers). Note A file can have multiple extensions, like JPEG for example which can use jpg , jpeg , or jpe . When it has multiple extensions, this means a specific file can be renamed to change the extension and it will still work exactly the same way. On the contrary, even if two files can be opened with the same software they may not be the same type with different extensions; for example, both .ma and .mb files are Maya files, but they\u2019re two different types anyway; renaming an ma file to mb will break it. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/install/","text":"Application installation The method to install Ramses depends on your operating system; no matter what, it is installed as any other standard application. As soon as the application is installed and running, go to the settings to configure it. Linux On Debian -based distributions , like Ubuntu for example, the easiest way to install the Ramses Client Application is to download and install the .deb package, which will also install all dependencies, using your usual package manager / installer. Tip The quickest way to install a deb package is using a terminal: sudo apt-get install ./ramses-client_x.x.x.deb . For other distributions or if you have any issues with the .deb package, you can just download and run the .appImage package. Warning When using the .appImage package, openSSL will not be automatically installed; if you need a secure connexion to the server you will have to install it with your usual package manager. Windows There\u2019s no installer for Windows (yet). To install Ramses , you can just unzip the files in a folder of your choice. If you want Ramses to start with the system, you can just copy a shortcut to Ramses.exe in the startup folder. You can access this startup folder with the shortcut [Win] + [R] and typing shell:startup . Mac OS Ramses is available as a .dmg file. Just open the archive, and drop the Ramses app in your Applications folder (or anywhere else).","title":"Installation"},{"location":"components/client/install/#application-installation","text":"The method to install Ramses depends on your operating system; no matter what, it is installed as any other standard application. As soon as the application is installed and running, go to the settings to configure it.","title":"Application installation"},{"location":"components/client/install/#linux","text":"On Debian -based distributions , like Ubuntu for example, the easiest way to install the Ramses Client Application is to download and install the .deb package, which will also install all dependencies, using your usual package manager / installer. Tip The quickest way to install a deb package is using a terminal: sudo apt-get install ./ramses-client_x.x.x.deb . For other distributions or if you have any issues with the .deb package, you can just download and run the .appImage package. Warning When using the .appImage package, openSSL will not be automatically installed; if you need a secure connexion to the server you will have to install it with your usual package manager.","title":"Linux"},{"location":"components/client/install/#windows","text":"There\u2019s no installer for Windows (yet). To install Ramses , you can just unzip the files in a folder of your choice. If you want Ramses to start with the system, you can just copy a shortcut to Ramses.exe in the startup folder. You can access this startup folder with the shortcut [Win] + [R] and typing shell:startup .","title":"Windows"},{"location":"components/client/install/#mac-os","text":"Ramses is available as a .dmg file. Just open the archive, and drop the Ramses app in your Applications folder (or anywhere else).","title":"Mac OS"},{"location":"components/client/pipeline/","text":"Pipeline editor The pipeline panel is accessible only to Administrator and Project administrator users . This is where the project pipeline can be created and edited. \u25b9 More details about the pipeline . Overview The pipeline editor has three main areas: the toolbar on top contains a few useful menus and tools, the nodal view is where steps and pipes are connected, and the dock shows the editors (on the right side of the nocal view by default). All docked panels can be undocked (as shown on the picture below) or docked on the other side of the nodal view, by dragging their title bar at the top of the panel. Toolbar On its left side, the toolbar displays a few menus. View Center view resets the zoom of the nodal view to 100% and centers it. Shortcut: [Home] Center selection centers the selected nodes and zooms in on them. Shortcuts: [F] or [.] on the numpad. Select Select all steps selects all the steps in the nodal view. Shortcut: [A] Select children steps selects all the steps following the currently selected one(s). Repeat the command to expand the selection on the child side. Shortcut: [Ctrl + A] Select parent steps selects all the steps preceding the currently selected one(s). Repeat the command to expand the selection on the parent side. Shortcut: [Alt + A] Layout Layout all steps automatically arranges all the nodes using a smart (or not) algorithm to (try to) make the layout clearer. Shortcut: [Shift + L] Layout selected steps will use the same smart (or not) algorithm to (try to) make the layout clearer for the selected nodes. Shortcut: [Alt + L] Reload project layout will load the default layout for this project. Shorcut: [Shift + R] Save project layout saves (overwrite) the default layout for this project. Shorcut: [Shift + S] Step Create new step creates a new step from scratch in the project, and opens a side docked editor to edit its details. Shortcut: [Shift + A] The list of Template steps can be used to quickly create a new step from an template. Remove selected steps removes the selected steps from the project 1 . Shortcut: [Shift + X] Delete selection removes everything selected (steps and pipes) from the project 1 . Shortcut: [Del] Pipe Remove selected pipes removes the selected pipes from the project 1 , disconnected corresponding steps. Shortcut: [Alt + X] On its right side, the toolbar has a few settings available. Center view , Shortcut: [Home] Center selection , Shortcuts: [F] or [.] on the numpad Zoom changes the zoom of the nodal view. Minimum zoom is 25%. The Grid size is used when snapping nodes and defines the snap precision. It is displayed as small crosses in the nodal view when it has focus. Snap to grid will snap the nodes to the grid when moving them, allowing you to perfectly align them, you maniac. Node view In the node view, you can move around all the nodes (steps) by just clicking and dragging them. To select multiple nodes, just click on the background and drag the mouse to use a box selection. You can select both nodes (steps) and connections (pipes); when a node or a pipe is selected, its corresponding editor is shown in the right dock area to let you edit its details. To manipulate the view, use the following shortcuts: [middle click] to pan . [Ctrl + middle click] to zoom . When opening a project from the first time, the nodes may be stacked all together, and you\u2019ll have to sort the spaghettis. To do this quickly, start by using the automatic layout! Select Layout \u25b8 Layout all steps or use the [Shift + L] shortcut. Pipeline edition To create and edit your pipeline, you just have to follow these simple steps: Create new steps , either from a template using the Step menu or from scratch ( [Shift + A] ). When a step is created, it is automatically selected and its editor panel is docked on the right area. Read the project step settings documentation for details about the settings in the step editor. You can also edit the applications (and their file types ) assigned to the steps with the edit button. Connect the steps together: click on the green dot on the right of a step and drag to the blue dot on the left of another step to connect them. The connections goes from left to right (the step on the right is the child). Select the connection (the pipe) to edit it. In the pipe editor, you can check the steps from and to which the connections goes. The Files list contains the file types this pipe can accept. The button contains a list of available types you can assign to the pipe, and an entry to quickly create a pipe type without having to switch to the project pipe types settings panel. The button unassigns the selected pipe types from the pipe but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the edit button to edit them in another side docked panel. Read the project pipe types settings section for more details about pipe types edition. This list is what is passed to the Ramses Add-Ons when they\u2019re exporting or importing items to and from the connected steps to let them know which kind of data and files they need to use. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9 \u21a9","title":"Pipeline editor"},{"location":"components/client/pipeline/#pipeline-editor","text":"The pipeline panel is accessible only to Administrator and Project administrator users . This is where the project pipeline can be created and edited. \u25b9 More details about the pipeline .","title":"Pipeline editor"},{"location":"components/client/pipeline/#overview","text":"The pipeline editor has three main areas: the toolbar on top contains a few useful menus and tools, the nodal view is where steps and pipes are connected, and the dock shows the editors (on the right side of the nocal view by default). All docked panels can be undocked (as shown on the picture below) or docked on the other side of the nodal view, by dragging their title bar at the top of the panel.","title":"Overview"},{"location":"components/client/pipeline/#toolbar","text":"On its left side, the toolbar displays a few menus. View Center view resets the zoom of the nodal view to 100% and centers it. Shortcut: [Home] Center selection centers the selected nodes and zooms in on them. Shortcuts: [F] or [.] on the numpad. Select Select all steps selects all the steps in the nodal view. Shortcut: [A] Select children steps selects all the steps following the currently selected one(s). Repeat the command to expand the selection on the child side. Shortcut: [Ctrl + A] Select parent steps selects all the steps preceding the currently selected one(s). Repeat the command to expand the selection on the parent side. Shortcut: [Alt + A] Layout Layout all steps automatically arranges all the nodes using a smart (or not) algorithm to (try to) make the layout clearer. Shortcut: [Shift + L] Layout selected steps will use the same smart (or not) algorithm to (try to) make the layout clearer for the selected nodes. Shortcut: [Alt + L] Reload project layout will load the default layout for this project. Shorcut: [Shift + R] Save project layout saves (overwrite) the default layout for this project. Shorcut: [Shift + S] Step Create new step creates a new step from scratch in the project, and opens a side docked editor to edit its details. Shortcut: [Shift + A] The list of Template steps can be used to quickly create a new step from an template. Remove selected steps removes the selected steps from the project 1 . Shortcut: [Shift + X] Delete selection removes everything selected (steps and pipes) from the project 1 . Shortcut: [Del] Pipe Remove selected pipes removes the selected pipes from the project 1 , disconnected corresponding steps. Shortcut: [Alt + X] On its right side, the toolbar has a few settings available. Center view , Shortcut: [Home] Center selection , Shortcuts: [F] or [.] on the numpad Zoom changes the zoom of the nodal view. Minimum zoom is 25%. The Grid size is used when snapping nodes and defines the snap precision. It is displayed as small crosses in the nodal view when it has focus. Snap to grid will snap the nodes to the grid when moving them, allowing you to perfectly align them, you maniac.","title":"Toolbar"},{"location":"components/client/pipeline/#node-view","text":"In the node view, you can move around all the nodes (steps) by just clicking and dragging them. To select multiple nodes, just click on the background and drag the mouse to use a box selection. You can select both nodes (steps) and connections (pipes); when a node or a pipe is selected, its corresponding editor is shown in the right dock area to let you edit its details. To manipulate the view, use the following shortcuts: [middle click] to pan . [Ctrl + middle click] to zoom . When opening a project from the first time, the nodes may be stacked all together, and you\u2019ll have to sort the spaghettis. To do this quickly, start by using the automatic layout! Select Layout \u25b8 Layout all steps or use the [Shift + L] shortcut.","title":"Node view"},{"location":"components/client/pipeline/#pipeline-edition","text":"To create and edit your pipeline, you just have to follow these simple steps: Create new steps , either from a template using the Step menu or from scratch ( [Shift + A] ). When a step is created, it is automatically selected and its editor panel is docked on the right area. Read the project step settings documentation for details about the settings in the step editor. You can also edit the applications (and their file types ) assigned to the steps with the edit button. Connect the steps together: click on the green dot on the right of a step and drag to the blue dot on the left of another step to connect them. The connections goes from left to right (the step on the right is the child). Select the connection (the pipe) to edit it. In the pipe editor, you can check the steps from and to which the connections goes. The Files list contains the file types this pipe can accept. The button contains a list of available types you can assign to the pipe, and an entry to quickly create a pipe type without having to switch to the project pipe types settings panel. The button unassigns the selected pipe types from the pipe but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the edit button to edit them in another side docked panel. Read the project pipe types settings section for more details about pipe types edition. This list is what is passed to the Ramses Add-Ons when they\u2019re exporting or importing items to and from the connected steps to let them know which kind of data and files they need to use. \u25b9 More details about the pipeline . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9 \u21a9","title":"Pipeline edition"},{"location":"components/client/pipetypes/","text":"Pipe settings This panel is used to list and manage all the different types of pipes of the project which are used by the pipeline . Pipes can also be more easily created, edited and connected from the pipeline editor . Pipe types define the type of files and data which can be used through the pipes between steps . \u25b9 More details about the pipeline . Edition ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It\u2019s this ID which is passed to the Ramses Add-ons to let them know what they need to export or import, along with the other information from the pipe. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the pipe and describing it. Use the Type list to set the type of the step. Read this for more information about step types. You can select one File type to be used through this pipe; if you need several different types, you can use multiple pipes between steps. Read the Pipeline Editor section for more information. You can select one Color space to be used through this pipe; if you need several different color spaces, you can use multiple pipes between steps. Read the Pipeline Editor section for more information. Use the Custom Settings to set default settings to be used by Ramses Add-ons to automate the pipeline. These settings will be read when importing this specific file type, if it is assigned to a incoming pipe of the corresponding steps. Using the official Ramses Add-ons , these settings should be formatted using the Yaml syntax. Read the Add-ons section for more information about the settings you can use. \u25b9 More details about the pipeline . Warning Color spaces are not implemented yet! The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Pipe Types"},{"location":"components/client/pipetypes/#pipe-settings","text":"This panel is used to list and manage all the different types of pipes of the project which are used by the pipeline . Pipes can also be more easily created, edited and connected from the pipeline editor . Pipe types define the type of files and data which can be used through the pipes between steps . \u25b9 More details about the pipeline .","title":"Pipe settings"},{"location":"components/client/pipetypes/#edition","text":"ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It\u2019s this ID which is passed to the Ramses Add-ons to let them know what they need to export or import, along with the other information from the pipe. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the pipe and describing it. Use the Type list to set the type of the step. Read this for more information about step types. You can select one File type to be used through this pipe; if you need several different types, you can use multiple pipes between steps. Read the Pipeline Editor section for more information. You can select one Color space to be used through this pipe; if you need several different color spaces, you can use multiple pipes between steps. Read the Pipeline Editor section for more information. Use the Custom Settings to set default settings to be used by Ramses Add-ons to automate the pipeline. These settings will be read when importing this specific file type, if it is assigned to a incoming pipe of the corresponding steps. Using the official Ramses Add-ons , these settings should be formatted using the Yaml syntax. Read the Add-ons section for more information about the settings you can use. \u25b9 More details about the pipeline . Warning Color spaces are not implemented yet! The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/production/","text":"Asset and shot production tracking There are two panels to track the production of the shots and of the assets . From these tables, you can manage the status of all the assets and all the shots of the project, check their completion ratio , how much time was spent for each of them, check the estimation , and finally how late (or not) you are \u2026 \u25b9 More details about production tracking . Overview The production tables have three main areas: the toolbar on top contains a few useful menus and tools, the main table is where shots or assets are listed, and the dock shows the editors (on the right side of the main table by default). Toolbar On its left side, the toolbar displays a few menus and tools. The first button is a selector to let you filter the displayed asset by asset group, or the shots by sequence. Use the Search field to filter the shots or assets according to their names or IDS . View Show details : when checked, the default height of the cells is adjusted to show all details and information. Sort Use the sort menu to sort the rows either by: ID, name, difficulty, time spent, estimation or completion ratio. Steps Select all shows all the steps in the table. Select none hides all the steps from the table. Select my steps shows only the steps where the current user has some tasks assigned. Use the list of steps to select the ones you want to be shown in the main table. Status Assign User assigns a user to all selected tasks. Change state changes the state of all selected tasks. Changer difficulty changes the difficulty of all selected tasks. Set completion changes the completion ratio of all selected tasks. If the current user is at least a project adminstrator , the toolbar also displays an entry to let you quickly create new items (shots or assets) or remove selected items. Hint To sort rows, click on the sort button on the top left part of the column you want to use for sorting. Tip The Status menu is also availabe as a context menu with the [right click] . Main table From the main table, you can have a look at all the status of all shots or assets, and a summary for steps on the column headers. You can use the [Middle Click] to quickly scroll/pan in the table. The progress bar in the step headers goes from red to green when the completion ratio raises. The first column contains all the information about the shots or the assets (duration, tags, etc.). For all cells, you can open the corresponding folder with the folder button, and if you have enough rights you can click the corresponding cell to edit the details on the side panel. 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). The title of the cell shows the ID of the asset or shot, of the step, and of the current state. The current version of the working file is shown in parenthesis. The button shows the status history of the task. The progress bar can show multiple information. Its color corresponds to the current state color . It shows the completion ratio. Click on any cell to edit its details in a side panel: Use the colored state box on the top left to change the current state. Use the completion slider on the top right to change completion ratio. Just click the slider without dragging to precisely edit the value. You can add a comment just below the completion ratio. Changing the difficulty will change the automatic estimation, according to the settings of the corresponding step . Uncheck the Auto checkbox to manually estimate the time you need to finish the task. Once unchecked, the estimation will not be automatically changed anymore if you change the difficulty or if the step settings change. The time spent is automatically updated by Ramses when you edit the status, according to the information it gets from the Ramses Add-ons and the data it gathers from the files if they\u2019re correctly named and located. You can manually override this value. The current version should be automatically set by Ramses if you\u2019re using the Ramses Add-ons ; otherwise you can set it manually. If the task is published and ready to be used and imported in the next step, check the Published box. Again, Ramses should check it automatically if you\u2019ve published the task using the Ramses Add-ons . The bottom box is used to Assign a user to the task. Leave it to All Users to unassign the task. All these settings can be set precisely by the Ramses Add-ons thanks to pipeline automations, and the resulting data can be used for production tracking and planning \u25b9 More details about the pipeline . \u25b9 More details about production tracking . \u25b9 More details about planning . The bottom part of the status editor shows the available working , published and preview files. From these three lists, you can open any file by just double-clicking it. You can restore previous versions of working and published files, and the create from template button in the Work tab can create a new file from a step template (if any template has been published). Files must respect the Ramses naming scheme and folders to be detected and listed here, but you don\u2019t necessarily have to use the Ramses Add-ons , all files will be detected and handled by Ramses . Statistics The Statistics button on the title bar of the application opens a summary of the progress of all steps and the whole project. The top part shows the statistics for the whole project. Remaining time is the count of actual days before reaching the deadline of the project. Completion is the global completion of the project, both as a percentage, and a number of work-days completed (compared to the total estimated work-day count). Estimated Lateness is an estimation of the lateness for all steps; 0% means all is well, a negative lateness means there\u2019s some advance (no, this never happens), a positive value means the production is late. 100% means it took twice the time originally estimated to get to the current completion ratio! For each step, Ramses also compares the remaining work to the schedule, to warn you if you need to plan more days to complete the given step (or if there are extra days). If you pull the row to make it bigger, you can get more details. Assigned shows how many days are assigned in the schedule for the given step, including past and future dates. Extra / Missing shows how many more days are needed to be assigned to the given step, or how many extra days are assigned, compared to the estimation. To the contrary of the extra or missing days shown above, this value does not take into account how much actual work was already done. Timelime The Timeline button on the title bar of the application opens a timeline panel showing all the shots of the project. From this timeline, you can reorder shots, open their folder, or edit their details by just clicking on the corresponding cell. The width of each row depends on the duration of the corresponding shot. You can Use [Middle Click] to quickly scroll in the timeline, and you can use the slider on the left to zoom in and out. You can also control the zoom with [Ctrl] + [Middle Click] or with the [Mouse Wheel] . When selecting a shot on the timeline, it is also selected in the shot table, and vice versa.","title":"Asset and shot production tracking"},{"location":"components/client/production/#asset-and-shot-production-tracking","text":"There are two panels to track the production of the shots and of the assets . From these tables, you can manage the status of all the assets and all the shots of the project, check their completion ratio , how much time was spent for each of them, check the estimation , and finally how late (or not) you are \u2026 \u25b9 More details about production tracking .","title":"Asset and shot production tracking"},{"location":"components/client/production/#overview","text":"The production tables have three main areas: the toolbar on top contains a few useful menus and tools, the main table is where shots or assets are listed, and the dock shows the editors (on the right side of the main table by default).","title":"Overview"},{"location":"components/client/production/#toolbar","text":"On its left side, the toolbar displays a few menus and tools. The first button is a selector to let you filter the displayed asset by asset group, or the shots by sequence. Use the Search field to filter the shots or assets according to their names or IDS . View Show details : when checked, the default height of the cells is adjusted to show all details and information. Sort Use the sort menu to sort the rows either by: ID, name, difficulty, time spent, estimation or completion ratio. Steps Select all shows all the steps in the table. Select none hides all the steps from the table. Select my steps shows only the steps where the current user has some tasks assigned. Use the list of steps to select the ones you want to be shown in the main table. Status Assign User assigns a user to all selected tasks. Change state changes the state of all selected tasks. Changer difficulty changes the difficulty of all selected tasks. Set completion changes the completion ratio of all selected tasks. If the current user is at least a project adminstrator , the toolbar also displays an entry to let you quickly create new items (shots or assets) or remove selected items. Hint To sort rows, click on the sort button on the top left part of the column you want to use for sorting. Tip The Status menu is also availabe as a context menu with the [right click] .","title":"Toolbar"},{"location":"components/client/production/#main-table","text":"From the main table, you can have a look at all the status of all shots or assets, and a summary for steps on the column headers. You can use the [Middle Click] to quickly scroll/pan in the table. The progress bar in the step headers goes from red to green when the completion ratio raises. The first column contains all the information about the shots or the assets (duration, tags, etc.). For all cells, you can open the corresponding folder with the folder button, and if you have enough rights you can click the corresponding cell to edit the details on the side panel. 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). The title of the cell shows the ID of the asset or shot, of the step, and of the current state. The current version of the working file is shown in parenthesis. The button shows the status history of the task. The progress bar can show multiple information. Its color corresponds to the current state color . It shows the completion ratio. Click on any cell to edit its details in a side panel: Use the colored state box on the top left to change the current state. Use the completion slider on the top right to change completion ratio. Just click the slider without dragging to precisely edit the value. You can add a comment just below the completion ratio. Changing the difficulty will change the automatic estimation, according to the settings of the corresponding step . Uncheck the Auto checkbox to manually estimate the time you need to finish the task. Once unchecked, the estimation will not be automatically changed anymore if you change the difficulty or if the step settings change. The time spent is automatically updated by Ramses when you edit the status, according to the information it gets from the Ramses Add-ons and the data it gathers from the files if they\u2019re correctly named and located. You can manually override this value. The current version should be automatically set by Ramses if you\u2019re using the Ramses Add-ons ; otherwise you can set it manually. If the task is published and ready to be used and imported in the next step, check the Published box. Again, Ramses should check it automatically if you\u2019ve published the task using the Ramses Add-ons . The bottom box is used to Assign a user to the task. Leave it to All Users to unassign the task. All these settings can be set precisely by the Ramses Add-ons thanks to pipeline automations, and the resulting data can be used for production tracking and planning \u25b9 More details about the pipeline . \u25b9 More details about production tracking . \u25b9 More details about planning . The bottom part of the status editor shows the available working , published and preview files. From these three lists, you can open any file by just double-clicking it. You can restore previous versions of working and published files, and the create from template button in the Work tab can create a new file from a step template (if any template has been published). Files must respect the Ramses naming scheme and folders to be detected and listed here, but you don\u2019t necessarily have to use the Ramses Add-ons , all files will be detected and handled by Ramses .","title":"Main table"},{"location":"components/client/production/#statistics","text":"The Statistics button on the title bar of the application opens a summary of the progress of all steps and the whole project. The top part shows the statistics for the whole project. Remaining time is the count of actual days before reaching the deadline of the project. Completion is the global completion of the project, both as a percentage, and a number of work-days completed (compared to the total estimated work-day count). Estimated Lateness is an estimation of the lateness for all steps; 0% means all is well, a negative lateness means there\u2019s some advance (no, this never happens), a positive value means the production is late. 100% means it took twice the time originally estimated to get to the current completion ratio! For each step, Ramses also compares the remaining work to the schedule, to warn you if you need to plan more days to complete the given step (or if there are extra days). If you pull the row to make it bigger, you can get more details. Assigned shows how many days are assigned in the schedule for the given step, including past and future dates. Extra / Missing shows how many more days are needed to be assigned to the given step, or how many extra days are assigned, compared to the estimation. To the contrary of the extra or missing days shown above, this value does not take into account how much actual work was already done.","title":"Statistics"},{"location":"components/client/production/#timelime","text":"The Timeline button on the title bar of the application opens a timeline panel showing all the shots of the project. From this timeline, you can reorder shots, open their folder, or edit their details by just clicking on the corresponding cell. The width of each row depends on the duration of the corresponding shot. You can Use [Middle Click] to quickly scroll in the timeline, and you can use the slider on the left to zoom in and out. You can also control the zoom with [Ctrl] + [Middle Click] or with the [Mouse Wheel] . When selecting a shot on the timeline, it is also selected in the shot table, and vice versa.","title":"Timelime"},{"location":"components/client/project/","text":"Project settings panel The project panel is accessible only to Administrator and Project administrator users . This is where the global settings of the current project can be adjusted. The project configured there is the one set with the selector on the title bar . \u25b9 The first tab shows the project settings; the options are described in the Project management section. \u25b9 Steps . \u25b9 Pipe Types . \u25b9 Asset groups . \u25b9 Assets . \u25b9 Sequences . \u25b9 Shots .","title":"Introduction"},{"location":"components/client/project/#project-settings-panel","text":"The project panel is accessible only to Administrator and Project administrator users . This is where the global settings of the current project can be adjusted. The project configured there is the one set with the selector on the title bar . \u25b9 The first tab shows the project settings; the options are described in the Project management section. \u25b9 Steps . \u25b9 Pipe Types . \u25b9 Asset groups . \u25b9 Assets . \u25b9 Sequences . \u25b9 Shots .","title":"Project settings panel"},{"location":"components/client/projects/","text":"Project management This panel is used to list and manage all projects of Ramses . List The list on the left lists all the projects, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each project can be displayed. The folder button on the top right corner for each project in the list opens the project folder in your file explorer. Use the button to create a new project. The button removes the selected projects from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new projects. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected projects. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Name is the project\u2019s display name and can be changed any time. ID is the unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed after the project folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the project. Resolution is the width and height of the final video, in pixels. The first button allows you to quickly select from a list of common resolutions. Framerate is the framerate of the final video, in frames per second. Use the first button to quickly select it from a list of common framerates. Deadline is the date at which the project must be finished and delivered. You can change the folder where the project files are stored. Leave the field empty to set back the default folder inside the Ramses Tree . The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Use the Users list to assign and unassign users to the project. The button contains a list of available users, and an entry to quickly create a new user without having to switch to the users tab. The button unassigns the selected users from the project but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific user folder, and the edit button to edit them in a side docked panel. Read the user management section for more details about user edition. \u25b9 More details about Projects and Ramses . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Projects"},{"location":"components/client/projects/#project-management","text":"This panel is used to list and manage all projects of Ramses .","title":"Project management"},{"location":"components/client/projects/#list","text":"The list on the left lists all the projects, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each project can be displayed. The folder button on the top right corner for each project in the list opens the project folder in your file explorer. Use the button to create a new project. The button removes the selected projects from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new projects. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected projects. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/projects/#edition","text":"Name is the project\u2019s display name and can be changed any time. ID is the unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed after the project folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the project. Resolution is the width and height of the final video, in pixels. The first button allows you to quickly select from a list of common resolutions. Framerate is the framerate of the final video, in frames per second. Use the first button to quickly select it from a list of common framerates. Deadline is the date at which the project must be finished and delivered. You can change the folder where the project files are stored. Leave the field empty to set back the default folder inside the Ramses Tree . The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Use the Users list to assign and unassign users to the project. The button contains a list of available users, and an entry to quickly create a new user without having to switch to the users tab. The button unassigns the selected users from the project but does not remove them from Ramses . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific user folder, and the edit button to edit them in a side docked panel. Read the user management section for more details about user edition. \u25b9 More details about Projects and Ramses . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/schedule/","text":"Schedule and planning You can use the schedule panel to plan the production, per user and per step. \u25b9 More details about production planning . Note A future version of the application will include a more general schedule, to let you quickly select time ranges for each step, defining a starting and ending date for each, without having to assign tasks to individual users. Overview The schedule table has two main areas: the toolbar on top contains a few useful menus and tools, and the main table is where you plan the production. It is useful to keep the statistics side panel at hand when planning the production. Toolbar On its left side, the toolbar displays a few menus and tools. Users Me : shows only the current user in the table. Select all : shows all the users assigned to this project in the table. Select none : hides all the users from the table. The User list can be used to select the users to show in the table. Days Select the days of the week to be shown in the table. This setting is kept across sessions, but it is a local setting, it is not shared with other workstations. Step Comment\u2026 adds a comment to the selected table cells (schedule entries). Assign (un)assigns a step to the selected celles (schedule entries). Go to date scrolls the table to a specific date. Today scrolls the table to the current date. Deadline scrolls the table to the deadline of the current project. \u25c0 Previous month scrolls the table to the previous month. Next month \u25b6 : I think you can guess what this button does. The right side of the toolbar shows the time remaining before reaching the deadline of the project and lets you define the time range of the table. Tip The Step menu, to assign steps and set comments, is also availabe as a context menu with the [right click] on the table cells. Main table Each column represents a day, lines represent users. There are two lines per user to allow you to assign tasks only to half of a day. The first line can be used to add any comment to the given day (column), for example to show deadlines, holidays, etc. Columns in the past are darker than columns in the future, the current day is shown in purple in the header; the project deadline is shown in red. To help you differenciate weeks, an alternate grey is used for to separate them. You can hide the days of the week which are not working days (a.k.a. Weekends) using the Days menu. Planning the project with the table is very quick and easy: Click on any cell to assign a step to the corresponding user and date. Use the context menu with [Right click] to assign steps to multiple users and multiple days at once. You can also add a comment to selected schedule entries; comments are shown when changing the size of the rows. There are a lot of different ways to select multiple cells in the table: [Left click + Drag] to quickly select contiguous cells. [Shift + Left click] to select the range between the active (last selected) cell and another cell. [Ctrl + Left click] to select individual cells. These three methods can be combined: for example, [Ctrl + Left click + Drag] to quickly select different groups of cells. To check how many days you have to assign (or how many extra days you have already assigned) according to the estimations, use the Statistics panel. Statistics The Statistics button on the title bar of the application opens a summary of the progress of all steps and the whole project. The top part shows the statistics for the whole project. Remaining time is the count of actual days before reaching the deadline of the project. Completion is the global completion of the project, both as a percentage, and a number of work-days completed (compared to the total estimated work-day count). Estimated Lateness is an estimation of the lateness for all steps; 0% means all is well, a negative lateness means there\u2019s some advance (no, this never happens), a positive value means the production is late. 100% means it took twice the time originally estimated to get to the current completion ratio! For each step, Ramses also compares the remaining work to the schedule, to warn you if you need to plan more days to complete the given step (or if there are extra days). If you pull the row to make it bigger, you can get more details. Assigned shows how many days are assigned in the schedule for the given step, including past and future dates. Extra / Missing shows how many more days are needed to be assigned to the given step, or how many extra days are assigned, compared to the estimation. To the contrary of the extra or missing days shown above, this value does not take into account how much actual work was already done.","title":"Schedule and planning"},{"location":"components/client/schedule/#schedule-and-planning","text":"You can use the schedule panel to plan the production, per user and per step. \u25b9 More details about production planning . Note A future version of the application will include a more general schedule, to let you quickly select time ranges for each step, defining a starting and ending date for each, without having to assign tasks to individual users.","title":"Schedule and planning"},{"location":"components/client/schedule/#overview","text":"The schedule table has two main areas: the toolbar on top contains a few useful menus and tools, and the main table is where you plan the production. It is useful to keep the statistics side panel at hand when planning the production.","title":"Overview"},{"location":"components/client/schedule/#toolbar","text":"On its left side, the toolbar displays a few menus and tools. Users Me : shows only the current user in the table. Select all : shows all the users assigned to this project in the table. Select none : hides all the users from the table. The User list can be used to select the users to show in the table. Days Select the days of the week to be shown in the table. This setting is kept across sessions, but it is a local setting, it is not shared with other workstations. Step Comment\u2026 adds a comment to the selected table cells (schedule entries). Assign (un)assigns a step to the selected celles (schedule entries). Go to date scrolls the table to a specific date. Today scrolls the table to the current date. Deadline scrolls the table to the deadline of the current project. \u25c0 Previous month scrolls the table to the previous month. Next month \u25b6 : I think you can guess what this button does. The right side of the toolbar shows the time remaining before reaching the deadline of the project and lets you define the time range of the table. Tip The Step menu, to assign steps and set comments, is also availabe as a context menu with the [right click] on the table cells.","title":"Toolbar"},{"location":"components/client/schedule/#main-table","text":"Each column represents a day, lines represent users. There are two lines per user to allow you to assign tasks only to half of a day. The first line can be used to add any comment to the given day (column), for example to show deadlines, holidays, etc. Columns in the past are darker than columns in the future, the current day is shown in purple in the header; the project deadline is shown in red. To help you differenciate weeks, an alternate grey is used for to separate them. You can hide the days of the week which are not working days (a.k.a. Weekends) using the Days menu. Planning the project with the table is very quick and easy: Click on any cell to assign a step to the corresponding user and date. Use the context menu with [Right click] to assign steps to multiple users and multiple days at once. You can also add a comment to selected schedule entries; comments are shown when changing the size of the rows. There are a lot of different ways to select multiple cells in the table: [Left click + Drag] to quickly select contiguous cells. [Shift + Left click] to select the range between the active (last selected) cell and another cell. [Ctrl + Left click] to select individual cells. These three methods can be combined: for example, [Ctrl + Left click + Drag] to quickly select different groups of cells. To check how many days you have to assign (or how many extra days you have already assigned) according to the estimations, use the Statistics panel.","title":"Main table"},{"location":"components/client/schedule/#statistics","text":"The Statistics button on the title bar of the application opens a summary of the progress of all steps and the whole project. The top part shows the statistics for the whole project. Remaining time is the count of actual days before reaching the deadline of the project. Completion is the global completion of the project, both as a percentage, and a number of work-days completed (compared to the total estimated work-day count). Estimated Lateness is an estimation of the lateness for all steps; 0% means all is well, a negative lateness means there\u2019s some advance (no, this never happens), a positive value means the production is late. 100% means it took twice the time originally estimated to get to the current completion ratio! For each step, Ramses also compares the remaining work to the schedule, to warn you if you need to plan more days to complete the given step (or if there are extra days). If you pull the row to make it bigger, you can get more details. Assigned shows how many days are assigned in the schedule for the given step, including past and future dates. Extra / Missing shows how many more days are needed to be assigned to the given step, or how many extra days are assigned, compared to the estimation. To the contrary of the extra or missing days shown above, this value does not take into account how much actual work was already done.","title":"Statistics"},{"location":"components/client/sequences/","text":"Sequence settings This panel is used to list and manage all the sequences of the project. Sequences are used to help you sort and filter the shots of the project . They\u2019re not used in the Ramses Tree . List The list on the left lists all the sequences of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each sequence can be displayed. Use the button to create a new sequence. The button removes the selected sequences from the project 1 . You can use the [Shift + A] shortcut key to quickly add new sequences. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected sequences. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Name is the sequence\u2019s display name. ID is the unique identifier. It is usually just a number, possibily with a simple prefix. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated with the sequence and describing it. Shots contained in the sequence are listed in the bottom section. The button instantly creates a new shot contained in the current sequence. The button removes the selected shots from the project 1 . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific shot folder, and the edit button to edit them in a side docked panel. Read the shot settings section for more details about shot edition. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9","title":"Sequences"},{"location":"components/client/sequences/#sequence-settings","text":"This panel is used to list and manage all the sequences of the project. Sequences are used to help you sort and filter the shots of the project . They\u2019re not used in the Ramses Tree .","title":"Sequence settings"},{"location":"components/client/sequences/#list","text":"The list on the left lists all the sequences of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each sequence can be displayed. Use the button to create a new sequence. The button removes the selected sequences from the project 1 . You can use the [Shift + A] shortcut key to quickly add new sequences. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected sequences. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/sequences/#edition","text":"Name is the sequence\u2019s display name. ID is the unique identifier. It is usually just a number, possibily with a simple prefix. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated with the sequence and describing it. Shots contained in the sequence are listed in the bottom section. The button instantly creates a new shot contained in the current sequence. The button removes the selected shots from the project 1 . You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific shot folder, and the edit button to edit them in a side docked panel. Read the shot settings section for more details about shot edition. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9 \u21a9","title":"Edition"},{"location":"components/client/settings/","text":"Application settings and overview The home screen, shown when starting the application. When running the application for the first time, you need to go to the settings first to configure it. Overview General shortcuts and behaviour In all the application, a few shortcuts are always the same, in addition to your system\u2019s usual shortcuts for copy , paste , undo etc. [Middle Click] : scroll/pan in lists, tables, timeline\u2026 [Ctrl] + [Middle Click] or [Mouse Wheel] : zoom in or out in views which can be zoomed. [Shift] + [A] : add/create something. [Del] or [Shift] + [X] : remove/delete selection. All side panels (docks) can be moved around and docked to the sides or undocked by clicking on their titles. Menu bars can also be moved to all sides of the application. Title bar The title bar show the main buttons to switch the panels on the left, and the visibility buttons on the right. Click and drag an empty space of the title bar to move the whole window. In the middle of the title bar is the selector where you can select the project you\u2019re currently working on. Hide. The application will not close but sit in the system tray. Which panels and buttons are available depends on the role of the current user , and there may be fewer buttons than on the picture above. Administration panel ( Administrators only). Project settings panel ( Project administrators and Administrators only). Pipeline editor panel ( Project administrators and Administrators only). Assets table panel. Shots table panel. Schedule panel. Statistics panel. Status bar The status bar at the bottom of the window displays temporary feedback, useful messages and help on its left section. On the right section, there are a few secondary buttons. The reload button updates all data from the server. You should not need to click this button too often as the data is automatically and regularly pulled from the server. The console button shows the console panel (see the next section) where Ramses logs useful information for debugging or for developpers. Errors and warnings are also logged there. | A warning or an error button may be shown next, when there are some issues. Click on the button to show the latest logs and learn what\u2019s wrong; a clear button is available on the popup to remove the warning. The online / offline button can be used to switch between online and offline mode. Going online may need to input your password again. The user button (which shows your user name, or Guest if you\u2019re not logged in yet) gives access to a few user options (see below). The settings button leads you to the settings of the application. The help button shows a small menu with useful shortcuts. Console The console panel is where Ramses logs useful information for debugging or for developpers. Errors and warnings are also logged there, respectively in red and yellow. As many other Ramses panel, the console is a docked panel which can be undocked or docked both on the right and left side of Ramses by just clicking its title and moving it. User Profile Use the user menu at the bottom right of the window (the button with your ID) to access your profile settings. Except for the password, there\u2019s no need to validate any change; changes are saved instantly. Name is your display name and can be changed any time (although it\u2019s not really advisable). ID is your unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed once your user folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to your user. It is public. The Current role can never be changed by the user itself, and has to be changed by an administrator. To update your password, input your Current password and repeat your New password twice. Don\u2019t forget to click the Change password button to validate! You can change the folder where your personnal files are stored. Leave the field empty to set back the default folder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Lists There are a lot of lists in Ramses \u2026 In all lists, you can grab the bottom margin of any row to reveal more details. Clicking on a item opens the corresponding properties in a side panel. If you need to select several items, you can click and hold while dragging the mouse to select contiguous items, or you can hold [Ctrl] while clicking items to select individual items. The search bar uses both IDs and names to find items. In most of the lists, [Del] and [Shift] + [X] can be used to remove items. [Middle Click] can be used to scroll the list, as the [Mouse Wheel] does too. Comments In many places, you can add Comments in Ramses . These comments can be simple texts, but they can also be formatted using the Markdown syntax. Start by writing some text, and validate your input with [Enter] from the numpad. Ramses will interpret the text to display a nice rich text. You can get back to the source to edit the text in more details using the [F2] key. Use the [Right Click] context menu for other options. Settings To open the settings panel, click on the settings button at the bottom right corner of the window. Note These settings are local settings, and will not be shared with other workstations. Each workstation, (actually, each session on the system) has its own settings. The purple button will restore all default settings. Use the blue close button to close the settings. They are automatically saved. Appearance The first tab shows the appearance settings; you can change these as you wish. Ramses Data The second tab defines how Ramses will store the data on the filesystem, and has a few display option for the data. Ramses main folder defines the location of the main Ramses root folder, the one which will contain the Config , Projects and Users subfolders, as defined by the Ramses Tree . By default, this folder is located in your user folder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Note Project folders and user folders can be individually changed later to be outside of this main Ramses root folder, for example if you need to locate specific projects in other arbitrary specific folders. But Ramses still needs this main folder to be defined, at least to store some configuration files. Date format defines how dates will be displayed in the user interface. It does not change anything about how the data is actually stored in the database and files. Time format defines how times will be displayed in the user interface. It does not change anything about how the data is actually stored in the database and files. Server The third tab configures how the application will connect to the server. Server address must be the complete URL to the server. Secure connexion must be checked in case you want to encrypt the data sent to and recieved from the server. Your server must be compatible with SSL and have a valid certificate. Update every X minutes defines how often the application will automatically update all its data from the server. In order to keep the application very lightweight and the server very light and easy to install on all kind of computers, the local data is not updated in realtime (there\u2019s no pushing from the server), but the application will regularly pull changes from the server. This value does not need to be too low, as Ramses does not really need to be perfectly up-to-date every second. The default value is 2 minutes . Server timeout defines how long the application will wait for the server response when getting or posting data. If this timeout expires, the server will be considered not working correctly and the application will switch to offline mode. You may raise a bit this value if your server or your connexion are particularly slow. The default value is 3 seconds . Daemon The Daemon is a background service, a small local server, which is started with the application and is in charge of communications with the Ramses Add-ons . Listenning on port defines the local port used by the Daemon to receive connections and requests from the Ramses Add-ons and other services. You may change this value if it conflicts with other applications; in this case, you\u2019ll have to change it in the settings of all the Ramses Add-ons too. The default value is 18185 1 . Click the Restart Daemon button when changing the listenning port to apply the change. This value has been chosen after the birth date of Karl Marx , 5 May 1818. \u21a9","title":"Overview and settings"},{"location":"components/client/settings/#application-settings-and-overview","text":"The home screen, shown when starting the application. When running the application for the first time, you need to go to the settings first to configure it.","title":"Application settings and overview"},{"location":"components/client/settings/#overview","text":"","title":"Overview"},{"location":"components/client/settings/#general-shortcuts-and-behaviour","text":"In all the application, a few shortcuts are always the same, in addition to your system\u2019s usual shortcuts for copy , paste , undo etc. [Middle Click] : scroll/pan in lists, tables, timeline\u2026 [Ctrl] + [Middle Click] or [Mouse Wheel] : zoom in or out in views which can be zoomed. [Shift] + [A] : add/create something. [Del] or [Shift] + [X] : remove/delete selection. All side panels (docks) can be moved around and docked to the sides or undocked by clicking on their titles. Menu bars can also be moved to all sides of the application.","title":"General shortcuts and behaviour"},{"location":"components/client/settings/#title-bar","text":"The title bar show the main buttons to switch the panels on the left, and the visibility buttons on the right. Click and drag an empty space of the title bar to move the whole window. In the middle of the title bar is the selector where you can select the project you\u2019re currently working on. Hide. The application will not close but sit in the system tray. Which panels and buttons are available depends on the role of the current user , and there may be fewer buttons than on the picture above. Administration panel ( Administrators only). Project settings panel ( Project administrators and Administrators only). Pipeline editor panel ( Project administrators and Administrators only). Assets table panel. Shots table panel. Schedule panel. Statistics panel.","title":"Title bar"},{"location":"components/client/settings/#status-bar","text":"The status bar at the bottom of the window displays temporary feedback, useful messages and help on its left section. On the right section, there are a few secondary buttons. The reload button updates all data from the server. You should not need to click this button too often as the data is automatically and regularly pulled from the server. The console button shows the console panel (see the next section) where Ramses logs useful information for debugging or for developpers. Errors and warnings are also logged there. | A warning or an error button may be shown next, when there are some issues. Click on the button to show the latest logs and learn what\u2019s wrong; a clear button is available on the popup to remove the warning. The online / offline button can be used to switch between online and offline mode. Going online may need to input your password again. The user button (which shows your user name, or Guest if you\u2019re not logged in yet) gives access to a few user options (see below). The settings button leads you to the settings of the application. The help button shows a small menu with useful shortcuts.","title":"Status bar"},{"location":"components/client/settings/#console","text":"The console panel is where Ramses logs useful information for debugging or for developpers. Errors and warnings are also logged there, respectively in red and yellow. As many other Ramses panel, the console is a docked panel which can be undocked or docked both on the right and left side of Ramses by just clicking its title and moving it.","title":"Console"},{"location":"components/client/settings/#user-profile","text":"Use the user menu at the bottom right of the window (the button with your ID) to access your profile settings. Except for the password, there\u2019s no need to validate any change; changes are saved instantly. Name is your display name and can be changed any time (although it\u2019s not really advisable). ID is your unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed once your user folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to your user. It is public. The Current role can never be changed by the user itself, and has to be changed by an administrator. To update your password, input your Current password and repeat your New password twice. Don\u2019t forget to click the Change password button to validate! You can change the folder where your personnal files are stored. Leave the field empty to set back the default folder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer.","title":"User Profile"},{"location":"components/client/settings/#lists","text":"There are a lot of lists in Ramses \u2026 In all lists, you can grab the bottom margin of any row to reveal more details. Clicking on a item opens the corresponding properties in a side panel. If you need to select several items, you can click and hold while dragging the mouse to select contiguous items, or you can hold [Ctrl] while clicking items to select individual items. The search bar uses both IDs and names to find items. In most of the lists, [Del] and [Shift] + [X] can be used to remove items. [Middle Click] can be used to scroll the list, as the [Mouse Wheel] does too.","title":"Lists"},{"location":"components/client/settings/#comments","text":"In many places, you can add Comments in Ramses . These comments can be simple texts, but they can also be formatted using the Markdown syntax. Start by writing some text, and validate your input with [Enter] from the numpad. Ramses will interpret the text to display a nice rich text. You can get back to the source to edit the text in more details using the [F2] key. Use the [Right Click] context menu for other options.","title":"Comments"},{"location":"components/client/settings/#settings","text":"To open the settings panel, click on the settings button at the bottom right corner of the window. Note These settings are local settings, and will not be shared with other workstations. Each workstation, (actually, each session on the system) has its own settings. The purple button will restore all default settings. Use the blue close button to close the settings. They are automatically saved.","title":"Settings"},{"location":"components/client/settings/#appearance","text":"The first tab shows the appearance settings; you can change these as you wish.","title":"Appearance"},{"location":"components/client/settings/#ramses-data","text":"The second tab defines how Ramses will store the data on the filesystem, and has a few display option for the data. Ramses main folder defines the location of the main Ramses root folder, the one which will contain the Config , Projects and Users subfolders, as defined by the Ramses Tree . By default, this folder is located in your user folder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Note Project folders and user folders can be individually changed later to be outside of this main Ramses root folder, for example if you need to locate specific projects in other arbitrary specific folders. But Ramses still needs this main folder to be defined, at least to store some configuration files. Date format defines how dates will be displayed in the user interface. It does not change anything about how the data is actually stored in the database and files. Time format defines how times will be displayed in the user interface. It does not change anything about how the data is actually stored in the database and files.","title":"Ramses Data"},{"location":"components/client/settings/#server","text":"The third tab configures how the application will connect to the server. Server address must be the complete URL to the server. Secure connexion must be checked in case you want to encrypt the data sent to and recieved from the server. Your server must be compatible with SSL and have a valid certificate. Update every X minutes defines how often the application will automatically update all its data from the server. In order to keep the application very lightweight and the server very light and easy to install on all kind of computers, the local data is not updated in realtime (there\u2019s no pushing from the server), but the application will regularly pull changes from the server. This value does not need to be too low, as Ramses does not really need to be perfectly up-to-date every second. The default value is 2 minutes . Server timeout defines how long the application will wait for the server response when getting or posting data. If this timeout expires, the server will be considered not working correctly and the application will switch to offline mode. You may raise a bit this value if your server or your connexion are particularly slow. The default value is 3 seconds .","title":"Server"},{"location":"components/client/settings/#daemon","text":"The Daemon is a background service, a small local server, which is started with the application and is in charge of communications with the Ramses Add-ons . Listenning on port defines the local port used by the Daemon to receive connections and requests from the Ramses Add-ons and other services. You may change this value if it conflicts with other applications; in this case, you\u2019ll have to change it in the settings of all the Ramses Add-ons too. The default value is 18185 1 . Click the Restart Daemon button when changing the listenning port to apply the change. This value has been chosen after the birth date of Karl Marx , 5 May 1818. \u21a9","title":"Daemon"},{"location":"components/client/shots/","text":"Shot settings This panel is used to list and manage all the shots of the project . There is no production tracking from this panel, as it is used only to edit shot settings. List The list on the left lists all the shots of the project, and you can use the Search field to filter them by name or ID . The top selector filters the shots according to their containing sequence . When changing the size of the rows in the list, more details about each shot can be displayed. The folder button on the top right corner for each shot in the list opens the shot folder in your file explorer. Use the button to create a new shot in the current sequence. The button removes the selected shots from the project 1 . You can use the [Shift + A] shortcut key to quickly add new shots. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected shots. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . The creation button also allows you to create multiple shots at once and opens the following dialog: First, select the sequence where the shots will be added. If you need to add shots to several sequences, start again for each sequence. Choose the starting and end number. You can add leading zeroes, Ramses will keep them in the number, so that all shots have the same count of digits. Choose a name for the new shots. Include the % character at the location where you wish the number to be. For example, Shot % A will be translated as Shot 012 A . Choose an ID for the new shots. Again, you can use the % character to locate the shot number. If you omit it, the number is automatically appended to the ID. Edition Name is the shot\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the shot folder has been created . It usually is just a number. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the shot and describing it. The Duration of the shot can be set either in seconds or frames. Ramses uses the project framerate to update the other value. You can change the Sequence which contains this shot. The button opens the shot folder in your file explorer. This folder contains the individual working files, each in its step subfolder. For more details, read the Ramses Tree section. Use the Asset list to assign assets to the shots. The top selector filters the assets according to their containing group . The button contains the list of available assets for the current group. There\u2019s also an entry to quickly create a new asset without having to switch to the asset management panel . The button unassigns the selected assets from the shot, but they\u2019re not removed from the project. You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific asset folder, and the edit button to edit them in a side docked panel. Read the asset settings section for more details about asset edition. The list of assets as long as the duration can be used to automatically multiply the estimation of the shot. Read the planning section for more information about estimations, and the step management section to learn how to configure steps and automatic default estimations. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Shots"},{"location":"components/client/shots/#shot-settings","text":"This panel is used to list and manage all the shots of the project . There is no production tracking from this panel, as it is used only to edit shot settings.","title":"Shot settings"},{"location":"components/client/shots/#list","text":"The list on the left lists all the shots of the project, and you can use the Search field to filter them by name or ID . The top selector filters the shots according to their containing sequence . When changing the size of the rows in the list, more details about each shot can be displayed. The folder button on the top right corner for each shot in the list opens the shot folder in your file explorer. Use the button to create a new shot in the current sequence. The button removes the selected shots from the project 1 . You can use the [Shift + A] shortcut key to quickly add new shots. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected shots. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . The creation button also allows you to create multiple shots at once and opens the following dialog: First, select the sequence where the shots will be added. If you need to add shots to several sequences, start again for each sequence. Choose the starting and end number. You can add leading zeroes, Ramses will keep them in the number, so that all shots have the same count of digits. Choose a name for the new shots. Include the % character at the location where you wish the number to be. For example, Shot % A will be translated as Shot 012 A . Choose an ID for the new shots. Again, you can use the % character to locate the shot number. If you omit it, the number is automatically appended to the ID.","title":"List"},{"location":"components/client/shots/#edition","text":"Name is the shot\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the shot folder has been created . It usually is just a number. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the shot and describing it. The Duration of the shot can be set either in seconds or frames. Ramses uses the project framerate to update the other value. You can change the Sequence which contains this shot. The button opens the shot folder in your file explorer. This folder contains the individual working files, each in its step subfolder. For more details, read the Ramses Tree section. Use the Asset list to assign assets to the shots. The top selector filters the assets according to their containing group . The button contains the list of available assets for the current group. There\u2019s also an entry to quickly create a new asset without having to switch to the asset management panel . The button unassigns the selected assets from the shot, but they\u2019re not removed from the project. You can also use the [DEL] key. From the list, you can use the folder button to quickly open a specific asset folder, and the edit button to edit them in a side docked panel. Read the asset settings section for more details about asset edition. The list of assets as long as the duration can be used to automatically multiply the estimation of the shot. Read the planning section for more information about estimations, and the step management section to learn how to configure steps and automatic default estimations. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/states/","text":"State management This panel is used to list and manage all the states used by Ramses for production tracking. The states are shared by all projects . The list of available states can be completely customized. Read the section about Production tracking for more details about states and status. List The list on the left lists all the states, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each state can be displayed. Use the button to create a new state. The button removes the selected states from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new states. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected states. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . A few states can\u2019t be removed as they are needed by Ramses automations (but they can still be customized, only their ID can\u2019t change): NO, STB, TODO, WIP, OK . Edition Name is the state\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). It is also used in the user interface when there is too little room to use the name. Comment can be any text associated to the state. You can use it to describe the state and explain what it means. This comment has nothing to do with the actual production status of shots and assets, it is linked to the state itself and just describes it. The color is used to display the states in the user interface and easily differenciate them in lists. Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. The completion ratio is used to automatically set a default value to the completion of the tasks when their state changes. This task completion ratio can then be adjusted by the user for each individual task. \u25b9 More details about Production tracking and the states . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"States"},{"location":"components/client/states/#state-management","text":"This panel is used to list and manage all the states used by Ramses for production tracking. The states are shared by all projects . The list of available states can be completely customized. Read the section about Production tracking for more details about states and status.","title":"State management"},{"location":"components/client/states/#list","text":"The list on the left lists all the states, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each state can be displayed. Use the button to create a new state. The button removes the selected states from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new states. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected states. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . A few states can\u2019t be removed as they are needed by Ramses automations (but they can still be customized, only their ID can\u2019t change): NO, STB, TODO, WIP, OK .","title":"List"},{"location":"components/client/states/#edition","text":"Name is the state\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). It is also used in the user interface when there is too little room to use the name. Comment can be any text associated to the state. You can use it to describe the state and explain what it means. This comment has nothing to do with the actual production status of shots and assets, it is linked to the state itself and just describes it. The color is used to display the states in the user interface and easily differenciate them in lists. Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. The completion ratio is used to automatically set a default value to the completion of the tasks when their state changes. This task completion ratio can then be adjusted by the user for each individual task. \u25b9 More details about Production tracking and the states . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/steps/","text":"Step settings This panel is used to list and manage all the steps of the project which are used by the pipeline , production tracking and planning . Steps can also be directly created, edited and removed from the pipeline editor . List The list on the left lists all the steps of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each step can be displayed. The folder button on the top right corner for each user in the list opens the user folder in your file explorer. Use the button to create a new step (either completely new or using a template). The button removes the selected steps from the project 1 . You can use the [Shift + A] shortcut key to quickly add new steps. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected steps. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Steps can be re-order by dragging their ID in the column header of the list. Hint Ramses comes with a set of template steps, but they can be completely adjusted to any production needs; for example, if you consider Character Desgin to be a pre-production step instead of an asset production step, it\u2019s up to you to customize the templates. The list of template steps is available and can be managed in the administration panel by administrator users . Edition Name is the step\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the step has been created . Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the step and describing it. It can be formatted, using the Markdown syntax. Use the Type list to set the type of the step. Read this for more information about step types. The color is used to display the steps in the user interface and easily differenciate them in lists and the schedule . Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. There are a few tabs for other details: Applications can be assigned to each step; this information is used by the pipeline tools for automations and to open files. The button contains a list of available applications, and an entry to quickly create a new application without having to switch to the applications tab. The button unassigns the selected appplications from the project but does not remove them from Ramses . You can also use the [DEL] key. You can set the default estimation for the step. Read the section about Production Planning for more information. For Shot Production steps, you can select if the estimation has to be evaluated per shot (for a lighting step where the quantity of work does not depend on the duration of the shot for example) or on the duration, per second (better for the animation step for example). You can set a different default estimation for shots or assets depending on the difficulty . Estimation is made in days . For Shot Production steps, you can select an asset group to multiply the estimation by the number of corresponding assets in the shot. For example, you can multiply the estimation of the animation by the number of characters in the shot. Use the several Settings tabs to add some custom settings which can be used by Ramses add-ons to automate the pipeline. Using the official Ramses Add-ons , these settings should be formatted using the Yaml syntax. Read the Add-ons section for more information about the settings you can use. Finally, the button opens the step folder in your file explorer. This folder contains the step common files , especially the templates, but not the working files which are stored within their assets and shots. Tip To change the ID of the step, you\u2019ll need to create a new one with the new ID and remove the old one; it may be safe to do so at the beginning of a project, but existing data (if any) can\u2019t be transfered to the new step, be careful! \u25b9 More details about Steps and Ramses . \u25b9 More details about estimations and planning . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Steps"},{"location":"components/client/steps/#step-settings","text":"This panel is used to list and manage all the steps of the project which are used by the pipeline , production tracking and planning . Steps can also be directly created, edited and removed from the pipeline editor .","title":"Step settings"},{"location":"components/client/steps/#list","text":"The list on the left lists all the steps of the project, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each step can be displayed. The folder button on the top right corner for each user in the list opens the user folder in your file explorer. Use the button to create a new step (either completely new or using a template). The button removes the selected steps from the project 1 . You can use the [Shift + A] shortcut key to quickly add new steps. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected steps. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Steps can be re-order by dragging their ID in the column header of the list. Hint Ramses comes with a set of template steps, but they can be completely adjusted to any production needs; for example, if you consider Character Desgin to be a pre-production step instead of an asset production step, it\u2019s up to you to customize the templates. The list of template steps is available and can be managed in the administration panel by administrator users .","title":"List"},{"location":"components/client/steps/#edition","text":"Name is the step\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section). It can\u2019t be changed after the step has been created . Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the step and describing it. It can be formatted, using the Markdown syntax. Use the Type list to set the type of the step. Read this for more information about step types. The color is used to display the steps in the user interface and easily differenciate them in lists and the schedule . Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. There are a few tabs for other details: Applications can be assigned to each step; this information is used by the pipeline tools for automations and to open files. The button contains a list of available applications, and an entry to quickly create a new application without having to switch to the applications tab. The button unassigns the selected appplications from the project but does not remove them from Ramses . You can also use the [DEL] key. You can set the default estimation for the step. Read the section about Production Planning for more information. For Shot Production steps, you can select if the estimation has to be evaluated per shot (for a lighting step where the quantity of work does not depend on the duration of the shot for example) or on the duration, per second (better for the animation step for example). You can set a different default estimation for shots or assets depending on the difficulty . Estimation is made in days . For Shot Production steps, you can select an asset group to multiply the estimation by the number of corresponding assets in the shot. For example, you can multiply the estimation of the animation by the number of characters in the shot. Use the several Settings tabs to add some custom settings which can be used by Ramses add-ons to automate the pipeline. Using the official Ramses Add-ons , these settings should be formatted using the Yaml syntax. Read the Add-ons section for more information about the settings you can use. Finally, the button opens the step folder in your file explorer. This folder contains the step common files , especially the templates, but not the working files which are stored within their assets and shots. Tip To change the ID of the step, you\u2019ll need to create a new one with the new ID and remove the old one; it may be safe to do so at the beginning of a project, but existing data (if any) can\u2019t be transfered to the new step, be careful! \u25b9 More details about Steps and Ramses . \u25b9 More details about estimations and planning . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/templateassetgroups/","text":"Template Asset Group management This panel is used to list and manage all template asset groups of Ramses . Template assset groups can be used when configuring a project and its pipeline , to quickly create asset groups for the project. Read the section about Production tracking for more details about asset groups, and the section about the asset group management in the Ramses Client Application to learn how to create and manage asset groups inside projects. List The list on the left lists all the template asset groups, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each asset group can be displayed. Use the button to create a new template asset group. The button removes the selected template asset groups from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add template asset groups. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected template asset groups. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Hint All these settings can be safely changed at any time as this information is not actually used in Ramses but just read at the moment an asset group is created from a template. Name is the template asset group\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the template asset group. Note Asset groups are one of the only elements for which the name is used as a folder name as part of the Ramses Tree . \u25b9 More details about Assets and Ramses . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Template Asset Groups"},{"location":"components/client/templateassetgroups/#template-asset-group-management","text":"This panel is used to list and manage all template asset groups of Ramses . Template assset groups can be used when configuring a project and its pipeline , to quickly create asset groups for the project. Read the section about Production tracking for more details about asset groups, and the section about the asset group management in the Ramses Client Application to learn how to create and manage asset groups inside projects.","title":"Template Asset Group management"},{"location":"components/client/templateassetgroups/#list","text":"The list on the left lists all the template asset groups, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each asset group can be displayed. Use the button to create a new template asset group. The button removes the selected template asset groups from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add template asset groups. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected template asset groups. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/templateassetgroups/#edition","text":"Hint All these settings can be safely changed at any time as this information is not actually used in Ramses but just read at the moment an asset group is created from a template. Name is the template asset group\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the template asset group. Note Asset groups are one of the only elements for which the name is used as a folder name as part of the Ramses Tree . \u25b9 More details about Assets and Ramses . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/templatesteps/","text":"Template Step management This panel is used to list and manage all template steps of Ramses . Template steps can be used when configuring a project and its pipeline , to quickly create steps for the project. Read the section about Pipelines for more details about steps, and the section about the step management in the Ramses Client Application to learn how to create and manage steps inside projects. List The list on the left lists all the template steps, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each template step can be displayed. Use the button to create a new template step. The button removes the selected template steps from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add template steps. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected template steps. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Edition Hint All these settings can be safely changed at any time as this information is not actually used in Ramses but just read at the moment a step is created from a template. Name is the template step\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the template step. Use the Type list to set the type of the step. Read this for more information about step types. The color is used to display the steps in the user interface and easily differenciate them in lists and the schedule . Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. You can set the default estimation for the step. Read the section about Production Planning for more information. For Shot Production steps, you can select if the estimation has to be evaluated per shot or on the duration, per second . You can set a different default estimation for shots or assets depending on the difficulty . Estimation is made in days . \u25b9 More details about Steps and Ramses . \u25b9 More details about estimations and planning . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Template Steps"},{"location":"components/client/templatesteps/#template-step-management","text":"This panel is used to list and manage all template steps of Ramses . Template steps can be used when configuring a project and its pipeline , to quickly create steps for the project. Read the section about Pipelines for more details about steps, and the section about the step management in the Ramses Client Application to learn how to create and manage steps inside projects.","title":"Template Step management"},{"location":"components/client/templatesteps/#list","text":"The list on the left lists all the template steps, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each template step can be displayed. Use the button to create a new template step. The button removes the selected template steps from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add template steps. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected template steps. You can scroll all lists using [Middle click] as well as the [Mouse wheel] .","title":"List"},{"location":"components/client/templatesteps/#edition","text":"Hint All these settings can be safely changed at any time as this information is not actually used in Ramses but just read at the moment a step is created from a template. Name is the template step\u2019s display name. ID is the unique identifier which is used in the files and folders (see the Ramses Tree section and the Ramses naming convetions ). Comment can be any text associated to the template step. Use the Type list to set the type of the step. Read this for more information about step types. The color is used to display the steps in the user interface and easily differenciate them in lists and the schedule . Input a custom hexadecimal color code in the field. Click the button to use a nice color selector. You can set the default estimation for the step. Read the section about Production Planning for more information. For Shot Production steps, you can select if the estimation has to be evaluated per shot or on the duration, per second . You can set a different default estimation for shots or assets depending on the difficulty . Estimation is made in days . \u25b9 More details about Steps and Ramses . \u25b9 More details about estimations and planning . The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/client/users/","text":"User management This panel is used to list and manage all users of Ramses . List The list on the left lists all the users, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each user can be displayed. The folder button on the top right corner for each user in the list opens the user folder in your file explorer. Use the button to create a new user. The button removes the selected users from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new users. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected users. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Note The Ramses Daemon can\u2019t be removed: it is a default user needed by Ramses automations, but you can rename it if you wish. Warning The default Administrator user should be renamed and its password changed as soon as Ramses has been installed! Note With the default installation of Ramses , there\u2019s also an additionnal user: Nicolas \u201cDuduf\u201d Dufresne , who\u2019s the main developper of Ramses . This user is just a quick reminder that Ramses is free and that Duduf and RxLab really need your support . You can safely keep or remove it. Just. Donate. First. Please! Ramses relies only on your donations to exist. Edition Except for the password, there\u2019s no need to validate any change; changes are saved instantly. Name is the user\u2019s display name and can be changed any time (although it\u2019s not really advisable). ID is the unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed after the user folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the user. It is public. The Current role can never be changed by the user itself, and has to be changed by an administrator ( read this for more information about roles). To update your own password, input your Current password and repeat your New password twice. Don\u2019t forget to click the Change password button to validate! You can change any other user password, just set the New password twice and ignore the Current password field. Don\u2019t forget to click the Change password button to validate! You can change the folder where the user files are stored. Leave the field empty to set back the default folder inside the Ramses Tree . The red button moves the user\u2019s folder to a _trash subfolder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Passwords are stored encrypted in the Ramses Server and there\u2019s no way to retrieve them in case a user forgets it. In this case, an administrator has to set a new password for the user. \u25b9 More details about Users and Ramses . Note You cannot change your own role. Tip To change a user ID , you need to remove its folder. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Users"},{"location":"components/client/users/#user-management","text":"This panel is used to list and manage all users of Ramses .","title":"User management"},{"location":"components/client/users/#list","text":"The list on the left lists all the users, and you can use the Search field to filter them by name or ID . When changing the size of the rows in the list, more details about each user can be displayed. The folder button on the top right corner for each user in the list opens the user folder in your file explorer. Use the button to create a new user. The button removes the selected users from Ramses 1 . You can use the [Shift + A] shortcut key to quickly add new users. You can use the [DEL] or [Shift + X] shortcut key to quickly remove selected users. You can scroll all lists using [Middle click] as well as the [Mouse wheel] . Note The Ramses Daemon can\u2019t be removed: it is a default user needed by Ramses automations, but you can rename it if you wish. Warning The default Administrator user should be renamed and its password changed as soon as Ramses has been installed! Note With the default installation of Ramses , there\u2019s also an additionnal user: Nicolas \u201cDuduf\u201d Dufresne , who\u2019s the main developper of Ramses . This user is just a quick reminder that Ramses is free and that Duduf and RxLab really need your support . You can safely keep or remove it. Just. Donate. First. Please! Ramses relies only on your donations to exist.","title":"List"},{"location":"components/client/users/#edition","text":"Except for the password, there\u2019s no need to validate any change; changes are saved instantly. Name is the user\u2019s display name and can be changed any time (although it\u2019s not really advisable). ID is the unique identifier which is used in the files and folders (see Ramses Tree ). It can\u2019t be changed after the user folder has been created. Read the Ramses naming conventions to learn how IDs and names have to be formatted. Comment can be any text associated to the user. It is public. The Current role can never be changed by the user itself, and has to be changed by an administrator ( read this for more information about roles). To update your own password, input your Current password and repeat your New password twice. Don\u2019t forget to click the Change password button to validate! You can change any other user password, just set the New password twice and ignore the Current password field. Don\u2019t forget to click the Change password button to validate! You can change the folder where the user files are stored. Leave the field empty to set back the default folder inside the Ramses Tree . The red button moves the user\u2019s folder to a _trash subfolder. The blue button opens a folder selector to change the folder location. The green button opens the folder in your file explorer. Passwords are stored encrypted in the Ramses Server and there\u2019s no way to retrieve them in case a user forgets it. In this case, an administrator has to set a new password for the user. \u25b9 More details about Users and Ramses . Note You cannot change your own role. Tip To change a user ID , you need to remove its folder. The data is not actually deleted from the server nor the local data, but just flagged as removed. A server administrator can still restore the data at any time, but there is no way (yet) to do that from the user interface of the application. \u21a9","title":"Edition"},{"location":"components/files/","text":"The Ramses Tree Ramses is able to manage all the files associated with projects. To handle these, it uses a specific naming scheme which has been carefully crafted to be powerful (it contains all information Ramses needs to efficiently handle the files and folders), and easy to respect (it is simple to manually rename files and folders). Although one of the goal of Ramses is to enable you to work without ever having to use your system\u2019s file explorer but only Ramses tools, it is strongly advised to read this documentation about the naming conventions and folder structure to make sure all your files can be handled by Ramses . Every file and folder you create manually can be detected and managed by Ramses if it\u2019s correcly named and located. Read the Ramses naming conventions . Check out the Ramses Tree , the folder structure.","title":"Introduction"},{"location":"components/files/#the-ramses-tree","text":"Ramses is able to manage all the files associated with projects. To handle these, it uses a specific naming scheme which has been carefully crafted to be powerful (it contains all information Ramses needs to efficiently handle the files and folders), and easy to respect (it is simple to manually rename files and folders). Although one of the goal of Ramses is to enable you to work without ever having to use your system\u2019s file explorer but only Ramses tools, it is strongly advised to read this documentation about the naming conventions and folder structure to make sure all your files can be handled by Ramses . Every file and folder you create manually can be detected and managed by Ramses if it\u2019s correcly named and located. Read the Ramses naming conventions . Check out the Ramses Tree , the folder structure.","title":"The Ramses Tree"},{"location":"components/files/naming/","text":"File and folder naming scheme Ramses uses a strict and specific naming convention. This naming scheme is based on the ID s of the elements, which are defined by the administrator users in the Ramses Client . Extensibility We provide a set of regular expressions to help developpers manipulate this naming scheme. IDs (short names) In Ramses , all elements (users, assets, shots, projects\u2026) have two names: the actual name used in the user interface and displayed anywhere there is enough room, and an ID which is no longer than 10 characters (but which may be the same as the actual name). IDs are unique (while names may not be unique, although it\u2019s good practice to keep them unique too) and they are used as identifiers. While names can contain a lot of different characters, IDs can consist only of alphanumeric characters (without any special character or accent), and the minus - character. What How Where Name up to 256 characters in: [a-z] , [A-Z] , [0-9] , - , and space. Used in user interfaces where there is enough room. ID up to 10 characters in: [a-z] , [A-Z] , [0-9] , - . Used in file and folder names, and in user interfaces where there is limited room. Extensibility In the API , the IDs are called \u201cshort names\u201d. Naming scheme This is the complete naming scheme, for all files and folders: projectID_A|S|G(_assetID|shotID)_stepID(_resource name)(_stateVersion)(.extension) Explanations: The name is divided into blocks, separated by the underscore _ character. Optionnal blocks are shown in parenthesis () The vertical bar | characters means \u201cor\u201d and represents a choice in a list of possibilities. A file name must include at least 3 blocks : projectID , Type ( A , S or G ), and stepID and can include up to 6 blocks if adding the assetId or shotID , the resource name, and the version. Blocks projectID is the ID of the project. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. A|S|G tells if the file or folder refers to an Asset ( A ), a shot ( S ) or a general item ( G ). assetID is the ID of the asset, if the previous block is A . Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. shotID is the ID of the shot, if the previous block is S . Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. stepID is the ID of the production step. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. resource name describes the specific resource this file or folder refers to. Between 1 and 30 characters consisting only of a-z , 0-9 and - characters and may contain spaces. Resource names cannot start with a status ID followed by a number (e.g. v01 or wip2 ) nor a number alone. stateVersion contains the state and version number. The state is either the default v or the ID of the state (e.g. \u201cwip\u201d, \u201cok\u201d, etc.), and the version includes one or more numbers. No other character allowed. extension is the file extension. The extension may include multiple dots, for example: .tar.gz Examples TI_G_ADMIN_Budget estimation.xls TI_G_RIG_Template.blend TI_A_TRISTAN_RIG.blend TI_A_TRISTAN_RIG_WIP001.blend TI_A_TRISTAN_ANIM_walk cycle.blend TI_A_TRISTAN_ANIM_walk cycle_CHK011.blend Project media files Media files exported from the project have a specific naming scheme. projectID_codec(+colorspace)_widthxheight(p|i)_fps(_language)_(subtitlesst).ext Blocks projectID is the ID of the project. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. codec is the name of the codec. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. No dot allowed (e.g. h.264 must be named h264 ). colorspace represents the colorspace used if it\u2019s not the most common one for this codec. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. No dot allowed. Examples: YUV420 , sRGB , YUV444 , sRGBA , YUV420-REC709 \u2026 widthxheight is the resolution of the file. p|i tells if the video is interlaced or progressive. If omitted, the video is considered progressive. fps is the framerate. A number, which may contain a dot . character, and optionnaly the fps suffix. language is the spoken language. Omitted if there are no dialogs nor any written text. subtitlesst is the language code for the subtitles followed by the st suffix. Omitted if there are no subtitles. ext is the file extension. The extension may include multiple dots, for example: .tar.gz Examples TI_h264_1920x1080_24fps.mp4 TI_h264+YUV444-rec709_1920x1080p_24fps_fr_enst.mp4 TI_QtAnim+sRGB_1920x1080p_24fps_fr_enst.mp4","title":"Naming scheme"},{"location":"components/files/naming/#file-and-folder-naming-scheme","text":"Ramses uses a strict and specific naming convention. This naming scheme is based on the ID s of the elements, which are defined by the administrator users in the Ramses Client . Extensibility We provide a set of regular expressions to help developpers manipulate this naming scheme.","title":"File and folder naming scheme"},{"location":"components/files/naming/#ids-short-names","text":"In Ramses , all elements (users, assets, shots, projects\u2026) have two names: the actual name used in the user interface and displayed anywhere there is enough room, and an ID which is no longer than 10 characters (but which may be the same as the actual name). IDs are unique (while names may not be unique, although it\u2019s good practice to keep them unique too) and they are used as identifiers. While names can contain a lot of different characters, IDs can consist only of alphanumeric characters (without any special character or accent), and the minus - character. What How Where Name up to 256 characters in: [a-z] , [A-Z] , [0-9] , - , and space. Used in user interfaces where there is enough room. ID up to 10 characters in: [a-z] , [A-Z] , [0-9] , - . Used in file and folder names, and in user interfaces where there is limited room. Extensibility In the API , the IDs are called \u201cshort names\u201d.","title":"IDs (short names)"},{"location":"components/files/naming/#naming-scheme","text":"This is the complete naming scheme, for all files and folders: projectID_A|S|G(_assetID|shotID)_stepID(_resource name)(_stateVersion)(.extension) Explanations: The name is divided into blocks, separated by the underscore _ character. Optionnal blocks are shown in parenthesis () The vertical bar | characters means \u201cor\u201d and represents a choice in a list of possibilities. A file name must include at least 3 blocks : projectID , Type ( A , S or G ), and stepID and can include up to 6 blocks if adding the assetId or shotID , the resource name, and the version.","title":"Naming scheme"},{"location":"components/files/naming/#blocks","text":"projectID is the ID of the project. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. A|S|G tells if the file or folder refers to an Asset ( A ), a shot ( S ) or a general item ( G ). assetID is the ID of the asset, if the previous block is A . Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. shotID is the ID of the shot, if the previous block is S . Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. stepID is the ID of the production step. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. resource name describes the specific resource this file or folder refers to. Between 1 and 30 characters consisting only of a-z , 0-9 and - characters and may contain spaces. Resource names cannot start with a status ID followed by a number (e.g. v01 or wip2 ) nor a number alone. stateVersion contains the state and version number. The state is either the default v or the ID of the state (e.g. \u201cwip\u201d, \u201cok\u201d, etc.), and the version includes one or more numbers. No other character allowed. extension is the file extension. The extension may include multiple dots, for example: .tar.gz","title":"Blocks"},{"location":"components/files/naming/#examples","text":"TI_G_ADMIN_Budget estimation.xls TI_G_RIG_Template.blend TI_A_TRISTAN_RIG.blend TI_A_TRISTAN_RIG_WIP001.blend TI_A_TRISTAN_ANIM_walk cycle.blend TI_A_TRISTAN_ANIM_walk cycle_CHK011.blend","title":"Examples"},{"location":"components/files/naming/#project-media-files","text":"Media files exported from the project have a specific naming scheme. projectID_codec(+colorspace)_widthxheight(p|i)_fps(_language)_(subtitlesst).ext","title":"Project media files"},{"location":"components/files/naming/#blocks_1","text":"projectID is the ID of the project. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. codec is the name of the codec. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. No dot allowed (e.g. h.264 must be named h264 ). colorspace represents the colorspace used if it\u2019s not the most common one for this codec. Between 1 and 10 characters consisting only of a-z , 0-9 and - characters. No space allowed. No dot allowed. Examples: YUV420 , sRGB , YUV444 , sRGBA , YUV420-REC709 \u2026 widthxheight is the resolution of the file. p|i tells if the video is interlaced or progressive. If omitted, the video is considered progressive. fps is the framerate. A number, which may contain a dot . character, and optionnaly the fps suffix. language is the spoken language. Omitted if there are no dialogs nor any written text. subtitlesst is the language code for the subtitles followed by the st suffix. Omitted if there are no subtitles. ext is the file extension. The extension may include multiple dots, for example: .tar.gz","title":"Blocks"},{"location":"components/files/naming/#examples_1","text":"TI_h264_1920x1080_24fps.mp4 TI_h264+YUV444-rec709_1920x1080p_24fps_fr_enst.mp4 TI_QtAnim+sRGB_1920x1080p_24fps_fr_enst.mp4","title":"Examples"},{"location":"components/files/tree/","text":"Folder Structure: the Ramses Tree One of Ramses\u2019 goals is to manage all your files and folders; sometimes, you may still need to manually add, remove, or edit files and folders through your file explorer, in which case you should always try to respect the Ramses Tree described here. This document will also help you find your files should Ramses be unavailable for some reason. Introduction All folders inside the Ramses Tree follow the Ramses Naming Scheme . The folders used by Ramses can be located either locally or on remote computers and servers . The supported protocols ( SMB , FTP \u2026) may vary depending on the platform (read below for more information). Ramses includes a system of alternative trees , which means you can use different paths to folders used by Ramses, and that it is compatible with virtually all syncing applications (Dropbox, Syncthing, Synology\u2026), wether they are automatic or manual (like backup tools). If a specific file or folder is not found in the main tree , Ramses will automatically look for it in the alternative trees and try to sync (i.e. copy in the main tree ) them. Tip For best performance, it is advised to work with local files, and use remote locations only as alternative trees ; in conjunction with a syncing tool like Syncthing or the Synology Drive application for example, it is both easy, safe and powerful to keep a shared copy of the projects while working locally. Remote files on Windows Ramses should be able to access files located on remote locations using the Samba ( SMB ) protocol, using standard URL starting with \\\\server-name . Another way to access remote locations, which enables FTP and other protocols support, is to use Windows Network Drives to mount the remote locations. To make it easy to deploy Ramses on several devices, they should all use the same drive letter. Remote files on Unix-like Systems (Linux, Mac OS) The quickest and easiest way to use Ramses on remote folders on Unix-like systems is to automatically mount the remote locations in a specific folder. This can work for a lot of different protocols ( Samba , FTP(s) , SFTP , NFS \u2026) The Main Ramses Folder The easiest way to use Ramses to manage all your projects is to define a root folder for all Ramses projects, where Ramses will create a subfolder for each project. This Ramses folder is also used to store user specific files, some configuration files, etc. Nevertheless, you can always choose another folder to store a specific project, outside of the Ramses Folder. \u250c Ramses Folder \u2502 \u251c\u2500\u2500\u2500 Config # Configuration files \u2502 \u251c\u2500\u252c\u2500 Projects # All projects \u2502 \u251c\u2500\u2500\u2500 Project01 # First project \u2502 \u251c\u2500\u2500\u2500 Project02 # Second project \u2502 \u2514\u2500\u2500\u2500 ... \u2502 \u2514\u2500\u252c\u2500 Users # User files \u251c\u2500\u252c\u2500 User01 # Files for a single user \u2502 \u2514\u2500\u2500\u2500 Config # Configuration files for this user \u251c\u2500\u252c\u2500 User02 \u2502 \u2514\u2500\u2500\u2500 Config \u2514\u2500\u2500\u2500 ... Hint When using the Ramses Client , project folders can be located anywhere outside the Ramses Folder , it is not mandatory to keep them grouped together there. The Project Folder These are the contents of a Project folder: \u250c PROJECTID # Root \u251c\u2500\u2500\u2500 00-ADMIN # Project administration \u251c\u2500\u2500\u2500 01-PRE-PROD # Pre-production steps common files \u251c\u2500\u2500\u2500 02-PROD # Production steps common files \u251c\u2500\u2500\u2500 03-POST-PROD # Post-production steps common files \u251c\u2500\u2500\u2500 04-ASSETS # All the Assets \u251c\u2500\u2500\u2500 05-SHOTS # All the Shots \u2514\u2500\u2500\u2500 06-EXPORT # Media files The root folder of a project only contains other folders and no files. The subfolders in the root folder are numbered to help sorting them and quickly find them. Here is an example of a typical project tree, without showing the details in the working directories nor any file. \u250c PROJECTID # Root \u2502 \u251c\u2500\u2500\u2500 00-ADMIN \u2502 \u251c\u2500\u252c\u2500 01-PRE-PROD \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_SCRIPT # Pre production step \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_STORYBOARD \u2502 \u251c\u2500\u252c\u2500 02-PROD \u2502 \u251c\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the mod step \u2502 \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the mod step \u2502 \u2514\u2500\u252c\u2500 PROJECTID_G_RIG # Common files for the rig step \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the rig step \u2502 \u251c\u2500\u252c\u2500 03-POST-PROD \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_EDIT # Post production step \u2502 \u251c\u2500\u252c\u2500 04-ASSETS \u2502 \u251c\u2500\u252c\u2500 Characters # A Group of Assets \u2502 \u2502 \u251c\u2500\u252c\u2500 PROJECTID_A_TRISTAN # An Asset \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_DESIGN # An asset production step \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_RIG \u2502 \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_TEX \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_ISOLDE # An Asset \u2502 \u251c\u2500\u2500\u2500 Props # A Group of Assets \u2502 \u2514\u2500\u2500\u2500 Sets # A Group of Assets \u2502 \u251c\u2500\u252c\u2500 05-SHOTS \u2502 \u251c\u2500\u252c\u2500 PROJECTID_S_01-001 # A Shot \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_ANIM # A shot production step \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_LIGHT \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_01-001_COMP \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-002 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-003 # A Shot \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_02-001 # A Shot \u2502 \u2514\u2500\u2500\u2500 06-EXPORT A working folder A folder containing working files is always organised the same way. Here is an example for the modelling step of the asset called Tristan . \u250c PROJECTID_A_TRISTAN_MOD # The working folder, subfolder of the asset folder. \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The main file for modelling Tristan (on Blender) \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.blend # Another resource \u2502 \u251c\u2500\u252c\u2500 _versions # The versionning folder, handled by Ramses. \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_wip001.blend # A WIP version \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_wip002.blend \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_chk003.blend # The version which has to be reviewed \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_ok004.blend # The validated version \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_pub005.blend # The version which has been published \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt_v001.blend # The first version of a resource \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt_v002.blend # The second version of a resource \u2502 \u251c\u2500\u252c\u2500 _published \u2502 \u251c\u2500\u252c\u2500 001_WIP # The first published version \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The working file as it was when publishing \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.abc # The published export (an *Alembic* file) \u2502 \u2502 \u2502 \u251c\u2500\u252c\u2500 004_OK # The 4th version, which was published as ok \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The working file as it was when publishing \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.abc # The published export (an *Alembic* file) \u2502 \u2502 \u2502 \u2514\u2500\u252c\u2500 Sculpt_002_OK # The 2nd version of the \"Sculpt\" resource, which was published as ok \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.blend # The working file as it was when publishing \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.abc # The published export (an *Alembic* file) | \u2514\u2500\u252c\u2500 _preview \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.jpg # A file for previewing the modelling \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.mp4 # A file for previewing the modelling The _versions subfolder contains the versionning and history of the work. The _published subfolder contains the published and exported files to be used by other steps. The _preview subfolder contains the files for previewing the current work, like videos or images. These files may be used by Ramses to generate thumbnails. Ramses is also able to list, preview, and play these files (if their format is standard and supported). Warning The working file and published files do not include the version in their names, and the versionning and history are hidden in a _versions subfolder. This way, there can be no mistake about what file to open or import. Note Only Ramses should access the _versions subfolder and it should not be needed for the user to manipulate these files. Both the Ramses Client and Ramses Add-ons have a restore feature to retrieve previous versions. Tip When backuping a project, only the files in the published subfolder may be kept. Template folders Ramses can use template files to create new working files. You can use this feature with any application, even if there\u2019s no Ramses Add-on available for it (yet). The template files must be located in each step\u2019s Templates subfolder. As you can have multiple templates for a single step, each template must be located in its own subfolder, which itself must respect the working folder structure. Here is an example of a step folder and its templates: \u250c PROJECTID # Root \u2514\u2500\u252c\u2500 02-PROD \u2514\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the MOD step \u2514\u2500\u252c\u2500 Templates # Template files for the mod step \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template # A template \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Other # Another template A template folder should be organized the same way as any working folder . Typically, a template folder will look like this: \u250c PROJECTID_G_MOD_Template # The working folder for the template named \"Template\" \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The main template file \u2502 \u251c\u2500\u252c\u2500 _versions # The versionning folder \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template_wip001.blend \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template_wip002.blend \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template_ok003.blend \u2502 \u2514\u2500\u252c\u2500 _published \u251c\u2500\u252c\u2500 001_WIP # The first published version \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The working file as it was when publishing \u2502 \u2514\u2500\u252c\u2500 003_OK # The 3rd version, which was published as ok \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The working file as it was when publishing Note A template working folder may contain different resources, but even if they\u2019re published, Ramses will use only the main resource to create new files from templates and ignore other resources. Ramses special files and folders Ramses will also store some special files and folders it needs in the Ramses Tree . _trash Folder When Ramses needs to remove a file, it will automatically be moved in a _trash subfolder. If a file with the same name already exists in this _trash subfolder, it will be moved in the system trash so it\u2019s not overwritten. _ramses_data.json File Ramses may create a file named _ramses_data.json in any folder. This file is used to store some meta-data associated with the other files in the same folder. This file should stay small, and it should never be manually removed. *.ini Files Ramses stores its settings in files with the .ini extension. These are standard text files, and should remain only in folders named Config . If these files (or the Config folders) are removed, this re-initializes the corresponding settings in Ramses .","title":"Folder structure"},{"location":"components/files/tree/#folder-structure-the-ramses-tree","text":"One of Ramses\u2019 goals is to manage all your files and folders; sometimes, you may still need to manually add, remove, or edit files and folders through your file explorer, in which case you should always try to respect the Ramses Tree described here. This document will also help you find your files should Ramses be unavailable for some reason.","title":"Folder Structure: the Ramses Tree"},{"location":"components/files/tree/#introduction","text":"All folders inside the Ramses Tree follow the Ramses Naming Scheme . The folders used by Ramses can be located either locally or on remote computers and servers . The supported protocols ( SMB , FTP \u2026) may vary depending on the platform (read below for more information). Ramses includes a system of alternative trees , which means you can use different paths to folders used by Ramses, and that it is compatible with virtually all syncing applications (Dropbox, Syncthing, Synology\u2026), wether they are automatic or manual (like backup tools). If a specific file or folder is not found in the main tree , Ramses will automatically look for it in the alternative trees and try to sync (i.e. copy in the main tree ) them. Tip For best performance, it is advised to work with local files, and use remote locations only as alternative trees ; in conjunction with a syncing tool like Syncthing or the Synology Drive application for example, it is both easy, safe and powerful to keep a shared copy of the projects while working locally.","title":"Introduction"},{"location":"components/files/tree/#remote-files-on-windows","text":"Ramses should be able to access files located on remote locations using the Samba ( SMB ) protocol, using standard URL starting with \\\\server-name . Another way to access remote locations, which enables FTP and other protocols support, is to use Windows Network Drives to mount the remote locations. To make it easy to deploy Ramses on several devices, they should all use the same drive letter.","title":"Remote files on Windows"},{"location":"components/files/tree/#remote-files-on-unix-like-systems-linux-mac-os","text":"The quickest and easiest way to use Ramses on remote folders on Unix-like systems is to automatically mount the remote locations in a specific folder. This can work for a lot of different protocols ( Samba , FTP(s) , SFTP , NFS \u2026)","title":"Remote files on Unix-like Systems (Linux, Mac OS)"},{"location":"components/files/tree/#the-main-ramses-folder","text":"The easiest way to use Ramses to manage all your projects is to define a root folder for all Ramses projects, where Ramses will create a subfolder for each project. This Ramses folder is also used to store user specific files, some configuration files, etc. Nevertheless, you can always choose another folder to store a specific project, outside of the Ramses Folder. \u250c Ramses Folder \u2502 \u251c\u2500\u2500\u2500 Config # Configuration files \u2502 \u251c\u2500\u252c\u2500 Projects # All projects \u2502 \u251c\u2500\u2500\u2500 Project01 # First project \u2502 \u251c\u2500\u2500\u2500 Project02 # Second project \u2502 \u2514\u2500\u2500\u2500 ... \u2502 \u2514\u2500\u252c\u2500 Users # User files \u251c\u2500\u252c\u2500 User01 # Files for a single user \u2502 \u2514\u2500\u2500\u2500 Config # Configuration files for this user \u251c\u2500\u252c\u2500 User02 \u2502 \u2514\u2500\u2500\u2500 Config \u2514\u2500\u2500\u2500 ... Hint When using the Ramses Client , project folders can be located anywhere outside the Ramses Folder , it is not mandatory to keep them grouped together there.","title":"The Main Ramses Folder"},{"location":"components/files/tree/#the-project-folder","text":"These are the contents of a Project folder: \u250c PROJECTID # Root \u251c\u2500\u2500\u2500 00-ADMIN # Project administration \u251c\u2500\u2500\u2500 01-PRE-PROD # Pre-production steps common files \u251c\u2500\u2500\u2500 02-PROD # Production steps common files \u251c\u2500\u2500\u2500 03-POST-PROD # Post-production steps common files \u251c\u2500\u2500\u2500 04-ASSETS # All the Assets \u251c\u2500\u2500\u2500 05-SHOTS # All the Shots \u2514\u2500\u2500\u2500 06-EXPORT # Media files The root folder of a project only contains other folders and no files. The subfolders in the root folder are numbered to help sorting them and quickly find them. Here is an example of a typical project tree, without showing the details in the working directories nor any file. \u250c PROJECTID # Root \u2502 \u251c\u2500\u2500\u2500 00-ADMIN \u2502 \u251c\u2500\u252c\u2500 01-PRE-PROD \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_SCRIPT # Pre production step \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_STORYBOARD \u2502 \u251c\u2500\u252c\u2500 02-PROD \u2502 \u251c\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the mod step \u2502 \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the mod step \u2502 \u2514\u2500\u252c\u2500 PROJECTID_G_RIG # Common files for the rig step \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the rig step \u2502 \u251c\u2500\u252c\u2500 03-POST-PROD \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_EDIT # Post production step \u2502 \u251c\u2500\u252c\u2500 04-ASSETS \u2502 \u251c\u2500\u252c\u2500 Characters # A Group of Assets \u2502 \u2502 \u251c\u2500\u252c\u2500 PROJECTID_A_TRISTAN # An Asset \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_DESIGN # An asset production step \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD \u2502 \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_RIG \u2502 \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_TEX \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_ISOLDE # An Asset \u2502 \u251c\u2500\u2500\u2500 Props # A Group of Assets \u2502 \u2514\u2500\u2500\u2500 Sets # A Group of Assets \u2502 \u251c\u2500\u252c\u2500 05-SHOTS \u2502 \u251c\u2500\u252c\u2500 PROJECTID_S_01-001 # A Shot \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_ANIM # A shot production step \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_LIGHT \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_01-001_COMP \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-002 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-003 # A Shot \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_02-001 # A Shot \u2502 \u2514\u2500\u2500\u2500 06-EXPORT","title":"The Project Folder"},{"location":"components/files/tree/#a-working-folder","text":"A folder containing working files is always organised the same way. Here is an example for the modelling step of the asset called Tristan . \u250c PROJECTID_A_TRISTAN_MOD # The working folder, subfolder of the asset folder. \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The main file for modelling Tristan (on Blender) \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.blend # Another resource \u2502 \u251c\u2500\u252c\u2500 _versions # The versionning folder, handled by Ramses. \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_wip001.blend # A WIP version \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_wip002.blend \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_chk003.blend # The version which has to be reviewed \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_ok004.blend # The validated version \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_pub005.blend # The version which has been published \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt_v001.blend # The first version of a resource \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt_v002.blend # The second version of a resource \u2502 \u251c\u2500\u252c\u2500 _published \u2502 \u251c\u2500\u252c\u2500 001_WIP # The first published version \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The working file as it was when publishing \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.abc # The published export (an *Alembic* file) \u2502 \u2502 \u2502 \u251c\u2500\u252c\u2500 004_OK # The 4th version, which was published as ok \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.blend # The working file as it was when publishing \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.abc # The published export (an *Alembic* file) \u2502 \u2502 \u2502 \u2514\u2500\u252c\u2500 Sculpt_002_OK # The 2nd version of the \"Sculpt\" resource, which was published as ok \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.blend # The working file as it was when publishing \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD_Sculpt.abc # The published export (an *Alembic* file) | \u2514\u2500\u252c\u2500 _preview \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.jpg # A file for previewing the modelling \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD.mp4 # A file for previewing the modelling The _versions subfolder contains the versionning and history of the work. The _published subfolder contains the published and exported files to be used by other steps. The _preview subfolder contains the files for previewing the current work, like videos or images. These files may be used by Ramses to generate thumbnails. Ramses is also able to list, preview, and play these files (if their format is standard and supported). Warning The working file and published files do not include the version in their names, and the versionning and history are hidden in a _versions subfolder. This way, there can be no mistake about what file to open or import. Note Only Ramses should access the _versions subfolder and it should not be needed for the user to manipulate these files. Both the Ramses Client and Ramses Add-ons have a restore feature to retrieve previous versions. Tip When backuping a project, only the files in the published subfolder may be kept.","title":"A working folder"},{"location":"components/files/tree/#template-folders","text":"Ramses can use template files to create new working files. You can use this feature with any application, even if there\u2019s no Ramses Add-on available for it (yet). The template files must be located in each step\u2019s Templates subfolder. As you can have multiple templates for a single step, each template must be located in its own subfolder, which itself must respect the working folder structure. Here is an example of a step folder and its templates: \u250c PROJECTID # Root \u2514\u2500\u252c\u2500 02-PROD \u2514\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the MOD step \u2514\u2500\u252c\u2500 Templates # Template files for the mod step \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template # A template \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Other # Another template A template folder should be organized the same way as any working folder . Typically, a template folder will look like this: \u250c PROJECTID_G_MOD_Template # The working folder for the template named \"Template\" \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The main template file \u2502 \u251c\u2500\u252c\u2500 _versions # The versionning folder \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template_wip001.blend \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_MOD_Template_wip002.blend \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template_ok003.blend \u2502 \u2514\u2500\u252c\u2500 _published \u251c\u2500\u252c\u2500 001_WIP # The first published version \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The working file as it was when publishing \u2502 \u2514\u2500\u252c\u2500 003_OK # The 3rd version, which was published as ok \u2514\u2500\u2500\u2500 PROJECTID_G_MOD_Template.blend # The working file as it was when publishing Note A template working folder may contain different resources, but even if they\u2019re published, Ramses will use only the main resource to create new files from templates and ignore other resources.","title":"Template folders"},{"location":"components/files/tree/#ramses-special-files-and-folders","text":"Ramses will also store some special files and folders it needs in the Ramses Tree .","title":"Ramses special files and folders"},{"location":"components/files/tree/#_trash-folder","text":"When Ramses needs to remove a file, it will automatically be moved in a _trash subfolder. If a file with the same name already exists in this _trash subfolder, it will be moved in the system trash so it\u2019s not overwritten.","title":"_trash Folder"},{"location":"components/files/tree/#_ramses_datajson-file","text":"Ramses may create a file named _ramses_data.json in any folder. This file is used to store some meta-data associated with the other files in the same folder. This file should stay small, and it should never be manually removed.","title":"_ramses_data.json File"},{"location":"components/files/tree/#ini-files","text":"Ramses stores its settings in files with the .ini extension. These are standard text files, and should remain only in folders named Config . If these files (or the Config folders) are removed, this re-initializes the corresponding settings in Ramses .","title":"*.ini Files"},{"location":"components/server/","text":"The Ramses Server The server stores and serves all shared data to the Ramses Application between all workstations in the studio. The Ramses Applications installed on these workstations connect to it to sync the data they need. You can either install your own or rent a server managed by RxLaboratory (or any other provider you trust). It is just a small software meant to be installable on small hardware and with very low requirements. You can install it on any computer in the studio (even just a simple Raspberry ) and make it available on your Local Area Network , or make it available from the internet. You can also easily install it on a shared or private hosting, even a low-cost one. Requirements Required Software The Ramses Server must be installed on a computer with: An http(s) web server like Apache PHP 7 Optional Software An acces to a mySQL or MariaDB or any other compatible server and a dedicated database. Without such a database server, the Ramses Server can still be run correctly (it will use an SQLite database which doesn\u2019t need any particular server), but performance may be poor with too many different concurrent users. An SSL certificate. Although this is not mandatory, it is strongly recommended to always encrypt your connections to the server, especially if the server is publicly available on the internet. Recommended configuration The recommended configuration is a standard AMP stack ( Apache - mySQL - PHP ), with at least 2GB of RAM if the SQL server is on the same computer than the Apache server. The needed space for the Ramses Server files ( PHP ) is only 200 KB ! If you\u2019re not using a mySQL database, you\u2019ll need more space to store the data directly with the server files. How much space depends on the size of the projects you\u2019ll work on, but it will never be huge. 100 MB should be more than enough in most cases. If you\u2019re using a mySQL database, 100 MB should be more than enough for the vast majority of users. Technical description The Ramses Server is a pretty standard REST API written in PHP which just serves as an interface to an SQL database. It receives requests from the Ramses Client and responds with the needed data. For developers who may want to extend or modify Ramses , or develop their own client, the complete reference of this API is available here .","title":"Introduction"},{"location":"components/server/#the-ramses-server","text":"The server stores and serves all shared data to the Ramses Application between all workstations in the studio. The Ramses Applications installed on these workstations connect to it to sync the data they need. You can either install your own or rent a server managed by RxLaboratory (or any other provider you trust). It is just a small software meant to be installable on small hardware and with very low requirements. You can install it on any computer in the studio (even just a simple Raspberry ) and make it available on your Local Area Network , or make it available from the internet. You can also easily install it on a shared or private hosting, even a low-cost one.","title":"The Ramses Server"},{"location":"components/server/#requirements","text":"","title":"Requirements"},{"location":"components/server/#required-software","text":"The Ramses Server must be installed on a computer with: An http(s) web server like Apache PHP 7","title":"Required Software"},{"location":"components/server/#optional-software","text":"An acces to a mySQL or MariaDB or any other compatible server and a dedicated database. Without such a database server, the Ramses Server can still be run correctly (it will use an SQLite database which doesn\u2019t need any particular server), but performance may be poor with too many different concurrent users. An SSL certificate. Although this is not mandatory, it is strongly recommended to always encrypt your connections to the server, especially if the server is publicly available on the internet.","title":"Optional Software"},{"location":"components/server/#recommended-configuration","text":"The recommended configuration is a standard AMP stack ( Apache - mySQL - PHP ), with at least 2GB of RAM if the SQL server is on the same computer than the Apache server. The needed space for the Ramses Server files ( PHP ) is only 200 KB ! If you\u2019re not using a mySQL database, you\u2019ll need more space to store the data directly with the server files. How much space depends on the size of the projects you\u2019ll work on, but it will never be huge. 100 MB should be more than enough in most cases. If you\u2019re using a mySQL database, 100 MB should be more than enough for the vast majority of users.","title":"Recommended configuration"},{"location":"components/server/#technical-description","text":"The Ramses Server is a pretty standard REST API written in PHP which just serves as an interface to an SQL database. It receives requests from the Ramses Client and responds with the needed data. For developers who may want to extend or modify Ramses , or develop their own client, the complete reference of this API is available here .","title":"Technical description"},{"location":"components/server/admin/","text":"Warning Ramses is still under active development , and this documentation is still being written. This specific page of the documentation still has to be written, sorry!","title":"Administration"},{"location":"components/server/config/","text":"Server configuration The server can and must be configured by editing these two files: config/config.php and config/config_logs.php . config.php The config.php file contains the main configuration and should look like that: <?php /* Ramses: Rx Asset Management System This program is licensed under the GNU General Public License. Copyright (C) 20202-2021 Nicolas Dufresne and Contributors. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the *GNU General Public License* along with this program. If not, see http://www.gnu.org/licenses/. */ // Edit this configuration file before running the install script at /install/index.php // === DEV MODE & DEBUG Info === // Activates printing the SQL & PHP errors. // For security reasons, it is important to set this to false in production mode $devMode = false; // Sets the minimum level of the logs in the server replies sent to the clients // One of: 'DATA', 'DEBUG', 'INFO', 'WARNING', 'CRITICAL', 'FATAL' $logLevel = 'WARNING'; // ==== SQL SETTINGS ==== // either 'mysql' (works for MariaDB too) or 'sqlite' $sqlMode = 'sqlite'; // Table prefix // should be a random character string (use https://duckduckgo.com/?q=generate+password) // you can setup multiple instances on the same DB // if each use a different prefix $tablePrefix = \"5H3VBzSY\"; // ==== MySQL/MariaDB SETTINGS ==== // Host URL $sqlHost = \"db\"; $sqlPort = 3306; // Database name $sqlDBName = \"ramses\"; // User $sqlUser = \"ramses\"; // Password $sqlpassword = \"password\"; // ==== SESSION & SECURITY SETTINGS ==== // This must be the server public adress, exactly as used in the clients $serverAddress = \"localhost/ramses\"; // Whether to accept only SSL connections // This should always be true, except maybe on dev environments. $forceSSL = true; // Session timeout (seconds) // The client will be disconnected after being idle for this time // 30 minutes by default (1800) are more than enough: // The official client makes a call at least every 2 minutes by default. // A negative value completely deactivates the timeout check. $sessionTimeout = 1800; // Max Session timeout (seconds) // The client will be disconnected no matter what after this time // 12 hours by default( 43200 ) $cookieTimeout = 43200; // This should never be changed, unless you change the key before building the official client or implementing your own client. // It is used to break compatibility between some updates of the client/server framework // It can be used to make sure only your own client, built by yourself, can connect to your own server. In this case, keep it secret! // It is used to hash passwords. $clientKey = \"drHSV2XQ\"; ?> $devMode should always be false unless this server is going to be used for development and tests in a development environement. For security reasons do not set this to true on a production server. $logLevel controls the quantity of logs included in the server replies and displayed by Ramses Applications . This is independant from the logs saved on the server configured by the config/config_logs.php file. $sqlMode can be either 'sqlite' or 'mysql' depending on your choice of configuration (read above). $tablePrefix is a prefix which will be used for the name of the database tables used by Ramses . It allows you to share a database with other instances of Ramses and even any other application (for example if your provider doesn\u2019t allow you to create more databases on your server). These next options are only used in MySQL mode. Ignore them when using SQLite . $sqlHost is the host name or IP of your MySQL server. Don\u2019t forget the quotes! $sqlPort is the port used by the MySQL server. 3306 is the default for most installations, if you need something different, your hosting provider should tell you. $sqlDBName is the name of the specific database you have to create for Ramses . $sqlUser is the name of the specific MySQL user you have to create for Ramses . $sqlpassword is the password of the specific MySQL user you have to create for Ramses . Note When using the MySQL Docker folder, do not change the sqlHost value, unless you\u2019ve changed the settings in the docker_compose.yml file. And finally complete these settings too: $serverAddress must be the one and only address used by the Ramses Applications to connect to this server. If this is incorrectly set, Ramses Applications won\u2019t be able to connect to this server. $forceSSL will always redirect calls to https when set to true . Set this to false if you don\u2019t have any SSL certificate on this server (not recommended). $sessionTimeout is the time, in seconds, before an idle client is disconnected. $cookieTimeout is the time, in seconds, before a client is disconnected, no matter what. $clientKey can be changed only if your client is not the official open source Ramses Client Application . Otherwise, leave it to the default value. It is a way to make sure only your client can connect to the server. It is currently used only when setting up the first user (administrator) during the server installation. config_logs.php Ramses can log what happens on the server. This can be useful for debugging or to diagnose issues on the server. By default, all logs are deactivated. Logs are stored by date in the logs subfolder inside the ramses server folder. Connection logs and debug logs are stored as CSV files (one per day), request logs are text and json files (one subfolder per request). This is the configuration for the logs: <?php /* Ramses: Rx Asset Management System This program is licensed under the GNU General Public License. Copyright (C) 20202-2021 Nicolas Dufresne and Contributors. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the *GNU General Public License* along with this program. If not, see http://www.gnu.org/licenses/. */ // Edit this configuration file to adjust server logging // === GLOBALLY ENABLE LOGS === $enableLogs = false; // Connexion logs $connexionLogs = false; // Requests logs $requestLogs = false; // Debug logs $debugLogs = false; // How long do we keep logs? (days) $logsExpiration = 2; ?> $enableLogs : set this to true or false to globally enable logs. $connexionLogs : when true , ramses will log all connections and disconnections to and from the server. $requestLogs : when true , ramses will log requests received by the server including: the request headers, body, and some metadata. The details of the request headers may change according to the web server you\u2019re using and its version. $debugLogs : when true , ramses will log some extra information coming with each request. $logsExpiration sets how many days the logs will be kept. Keep this value small if there\u2019s a lot of activity on your server to avoid quickly growing the log size.","title":"Configuration"},{"location":"components/server/config/#server-configuration","text":"The server can and must be configured by editing these two files: config/config.php and config/config_logs.php .","title":"Server configuration"},{"location":"components/server/config/#configphp","text":"The config.php file contains the main configuration and should look like that: <?php /* Ramses: Rx Asset Management System This program is licensed under the GNU General Public License. Copyright (C) 20202-2021 Nicolas Dufresne and Contributors. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the *GNU General Public License* along with this program. If not, see http://www.gnu.org/licenses/. */ // Edit this configuration file before running the install script at /install/index.php // === DEV MODE & DEBUG Info === // Activates printing the SQL & PHP errors. // For security reasons, it is important to set this to false in production mode $devMode = false; // Sets the minimum level of the logs in the server replies sent to the clients // One of: 'DATA', 'DEBUG', 'INFO', 'WARNING', 'CRITICAL', 'FATAL' $logLevel = 'WARNING'; // ==== SQL SETTINGS ==== // either 'mysql' (works for MariaDB too) or 'sqlite' $sqlMode = 'sqlite'; // Table prefix // should be a random character string (use https://duckduckgo.com/?q=generate+password) // you can setup multiple instances on the same DB // if each use a different prefix $tablePrefix = \"5H3VBzSY\"; // ==== MySQL/MariaDB SETTINGS ==== // Host URL $sqlHost = \"db\"; $sqlPort = 3306; // Database name $sqlDBName = \"ramses\"; // User $sqlUser = \"ramses\"; // Password $sqlpassword = \"password\"; // ==== SESSION & SECURITY SETTINGS ==== // This must be the server public adress, exactly as used in the clients $serverAddress = \"localhost/ramses\"; // Whether to accept only SSL connections // This should always be true, except maybe on dev environments. $forceSSL = true; // Session timeout (seconds) // The client will be disconnected after being idle for this time // 30 minutes by default (1800) are more than enough: // The official client makes a call at least every 2 minutes by default. // A negative value completely deactivates the timeout check. $sessionTimeout = 1800; // Max Session timeout (seconds) // The client will be disconnected no matter what after this time // 12 hours by default( 43200 ) $cookieTimeout = 43200; // This should never be changed, unless you change the key before building the official client or implementing your own client. // It is used to break compatibility between some updates of the client/server framework // It can be used to make sure only your own client, built by yourself, can connect to your own server. In this case, keep it secret! // It is used to hash passwords. $clientKey = \"drHSV2XQ\"; ?> $devMode should always be false unless this server is going to be used for development and tests in a development environement. For security reasons do not set this to true on a production server. $logLevel controls the quantity of logs included in the server replies and displayed by Ramses Applications . This is independant from the logs saved on the server configured by the config/config_logs.php file. $sqlMode can be either 'sqlite' or 'mysql' depending on your choice of configuration (read above). $tablePrefix is a prefix which will be used for the name of the database tables used by Ramses . It allows you to share a database with other instances of Ramses and even any other application (for example if your provider doesn\u2019t allow you to create more databases on your server). These next options are only used in MySQL mode. Ignore them when using SQLite . $sqlHost is the host name or IP of your MySQL server. Don\u2019t forget the quotes! $sqlPort is the port used by the MySQL server. 3306 is the default for most installations, if you need something different, your hosting provider should tell you. $sqlDBName is the name of the specific database you have to create for Ramses . $sqlUser is the name of the specific MySQL user you have to create for Ramses . $sqlpassword is the password of the specific MySQL user you have to create for Ramses . Note When using the MySQL Docker folder, do not change the sqlHost value, unless you\u2019ve changed the settings in the docker_compose.yml file. And finally complete these settings too: $serverAddress must be the one and only address used by the Ramses Applications to connect to this server. If this is incorrectly set, Ramses Applications won\u2019t be able to connect to this server. $forceSSL will always redirect calls to https when set to true . Set this to false if you don\u2019t have any SSL certificate on this server (not recommended). $sessionTimeout is the time, in seconds, before an idle client is disconnected. $cookieTimeout is the time, in seconds, before a client is disconnected, no matter what. $clientKey can be changed only if your client is not the official open source Ramses Client Application . Otherwise, leave it to the default value. It is a way to make sure only your client can connect to the server. It is currently used only when setting up the first user (administrator) during the server installation.","title":"config.php"},{"location":"components/server/config/#config_logsphp","text":"Ramses can log what happens on the server. This can be useful for debugging or to diagnose issues on the server. By default, all logs are deactivated. Logs are stored by date in the logs subfolder inside the ramses server folder. Connection logs and debug logs are stored as CSV files (one per day), request logs are text and json files (one subfolder per request). This is the configuration for the logs: <?php /* Ramses: Rx Asset Management System This program is licensed under the GNU General Public License. Copyright (C) 20202-2021 Nicolas Dufresne and Contributors. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the *GNU General Public License* along with this program. If not, see http://www.gnu.org/licenses/. */ // Edit this configuration file to adjust server logging // === GLOBALLY ENABLE LOGS === $enableLogs = false; // Connexion logs $connexionLogs = false; // Requests logs $requestLogs = false; // Debug logs $debugLogs = false; // How long do we keep logs? (days) $logsExpiration = 2; ?> $enableLogs : set this to true or false to globally enable logs. $connexionLogs : when true , ramses will log all connections and disconnections to and from the server. $requestLogs : when true , ramses will log requests received by the server including: the request headers, body, and some metadata. The details of the request headers may change according to the web server you\u2019re using and its version. $debugLogs : when true , ramses will log some extra information coming with each request. $logsExpiration sets how many days the logs will be kept. Keep this value small if there\u2019s a lot of activity on your server to avoid quickly growing the log size.","title":"config_logs.php"},{"location":"components/server/install-docker-mysql/","text":"Docker install (MySQL) Use the Docker MySQL folder for a quick and easy setup of the Ramses Server . Un-Zip the ramses-server_docker-mysql archive you\u2019ve downloaded. On Linux , you may need to adjust permissions to the unzipped folder to make sure Docker has write access in there. Set passwords for the database. You may skip this step in development environments, but they must be set in production. Set the $sqlpassword variable in www/config/config.php . Set the same password for the MYSQL_PASSWORD variable in docker-compose.yml . Set a new password for the MYSQL_ROOT_PASSWORD variable in docker-compose.yml . Replace password and rootpassword in the db/init.sql file with the new passwords you\u2019ve chosen. Go inside the docker folder and use the command docker compose up . Go to http://localhost:8001/ramses/install . Delete the install folder from the docker folder. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database! Customize the Docker container There are some settings you may find useful to adjust in the provided docker-compose.yml file before you run your container. Default www port By default, the Docker Ramses Server is set to use the 8001 port. It may be easier to use the default 80 port. Default MySQL port By default, the Docker Ramses Server is set to use the usual 3306 port. You can adjust this port to avoid conflicts on the server running the container. This is also true for PHPMyAdmin which exposes the 8000 port by default in this configuration. Secured connection (SSL) In production, it is recommended to add an SSL certificate to the Ramses Server and set $forceSSL = true; in the Ramses Server config/config.php file. In this case, you can add this port mapping to the www service: - \"XXX:443\" Change XXX by the port you want to expose, which should be 443 by default. Access the MySQL Data A PHPMyAdmin container is included to help you access and manage the database. Go to http://localhost:8000 to access it, and user either the ramses user and its password to access the ramses database, or the admin user and its rootpassword to manage the whole database.","title":"Docker (MySQL)"},{"location":"components/server/install-docker-mysql/#docker-install-mysql","text":"Use the Docker MySQL folder for a quick and easy setup of the Ramses Server . Un-Zip the ramses-server_docker-mysql archive you\u2019ve downloaded. On Linux , you may need to adjust permissions to the unzipped folder to make sure Docker has write access in there. Set passwords for the database. You may skip this step in development environments, but they must be set in production. Set the $sqlpassword variable in www/config/config.php . Set the same password for the MYSQL_PASSWORD variable in docker-compose.yml . Set a new password for the MYSQL_ROOT_PASSWORD variable in docker-compose.yml . Replace password and rootpassword in the db/init.sql file with the new passwords you\u2019ve chosen. Go inside the docker folder and use the command docker compose up . Go to http://localhost:8001/ramses/install . Delete the install folder from the docker folder. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database!","title":"Docker install (MySQL)"},{"location":"components/server/install-docker-mysql/#customize-the-docker-container","text":"There are some settings you may find useful to adjust in the provided docker-compose.yml file before you run your container.","title":"Customize the Docker container"},{"location":"components/server/install-docker-mysql/#default-www-port","text":"By default, the Docker Ramses Server is set to use the 8001 port. It may be easier to use the default 80 port.","title":"Default www port"},{"location":"components/server/install-docker-mysql/#default-mysql-port","text":"By default, the Docker Ramses Server is set to use the usual 3306 port. You can adjust this port to avoid conflicts on the server running the container. This is also true for PHPMyAdmin which exposes the 8000 port by default in this configuration.","title":"Default MySQL port"},{"location":"components/server/install-docker-mysql/#secured-connection-ssl","text":"In production, it is recommended to add an SSL certificate to the Ramses Server and set $forceSSL = true; in the Ramses Server config/config.php file. In this case, you can add this port mapping to the www service: - \"XXX:443\" Change XXX by the port you want to expose, which should be 443 by default.","title":"Secured connection (SSL)"},{"location":"components/server/install-docker-mysql/#access-the-mysql-data","text":"A PHPMyAdmin container is included to help you access and manage the database. Go to http://localhost:8000 to access it, and user either the ramses user and its password to access the ramses database, or the admin user and its rootpassword to manage the whole database.","title":"Access the MySQL Data"},{"location":"components/server/install-docker-sqlite/","text":"Docker install (SQLite) Use the Docker SQLite folder for a quick and easy setup of the Ramses Server . This is the recommended way of using the Ramses Server in a development environement. Un-Zip the ramses-server_docker-sqlite archive you\u2019ve downloaded. On Linux , you may need to adjust permissions to the unzipped folder to make sure Docker has write access in there. Go inside the docker folder and use the command docker compose up . Go to http://localhost:8001/ramses/install . Delete the install folder from the docker folder. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database! Customize the Docker container There are some settings you may find useful to adjust in the provided docker-compose.yml file before you run your container. Default port By default, the Docker Ramses Server is set to use the 8001 port. It may be easier to use the default 80 port. Secured connection (SSL) In production, it is recommended to add an SSL certificate to the Ramses Server and set $forceSSL = true; in the Ramses Server config/config.php file. In this case, you can add this port mapping to the www service: - \"XXX:443\" Change XXX by the port you want to expose, which should be 443 by default.","title":"Docker (SQLite)"},{"location":"components/server/install-docker-sqlite/#docker-install-sqlite","text":"Use the Docker SQLite folder for a quick and easy setup of the Ramses Server . This is the recommended way of using the Ramses Server in a development environement. Un-Zip the ramses-server_docker-sqlite archive you\u2019ve downloaded. On Linux , you may need to adjust permissions to the unzipped folder to make sure Docker has write access in there. Go inside the docker folder and use the command docker compose up . Go to http://localhost:8001/ramses/install . Delete the install folder from the docker folder. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database!","title":"Docker install (SQLite)"},{"location":"components/server/install-docker-sqlite/#customize-the-docker-container","text":"There are some settings you may find useful to adjust in the provided docker-compose.yml file before you run your container.","title":"Customize the Docker container"},{"location":"components/server/install-docker-sqlite/#default-port","text":"By default, the Docker Ramses Server is set to use the 8001 port. It may be easier to use the default 80 port.","title":"Default port"},{"location":"components/server/install-docker-sqlite/#secured-connection-ssl","text":"In production, it is recommended to add an SSL certificate to the Ramses Server and set $forceSSL = true; in the Ramses Server config/config.php file. In this case, you can add this port mapping to the www service: - \"XXX:443\" Change XXX by the port you want to expose, which should be 443 by default.","title":"Secured connection (SSL)"},{"location":"components/server/install-src/","text":"Install from source Installing from source is the easiest way to install the ramses server on any host, including shared hosting. ( MySQL only) Create a new base on your SQL server, along with its user and password. Un-Zip the Ramses Server you\u2019ve downloaded. Edit config/config.php with all needed info. Copy the Ramses Server files to the web server (you can just copy the ramses folder from the ZIP archive). Go to http://your.server/ramses/install . Delete the install folder from the server. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database!","title":"Install from source"},{"location":"components/server/install-src/#install-from-source","text":"Installing from source is the easiest way to install the ramses server on any host, including shared hosting. ( MySQL only) Create a new base on your SQL server, along with its user and password. Un-Zip the Ramses Server you\u2019ve downloaded. Edit config/config.php with all needed info. Copy the Ramses Server files to the web server (you can just copy the ramses folder from the ZIP archive). Go to http://your.server/ramses/install . Delete the install folder from the server. The default user for Ramses is Admin with the password password . You should start by changing this name and password using the Ramses Client Application . Warning It is important to delete the install folder as soon as the server\u2019s been installed, to prevent anyone to run the install script again. When the install script is run, it wipes all existing data from the server\u2019s database!","title":"Install from source"},{"location":"components/server/install/","text":"Ramses Server installation Ramses Server runs on very standard web servers, with the usual Web Server / PHP / mySQL stack. That means you can install it on almost any desktop or server computers, private server, shared hosting, workstation, Raspberry\u2026 It doesn\u2019t need much resources. Warning The procedure to install and to update Ramses differ a bit. Do not follow the installation procedure to update your server, as it will wipe all your data! It is also a good habit to always backup the data before updating. Prerequisites Ramses Server must be installed on a computer with: An http web server like Apache PHP 7 Optionally , an acces to a mySQL server and a dedicated database. An SSL certificate. Although this is not mandatory, it is strongly recommended to always encrypt your connections to the server, especially if the server is publicly available on the internet. The recommended configuration is a standard AMP stack ( Apache - mySQL - PHP ), with at least 2GB of RAM if the SQL server is on the same computer than the Apache server. This can easily be automated using Docker if you already have it installed. We provide a ready-to-use Docker folder to help you quickly install and run the server. Installation You first have to decide what type of database the Ramses Server will be using. There are two options: MySQL or any other compatible server like MariaDB . Use this if there will be a lot of users connected simultaneously to Ramses , and if you already know how to configure an SQL database (or you\u2019re ready to learn). SQLite is a simpler database, self-contained in a single file handled by the Ramses Server . Use this if there will be just a few users connected simultaneously to Ramses , or if you want a server easier to setup and backup. Once you\u2019ve made your choice, follow these guides according to your environement: \u25b9 Install from source \u25b9 Docker (MySQL) \u25b9 Docker (SQLite) You can adjust the server configuration by editing config/config.php and config/config_logs.php .","title":"Installation"},{"location":"components/server/install/#ramses-server-installation","text":"Ramses Server runs on very standard web servers, with the usual Web Server / PHP / mySQL stack. That means you can install it on almost any desktop or server computers, private server, shared hosting, workstation, Raspberry\u2026 It doesn\u2019t need much resources. Warning The procedure to install and to update Ramses differ a bit. Do not follow the installation procedure to update your server, as it will wipe all your data! It is also a good habit to always backup the data before updating.","title":"Ramses Server installation"},{"location":"components/server/install/#prerequisites","text":"Ramses Server must be installed on a computer with: An http web server like Apache PHP 7 Optionally , an acces to a mySQL server and a dedicated database. An SSL certificate. Although this is not mandatory, it is strongly recommended to always encrypt your connections to the server, especially if the server is publicly available on the internet. The recommended configuration is a standard AMP stack ( Apache - mySQL - PHP ), with at least 2GB of RAM if the SQL server is on the same computer than the Apache server. This can easily be automated using Docker if you already have it installed. We provide a ready-to-use Docker folder to help you quickly install and run the server.","title":"Prerequisites"},{"location":"components/server/install/#installation","text":"You first have to decide what type of database the Ramses Server will be using. There are two options: MySQL or any other compatible server like MariaDB . Use this if there will be a lot of users connected simultaneously to Ramses , and if you already know how to configure an SQL database (or you\u2019re ready to learn). SQLite is a simpler database, self-contained in a single file handled by the Ramses Server . Use this if there will be just a few users connected simultaneously to Ramses , or if you want a server easier to setup and backup. Once you\u2019ve made your choice, follow these guides according to your environement: \u25b9 Install from source \u25b9 Docker (MySQL) \u25b9 Docker (SQLite) You can adjust the server configuration by editing config/config.php and config/config_logs.php .","title":"Installation"},{"location":"components/server/update/","text":"Ramses Server update Before updating, it is always a good habit to backup your data! Backup the server files (php) : download them or move them to another folder. If you\u2019re using SQLite , the database is included in these files, it is the data/ramses_data file. Backup the data if you\u2019re using a MySQL server . Use phpMyAdmin to export the database, or any backup provided by your web hosting provider. Keep a copy of of the config folder in a safe place! If you lose the information from these files, you\u2019ll permanently lose access to part or all of your data, and nobody will ever be able to retrieve it. But be careful, if anyone gets access to them, they will be able to access and decrypt your data without you knowing it. With this copy of your server, you\u2019ll be able to easily retrieve your data or revert to the previous version if anything goes wrong. The safe update procedure is as follow: Un-Zip the Ramses Server you\u2019ve downloaded. Download the current config folder from your server and keep it safe. Update the new version of config/config.php with the same information from the one you\u2019ve just retrieved. Update the new version of config/config_logs.php with the same information from the one you\u2019ve just retrieved. Upload all files and folders from the update package to your server, except the folder named install . Note In the future, when Ramses won\u2019t be in a test version anymore, there should be an automatic update procedure.","title":"Update"},{"location":"components/server/update/#ramses-server-update","text":"Before updating, it is always a good habit to backup your data! Backup the server files (php) : download them or move them to another folder. If you\u2019re using SQLite , the database is included in these files, it is the data/ramses_data file. Backup the data if you\u2019re using a MySQL server . Use phpMyAdmin to export the database, or any backup provided by your web hosting provider. Keep a copy of of the config folder in a safe place! If you lose the information from these files, you\u2019ll permanently lose access to part or all of your data, and nobody will ever be able to retrieve it. But be careful, if anyone gets access to them, they will be able to access and decrypt your data without you knowing it. With this copy of your server, you\u2019ll be able to easily retrieve your data or revert to the previous version if anything goes wrong. The safe update procedure is as follow: Un-Zip the Ramses Server you\u2019ve downloaded. Download the current config folder from your server and keep it safe. Update the new version of config/config.php with the same information from the one you\u2019ve just retrieved. Update the new version of config/config_logs.php with the same information from the one you\u2019ve just retrieved. Upload all files and folders from the update package to your server, except the folder named install . Note In the future, when Ramses won\u2019t be in a test version anymore, there should be an automatic update procedure.","title":"Ramses Server update"},{"location":"dev/","text":"Developping and extending Ramses Warning Ramses is still under active development , and this documentation is still being written. This specific page of the documentation is just a draft, sorry! Ramses already includes a few different APIs to allow for different levels of extensibility, and don\u2019t forget, Ramses is free and open source, you can modify it according to your needs, and you can also contribute ;) Extending Ramses Several levels: Add-Ons extensibility Using: The Ramses Scripting API The Daemon API Client extensibility Using the Server API Add-ons Extending a provided Add-On Adobe After Effects Autodesk Maya Blender Inkscape Krita Developping a new Add-On using the Ramses Scripting API Python Adobe ExtendScript Other languages: building a new API using the Daemon API Client Application Using Triggers and scripts with the provided client Windows 64 bits MacOS Linux amd64 Compiling the existing client for a new platform Building a new client using the Server API Contributing and developping Ramses WIP","title":"Introduction"},{"location":"dev/#developping-and-extending-ramses","text":"Warning Ramses is still under active development , and this documentation is still being written. This specific page of the documentation is just a draft, sorry! Ramses already includes a few different APIs to allow for different levels of extensibility, and don\u2019t forget, Ramses is free and open source, you can modify it according to your needs, and you can also contribute ;)","title":"Developping and extending Ramses"},{"location":"dev/#extending-ramses","text":"Several levels: Add-Ons extensibility Using: The Ramses Scripting API The Daemon API Client extensibility Using the Server API","title":"Extending Ramses"},{"location":"dev/#add-ons","text":"Extending a provided Add-On Adobe After Effects Autodesk Maya Blender Inkscape Krita Developping a new Add-On using the Ramses Scripting API Python Adobe ExtendScript Other languages: building a new API using the Daemon API","title":"Add-ons"},{"location":"dev/#client-application","text":"Using Triggers and scripts with the provided client Windows 64 bits MacOS Linux amd64 Compiling the existing client for a new platform Building a new client using the Server API","title":"Client Application"},{"location":"dev/#contributing-and-developping-ramses","text":"WIP","title":"Contributing and developping Ramses"},{"location":"dev/objects/","text":"Objects and data In Ramses, everything is represented by Objects . An object consists of a Unique Universal Identifier (UUID) used to identify it across the whole system, and its associated data , encoded as a JSON Object . The whole object could thus be saved and shared as a JSON Document like this: { \"uuid\": \"unique-uid\", \"data\": { // Here's the data } } An object may also be associated with some paths in the file system. These paths are dynamic and are not included in the associated data . They have to be queried or defined by the software. Ramses Objects (i.e. RamObjects ) can represent a shot, an asset, a user, an application, or a whole project for example. They can also contain lists of other objects. Lists of objects are basic string lists of UUIDs stored in the parent object data. UUIDs and object data are synced by all the Ramses Applications and a Ramses Server , and are mirrored on all workstations and the server itself. Any other software (e.g. APIs , scripts, plugins\u2026) should get the list of objects and all data using the Ramses Daemon run by the Ramses Application which is guaranteed to be up-to-date. You can also use the Daemon to set new data to specific objects. Virtual objects RamObject All objects derive from the RamObject and have at least the same properties. Note Some optional properties may be missing in the JSON data as shared by Ramses . In this case, it\u2019s up to the software to decide of a default value. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", // Colors are Hexadecimal numbers with a leading # \"settings\": { // The settings object can contain additional arbitrary values, // depending on the object // these values can be set by any software / API } } RamObjectList A list of other objects. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"list\": [ \"uuid1\", \"uuid2\", \"...\" ] } Objects RamApplication An application used in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"executableFilePath\": \"path/to/the/application/bin.exe\", \"nativeFileTypes\": \"RamFileType_list-uuid\", \"importFileTypes\": \"RamFileType_list-uuid\", \"exportFileTypes\": \"RamFileType_list-uuid\", } RamAsset An asset used in one or several shots. The RamAsset is derived from the RamItem and has all its properties. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"\", // Should be the same as the containing asset group \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" }, \"assetGroup\": \"RamAssetGroup-uuid\", \"tags\": [ \"tag1\", \"tag2\", \"...\" ] } RamAssetGroup A group of assets. All assets should be assigned to one and only one group. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\" } RamFileType A type of file. { \"shortName\": \"abc\", // Should be the default file extension \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"extensions\": [ \"abc\", \"def\", \"etc\" ], \"previewable\": true // Is it standard and can it be opened with the OS default file viewer? } RamItem An item (i.e. a shot or an asset or another production file/folder) { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" } } RamPipe A connexion between two steps in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"inputStep\": \"RamStep-uuid\", // The step this pipe is connected to \"outputStep\": \"RamStep-uuid\", // The step this pipe comes from \"project\": \"RamProject-uuid\", \"pipeFiles\": \"RamPipeFile_list-uuid\" // The list of files used through this pipe } RamPipeFile A a specific format used through a pipe. { \"shortName\": \"a short ID\", \"name\": \"a short ID.ext\", // Should be the shortname and the extension of the file type \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"fileType\": \"RamFileType-uuid\", \"project\": \"RamProject-uuid\", \"customSettings\": \"- format: ext\" // Settings to be used in applications when handling this format; formatted as a YAML string. } RamProject A project (feature film, episode, short movie\u2026) { \"shortName\": \"a short ID\", \"name\": \"a short ID.ext\", // Should be the shortname and the extension of the file type \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"steps\": \"RamStep_list-uuid\", \"assetGroups\": \"RamAssetGroup_list-uuid\", \"sequences\": \"RamSequence_list-uuid\", \"shots\": \"RamShot_list-uuid\", \"assets\": \"RamAsset_list-uuid\", \"pipeline\": \"RamPipe_list-uuid\", \"pipeFiles\": \"RamPipeFile_list-uuid\", \"users\": \"RamUser_list-uuid\", \"scheduleComments\": \"RamScheduleComment_list-uuid\", \"framerate\": 24.0, \"width\": 2048, \"height\": 858, \"aspectRatio\": 2.85, \"deadline\": \"2023-01-01\" } RamScheduleComment A simple comment in the schedule. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"date\": \"2022-09-01 12:00:00\" } RamScheduleEntry An entry in the schedule, i.e. a step associated to a user and a date. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"date\": \"2022-09-01 12:00:00\", \"user\": \"RamUser-uuid\", \"step\": \"RamStep-uuid\" } RamSequence A sequence containing shots. All shots must be part of one and only one sequence. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\" } RamShot A shot. All shots must be part of one and only one sequence. The RamShot is derived from the RamItem and has all its properties. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" }, \"sequence\": \"RamSequence-uuid\", \"duration\": 5, // in seconds \"assets\": \"RamAsset_list-uuid\" // The list of assets used in this shot } RamState A state of production, used in the more general RamStatus . { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"completionRatio\": 50 // % } RamStatus The status of the production of an item, for a specific step. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"completionRatio\": 50, // % \"user\": \"RamUser-uuid\", // The last user who's modified the status \"step\": \"RamStep-uuid\", \"item\": \"RamItem-uuid or RamShot-uuid or RamAsset-uuid\", \"itemType\": \"asset\", // One of asset or shot or item \"state\": \"RamState-uuid\", \"version\": 12, \"date\": \"2022-09-15 13:00:00 \", // The modification date of the status \"published\": true, // Is this item ready to be used in another step? \"assignedUser\": \"RamUser-uuid\", // Who's working on this? \"timeSpent\": 3600, // Seconds \"difficulty\": \"medium\", // One of: veryEasy, easy, medium, hard, veryHard \"goal\": 3 // How long this shoud take, in days } RamStep A step in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"estimationMultiplyGroup\": \"RamAssetGroup-uuid\", // Used to estimate time for shots \"type\": \"shot\", // One of pre, asset, shot, post, all \"publishSettings\": \"- format: ext\", // Some settings to be used by an application to publish files. Should be a YAML-formatted string \"estimationMethod\": \"shot\", // Pne of shot, second. Estimate work per shot or per second \"estimationVeryEasy\": 0.1, // days \"estimationEasy\": 0.5, \"estimationMedium\": 1, \"estimationHard\": 2, \"estimationVeryHard\": 5 } RamUser A user of Ramses. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"role\": \"lead\", // One of admin, project, lead, standard, \"schedule\": \"RamScheduleEntry_list-uuid\", \"email\": \"contact@rxlaboratory.org\" } Note User data is encrypted in databases saved by the Ramses Application and Ramses Server to protect user privacy. Extensions (scripts, APIs, etc) should never write user data to any file, unless it is safely encrypted too. The email should be used for technical features, like password retrieval, but never be available to other users.","title":"Objects"},{"location":"dev/objects/#objects-and-data","text":"In Ramses, everything is represented by Objects . An object consists of a Unique Universal Identifier (UUID) used to identify it across the whole system, and its associated data , encoded as a JSON Object . The whole object could thus be saved and shared as a JSON Document like this: { \"uuid\": \"unique-uid\", \"data\": { // Here's the data } } An object may also be associated with some paths in the file system. These paths are dynamic and are not included in the associated data . They have to be queried or defined by the software. Ramses Objects (i.e. RamObjects ) can represent a shot, an asset, a user, an application, or a whole project for example. They can also contain lists of other objects. Lists of objects are basic string lists of UUIDs stored in the parent object data. UUIDs and object data are synced by all the Ramses Applications and a Ramses Server , and are mirrored on all workstations and the server itself. Any other software (e.g. APIs , scripts, plugins\u2026) should get the list of objects and all data using the Ramses Daemon run by the Ramses Application which is guaranteed to be up-to-date. You can also use the Daemon to set new data to specific objects.","title":"Objects and data"},{"location":"dev/objects/#virtual-objects","text":"","title":"Virtual objects"},{"location":"dev/objects/#ramobject","text":"All objects derive from the RamObject and have at least the same properties. Note Some optional properties may be missing in the JSON data as shared by Ramses . In this case, it\u2019s up to the software to decide of a default value. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", // Colors are Hexadecimal numbers with a leading # \"settings\": { // The settings object can contain additional arbitrary values, // depending on the object // these values can be set by any software / API } }","title":"RamObject"},{"location":"dev/objects/#ramobjectlist","text":"A list of other objects. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"list\": [ \"uuid1\", \"uuid2\", \"...\" ] }","title":"RamObjectList"},{"location":"dev/objects/#objects","text":"","title":"Objects"},{"location":"dev/objects/#ramapplication","text":"An application used in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"executableFilePath\": \"path/to/the/application/bin.exe\", \"nativeFileTypes\": \"RamFileType_list-uuid\", \"importFileTypes\": \"RamFileType_list-uuid\", \"exportFileTypes\": \"RamFileType_list-uuid\", }","title":"RamApplication"},{"location":"dev/objects/#ramasset","text":"An asset used in one or several shots. The RamAsset is derived from the RamItem and has all its properties. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"\", // Should be the same as the containing asset group \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" }, \"assetGroup\": \"RamAssetGroup-uuid\", \"tags\": [ \"tag1\", \"tag2\", \"...\" ] }","title":"RamAsset"},{"location":"dev/objects/#ramassetgroup","text":"A group of assets. All assets should be assigned to one and only one group. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\" }","title":"RamAssetGroup"},{"location":"dev/objects/#ramfiletype","text":"A type of file. { \"shortName\": \"abc\", // Should be the default file extension \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"extensions\": [ \"abc\", \"def\", \"etc\" ], \"previewable\": true // Is it standard and can it be opened with the OS default file viewer? }","title":"RamFileType"},{"location":"dev/objects/#ramitem","text":"An item (i.e. a shot or an asset or another production file/folder) { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" } }","title":"RamItem"},{"location":"dev/objects/#rampipe","text":"A connexion between two steps in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"inputStep\": \"RamStep-uuid\", // The step this pipe is connected to \"outputStep\": \"RamStep-uuid\", // The step this pipe comes from \"project\": \"RamProject-uuid\", \"pipeFiles\": \"RamPipeFile_list-uuid\" // The list of files used through this pipe }","title":"RamPipe"},{"location":"dev/objects/#rampipefile","text":"A a specific format used through a pipe. { \"shortName\": \"a short ID\", \"name\": \"a short ID.ext\", // Should be the shortname and the extension of the file type \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"fileType\": \"RamFileType-uuid\", \"project\": \"RamProject-uuid\", \"customSettings\": \"- format: ext\" // Settings to be used in applications when handling this format; formatted as a YAML string. }","title":"RamPipeFile"},{"location":"dev/objects/#ramproject","text":"A project (feature film, episode, short movie\u2026) { \"shortName\": \"a short ID\", \"name\": \"a short ID.ext\", // Should be the shortname and the extension of the file type \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"steps\": \"RamStep_list-uuid\", \"assetGroups\": \"RamAssetGroup_list-uuid\", \"sequences\": \"RamSequence_list-uuid\", \"shots\": \"RamShot_list-uuid\", \"assets\": \"RamAsset_list-uuid\", \"pipeline\": \"RamPipe_list-uuid\", \"pipeFiles\": \"RamPipeFile_list-uuid\", \"users\": \"RamUser_list-uuid\", \"scheduleComments\": \"RamScheduleComment_list-uuid\", \"framerate\": 24.0, \"width\": 2048, \"height\": 858, \"aspectRatio\": 2.85, \"deadline\": \"2023-01-01\" }","title":"RamProject"},{"location":"dev/objects/#ramschedulecomment","text":"A simple comment in the schedule. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"date\": \"2022-09-01 12:00:00\" }","title":"RamScheduleComment"},{"location":"dev/objects/#ramscheduleentry","text":"An entry in the schedule, i.e. a step associated to a user and a date. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"date\": \"2022-09-01 12:00:00\", \"user\": \"RamUser-uuid\", \"step\": \"RamStep-uuid\" }","title":"RamScheduleEntry"},{"location":"dev/objects/#ramsequence","text":"A sequence containing shots. All shots must be part of one and only one sequence. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\" }","title":"RamSequence"},{"location":"dev/objects/#ramshot","text":"A shot. All shots must be part of one and only one sequence. The RamShot is derived from the RamItem and has all its properties. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"productionType\": \"RamProject-uuid\", \"statusHistory\": { \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"RamStep-uuid\": \"RamStatus_list-uuid\", \"...\": \"...\" }, \"sequence\": \"RamSequence-uuid\", \"duration\": 5, // in seconds \"assets\": \"RamAsset_list-uuid\" // The list of assets used in this shot }","title":"RamShot"},{"location":"dev/objects/#ramstate","text":"A state of production, used in the more general RamStatus . { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"completionRatio\": 50 // % }","title":"RamState"},{"location":"dev/objects/#ramstatus","text":"The status of the production of an item, for a specific step. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"completionRatio\": 50, // % \"user\": \"RamUser-uuid\", // The last user who's modified the status \"step\": \"RamStep-uuid\", \"item\": \"RamItem-uuid or RamShot-uuid or RamAsset-uuid\", \"itemType\": \"asset\", // One of asset or shot or item \"state\": \"RamState-uuid\", \"version\": 12, \"date\": \"2022-09-15 13:00:00 \", // The modification date of the status \"published\": true, // Is this item ready to be used in another step? \"assignedUser\": \"RamUser-uuid\", // Who's working on this? \"timeSpent\": 3600, // Seconds \"difficulty\": \"medium\", // One of: veryEasy, easy, medium, hard, veryHard \"goal\": 3 // How long this shoud take, in days }","title":"RamStatus"},{"location":"dev/objects/#ramstep","text":"A step in the production pipeline. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"project\": \"RamProject-uuid\", \"estimationMultiplyGroup\": \"RamAssetGroup-uuid\", // Used to estimate time for shots \"type\": \"shot\", // One of pre, asset, shot, post, all \"publishSettings\": \"- format: ext\", // Some settings to be used by an application to publish files. Should be a YAML-formatted string \"estimationMethod\": \"shot\", // Pne of shot, second. Estimate work per shot or per second \"estimationVeryEasy\": 0.1, // days \"estimationEasy\": 0.5, \"estimationMedium\": 1, \"estimationHard\": 2, \"estimationVeryHard\": 5 }","title":"RamStep"},{"location":"dev/objects/#ramuser","text":"A user of Ramses. { \"shortName\": \"a short ID\", \"name\": \"The object name\", \"comment\": \"A comment associated with the object\", \"color\": \"#e3e3e3\", \"settings\": { }, \"role\": \"lead\", // One of admin, project, lead, standard, \"schedule\": \"RamScheduleEntry_list-uuid\", \"email\": \"contact@rxlaboratory.org\" } Note User data is encrypted in databases saved by the Ramses Application and Ramses Server to protect user privacy. Extensions (scripts, APIs, etc) should never write user data to any file, unless it is safely encrypted too. The email should be used for technical features, like password retrieval, but never be available to other users.","title":"RamUser"},{"location":"dev/add-ons-reference/","text":"Scripting API reference RxLaboratory provides a reference implementation of the API in Python and Adobe ExtendScript . Other APIs may be developped, in which case all these APIs on all programming/scripting language should implement this reference, with the same classes, attributes and methods. As this document is referring to different scripting languages, it uses general terms which may be different than what is actually used in specific languages. (TODO: ADD THE LINK TO THE GITHUB REPOS OF THE APIs / LINK TO GET THEM ON RXLAB.ORG) Hint Some of the elements described in this documentation have to be interpreted differently depending on the language used in the implementations of the Ramses Add-ons API and may vary a bit. Read the examples below to see the differences between a few scripting languages. Classes This is the comprehensive list of available classes. In the Ramses Add-ons API , everything is contained in these classes. Class Inheritance Description Ramses The main class. One (and only one) instance globally available, instantiated during init time. RamAsset RamItem An asset. RamDaemonInterface The Class used to communicate with the Ramses Daemon RamFileManager Generic tools to handle files and the Ramses Naming Scheme RamFileType A File type (name and possible extensions) RamItem RamObject The base class for Shots and Assets. RamMetaDataManager A Class to get/set metadata from files. RamFileInfo A Class to handle ramses (file)names. RamObject The base class for most of Ramses objects. RamPipe A pipe which connects two steps together in the production pipeline RamPipeFile The description of a file type going through a pipe RamProject RamObject A project handled by Ramses. Projects contains general items, assets and shots. RamSettings Gets and saves settings used by Ramses. RamShot RamItem A shot. RamState RamObject The state of a step (like \u201cWaiting for approval\u201d, \u201cApproved\u201d, etc.). RamStatus A state associated to a comment, the user who changed the state, etc. RamStep RamObject A step in the production of the shots or assets of the project. RamUser RamObject The class representing users. Global Methods Method Arguments Description log string : message , LogLevel : level = LogLevel.Info Logs a message to the console. The level must be one of LogLevel.DataReceived , LogLevel.DataSent , LogLevel.Debug , LogLevel.Info , LogLevel.Critical , LogLevel.Fatal printException To be used in an except statement in Python or a catch statement in JavaScript . In JavaScript the error must be passed as an argument. Logs the exception to the console. Examples Here are a few examples showing how this API can be used. Include / Import the API # Python # Use your usual preferred way to import the module. from ramses import * # The unique `Ramses` instance is available as `Ramses.instance()`. myRamses = Ramses.instance() theSettings = myRamses.settings myShot = RamShot.getFromPath(\"path/to/the/shot\") aNewStatus = RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ) myShot.setStatus(aNewStatus, myRamses.currentStep()) # or (this is the recommended way) import ramses as ram myRamses = ram.Ramses.instance() theSettings = myRamses.settings() myShot = ram.RamShot.getFromPath(\"path/to/the/shot\") aNewStatus = ram.RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ) myShot.setStatus(aNewStatus, myRamses.currentStep()) // ExtendScript // Just include the file the usual way. #include ramses.jsxinc // The unique `Ramses` instance is available as `Ramses.instance()`. var myRamses = Ramses.instance(); var theSettings = myRamses.settings(); var myShot = RamShot.getFromPath(\"path/to/the/shot\"); var aNewStatus = new RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ); myShot.setStatus(aNewStatus, myRamses.currentStep()); Enumerated values (constants) Enumerated values (a.k.a. Constants) are predefined sets of values to be used in specific methods. Their name is in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple Color.RED, or Shape.RECTANGLE). The value itself can be of any type (array, string, number\u2026). In this documentation they\u2019re written like this: ValueType.VALUE , i.e. ItemType.SHOT or ItemType.ASSET , and they\u2019re used the same way in the actual code. # Python from ramses import RamItem, ItemType # Get an item from a specific file path anItem = RamItem.getFromPath( somePath ) if anItem is not None: # We want it only if it's a shot, # We can use the enum ItemType to compare the value. if anItem.itemType() == ItemType.SHOT: doSomething() // ExtendScript #include ramses.jsxinc // Get an item from a specific file path var anItem = RamItem.getFromPath( somePath ); if (anItem != null) { // We want it only if it's a shot, // We can use the enum ItemType to compare the value. if ( anItem.itemType() == ItemType.SHOT ) doSomething(); } Save command for Maya (Python) This example shows how to use the RamFileManager class to implement a save command in Maya with automatic backup in the _versions subfolder. import maya.cmds as cmds import ramses as ram ramses = ram.Ramses.instance() settings = ram.RamSettings.instance() def ramSave(): # The current maya file currentFilePath = cmds.file( q=True, sn=True ) ram.log(\"Saving file: \" + currentFilePath) # Check if the Daemon is available, if Ramses is set to be used \"online\" if settings.online: if not ramses.connect(): cmds.confirmDialog( title=\"No User\", message=\"You must log in Ramses first!\", button=[\"OK\"], icon=\"warning\" ) ramses.showClient() cmds.error( \"User not available: You must log in Ramses first!\" ) return # Get the save path (Ramses will check if the current file has to be renamed to respect the Ramses Tree and Naming Scheme) saveFilePath = ram.RamFileManager.getSaveFilePath( currentFilePath ) if not saveFilePath: # Ramses may return None if the current file name does not respeect the Ramses Naming Scheme cmds.warning( ram.Log.MalformedName ) # Set file to be renamed cmds.file( renameToSave = True ) cmds.inViewMessage( msg='Malformed Ramses file name! <hl>Please save with a correct name first</hl>.', pos='midCenter', fade=True ) return # If the current Maya file is inside a preview/publish/version subfolder, we're going to increment # to be sure not to lose the previous working file. increment = False if ram.RamFileManager.inReservedFolder( currentFilePath ): increment = True cmds.warning( \"Incremented and Saved as \" + saveFilePath ) # Set the save name and save cmds.file( rename = saveFilePath ) cmds.file( save=True, options=\"v=1;\" ) # Backup / Increment backupFilePath = ram.RamFileManager.copyToVersion( saveFilePath, increment=increment ) backupFileName = os.path.basename( backupFilePath ) decomposedFileName = ram.RamFileManager.decomposeRamsesFileName( backupFileName ) newVersion = str( decomposedFileName['version'] ) ram.log( \"Scene saved! Current version is: \" + newVersion ) cmds.inViewMessage( msg='Scene saved! <hl>v' + newVersion + '</hl>', pos='midCenter', fade=True ) ramSave()","title":"Reference"},{"location":"dev/add-ons-reference/#scripting-api-reference","text":"RxLaboratory provides a reference implementation of the API in Python and Adobe ExtendScript . Other APIs may be developped, in which case all these APIs on all programming/scripting language should implement this reference, with the same classes, attributes and methods. As this document is referring to different scripting languages, it uses general terms which may be different than what is actually used in specific languages. (TODO: ADD THE LINK TO THE GITHUB REPOS OF THE APIs / LINK TO GET THEM ON RXLAB.ORG) Hint Some of the elements described in this documentation have to be interpreted differently depending on the language used in the implementations of the Ramses Add-ons API and may vary a bit. Read the examples below to see the differences between a few scripting languages.","title":"Scripting API reference"},{"location":"dev/add-ons-reference/#classes","text":"This is the comprehensive list of available classes. In the Ramses Add-ons API , everything is contained in these classes. Class Inheritance Description Ramses The main class. One (and only one) instance globally available, instantiated during init time. RamAsset RamItem An asset. RamDaemonInterface The Class used to communicate with the Ramses Daemon RamFileManager Generic tools to handle files and the Ramses Naming Scheme RamFileType A File type (name and possible extensions) RamItem RamObject The base class for Shots and Assets. RamMetaDataManager A Class to get/set metadata from files. RamFileInfo A Class to handle ramses (file)names. RamObject The base class for most of Ramses objects. RamPipe A pipe which connects two steps together in the production pipeline RamPipeFile The description of a file type going through a pipe RamProject RamObject A project handled by Ramses. Projects contains general items, assets and shots. RamSettings Gets and saves settings used by Ramses. RamShot RamItem A shot. RamState RamObject The state of a step (like \u201cWaiting for approval\u201d, \u201cApproved\u201d, etc.). RamStatus A state associated to a comment, the user who changed the state, etc. RamStep RamObject A step in the production of the shots or assets of the project. RamUser RamObject The class representing users.","title":"Classes"},{"location":"dev/add-ons-reference/#global-methods","text":"Method Arguments Description log string : message , LogLevel : level = LogLevel.Info Logs a message to the console. The level must be one of LogLevel.DataReceived , LogLevel.DataSent , LogLevel.Debug , LogLevel.Info , LogLevel.Critical , LogLevel.Fatal printException To be used in an except statement in Python or a catch statement in JavaScript . In JavaScript the error must be passed as an argument. Logs the exception to the console.","title":"Global Methods"},{"location":"dev/add-ons-reference/#examples","text":"Here are a few examples showing how this API can be used.","title":"Examples"},{"location":"dev/add-ons-reference/#include-import-the-api","text":"# Python # Use your usual preferred way to import the module. from ramses import * # The unique `Ramses` instance is available as `Ramses.instance()`. myRamses = Ramses.instance() theSettings = myRamses.settings myShot = RamShot.getFromPath(\"path/to/the/shot\") aNewStatus = RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ) myShot.setStatus(aNewStatus, myRamses.currentStep()) # or (this is the recommended way) import ramses as ram myRamses = ram.Ramses.instance() theSettings = myRamses.settings() myShot = ram.RamShot.getFromPath(\"path/to/the/shot\") aNewStatus = ram.RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ) myShot.setStatus(aNewStatus, myRamses.currentStep()) // ExtendScript // Just include the file the usual way. #include ramses.jsxinc // The unique `Ramses` instance is available as `Ramses.instance()`. var myRamses = Ramses.instance(); var theSettings = myRamses.settings(); var myShot = RamShot.getFromPath(\"path/to/the/shot\"); var aNewStatus = new RamStatus( myRamses.state(\"WIP\"), myRamses.currentUser(), \"A comment\" ); myShot.setStatus(aNewStatus, myRamses.currentStep());","title":"Include / Import the API"},{"location":"dev/add-ons-reference/#enumerated-values-constants","text":"Enumerated values (a.k.a. Constants) are predefined sets of values to be used in specific methods. Their name is in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple Color.RED, or Shape.RECTANGLE). The value itself can be of any type (array, string, number\u2026). In this documentation they\u2019re written like this: ValueType.VALUE , i.e. ItemType.SHOT or ItemType.ASSET , and they\u2019re used the same way in the actual code. # Python from ramses import RamItem, ItemType # Get an item from a specific file path anItem = RamItem.getFromPath( somePath ) if anItem is not None: # We want it only if it's a shot, # We can use the enum ItemType to compare the value. if anItem.itemType() == ItemType.SHOT: doSomething() // ExtendScript #include ramses.jsxinc // Get an item from a specific file path var anItem = RamItem.getFromPath( somePath ); if (anItem != null) { // We want it only if it's a shot, // We can use the enum ItemType to compare the value. if ( anItem.itemType() == ItemType.SHOT ) doSomething(); }","title":"Enumerated values (constants)"},{"location":"dev/add-ons-reference/#save-command-for-maya-python","text":"This example shows how to use the RamFileManager class to implement a save command in Maya with automatic backup in the _versions subfolder. import maya.cmds as cmds import ramses as ram ramses = ram.Ramses.instance() settings = ram.RamSettings.instance() def ramSave(): # The current maya file currentFilePath = cmds.file( q=True, sn=True ) ram.log(\"Saving file: \" + currentFilePath) # Check if the Daemon is available, if Ramses is set to be used \"online\" if settings.online: if not ramses.connect(): cmds.confirmDialog( title=\"No User\", message=\"You must log in Ramses first!\", button=[\"OK\"], icon=\"warning\" ) ramses.showClient() cmds.error( \"User not available: You must log in Ramses first!\" ) return # Get the save path (Ramses will check if the current file has to be renamed to respect the Ramses Tree and Naming Scheme) saveFilePath = ram.RamFileManager.getSaveFilePath( currentFilePath ) if not saveFilePath: # Ramses may return None if the current file name does not respeect the Ramses Naming Scheme cmds.warning( ram.Log.MalformedName ) # Set file to be renamed cmds.file( renameToSave = True ) cmds.inViewMessage( msg='Malformed Ramses file name! <hl>Please save with a correct name first</hl>.', pos='midCenter', fade=True ) return # If the current Maya file is inside a preview/publish/version subfolder, we're going to increment # to be sure not to lose the previous working file. increment = False if ram.RamFileManager.inReservedFolder( currentFilePath ): increment = True cmds.warning( \"Incremented and Saved as \" + saveFilePath ) # Set the save name and save cmds.file( rename = saveFilePath ) cmds.file( save=True, options=\"v=1;\" ) # Backup / Increment backupFilePath = ram.RamFileManager.copyToVersion( saveFilePath, increment=increment ) backupFileName = os.path.basename( backupFilePath ) decomposedFileName = ram.RamFileManager.decomposeRamsesFileName( backupFileName ) newVersion = str( decomposedFileName['version'] ) ram.log( \"Scene saved! Current version is: \" + newVersion ) cmds.inViewMessage( msg='Scene saved! <hl>v' + newVersion + '</hl>', pos='midCenter', fade=True ) ramSave()","title":"Save command for Maya (Python)"},{"location":"dev/add-ons-reference/enum/","text":"Enumerated values (constants) Enumerated values (a.k.a. Constants) are predefined sets of values to be used in specific methods. Their name should be in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple Color.RED , or Shape.RECTANGLE ). The value itself can be of any type (array, string, number\u2026). In this documentation they\u2019re written like this: ValueType.VALUE , i.e. ItemType.SHOT or ItemType.ASSET , and they\u2019re used the same way in the actual code. Warning For the current 0.x versions of the framework, not all enumerated values respect the naming CAPITAL_SNAKE_CASE convention. This will change before the release of 1.0; when using the API during the 0.x development phase, be careful when updating as you may need to rename these values in your code. This reference will be kept up-to-date in real time. FileNames The names of some files reserved by Ramses . Name Actual value Description FileNames. META_DATA \"_ramses_data.json\" FolderNames The names of the folders used by the Ramses Tree . Name Actual value Description FolderNames. admin \"00-ADMIN\" FolderNames. assets \"04-ASSETS FolderNames. export \"06-EXPORT FolderNames. postProd 03-POST-PROD\" FolderNames. preProd \"01-PRE-PROD\" FolderNames. preview \"_preview\" FolderNames. prod \"02-PROD\" FolderNames. projects \"Projects\" FolderNames. publish \"_published\" FolderNames. shots \"05-SHOTS\" FolderNames. config \"Config\" FolderNames. users \"Users\" FolderNames. versions \"_versions\" ItemType Used to differenciate between Shots, Assets, and General items. Name Actual value Description ItemType. ASSET 'A' ItemType. GENERAL 'G' ItemType. SHOT 'S' Log A list of messages to be logged / shown to the user. Name Actual value Description Log. MalformedName \"Cannot work on this file as it does not respect the Ramses' naming scheme, sorry.\" Log. NoProject \"There's no current project. Select a project first.\" Log. NotAnItem \"This file does not seem to be a valid Ramses Item, sorry.\" Log. NoUser \"There's no current user. You may need to log in.\" Log. PathNotFound \"The file or folder path could not be found.\" Log. StateNotFound \"State not found.\" LogLevel Importance of the log messages. The API itself should not log any LogLevel.Info , this level is reserved for the add-ons developped using the API. Name Actual value Description LogLevel. DataReceived -2 The raw data received from the Daemon LogLevel. DataSent -1 The queries sent to the Daemon LogLevel. Debug 0 General debug information LogLevel. Info 1 General information to be shown to the user LogLevel. Critical 2 An non-blocking error LogLevel. Fatal 3 A fatal error MetaDataKeys The available predefined keys to store file metadata. Name Actual value Description MetaDataKeys. COMMENT \"comment\" A comment associated to the file MetaDataKeys. DATE \"date\" A date for the file MetaDataKeys. MODIFICATION_HISTORY \"history\" The list of all modification dates MetaDataKeys. PIPE_TYPE \"pipeFileShortName\" The type of the pipe associated to the file MetaDataKeys. STATE \"stateShortName\" A version file associated to the file MetaDataKeys. VERSION \"version\" A version associated to the file MetaDataKeys. VERSION_FILE \"versionFilePath\" A version file associated to the file StepType The type of a step. Usually used to filter available steps. Name Value Description StepType. PRE_PRODUCTION 'PRE_PRODUCTION' StepType. ASSET_PRODUCTION 'ASSET_PRODUCTION' StepType. SHOT_PRODUCTION 'SHOT_PRODUCTION' StepType. POST_PRODUCTION 'POST_PRODUCTION' StepType. PRODUCTION 'PRODUCTION' Use for ASSET and SHOT production together. StepType. ALL 'ALL' Use for all steps. UserRole The role of the user (i.e. its administration rights). Name Value Description UserRole. ADMIN 3 UserRole. PROJECT_ADMIN 2 UserRole. LEAD 1 UserRole. STANDARD 0 Examples # Python from ramses import RamItem, ItemType # Get an item from a specific file path anItem = RamItem.getFromPath( somePath ) if anItem is not None: # We want it only if it's a shot, # We can use the enum ItemType to compare the value. if anItem.itemType() == ItemType.SHOT: doSomething() // ExtendScript #include ramses.jsxinc // Get an item from a specific file path var anItem = RamItem.getFromPath( somePath ); if (anItem != null) { // We want it only if it's a shot, // We can use the enum ItemType to compare the value. if ( anItem.itemType() == ItemType.SHOT ) doSomething(); }","title":"Constants"},{"location":"dev/add-ons-reference/enum/#enumerated-values-constants","text":"Enumerated values (a.k.a. Constants) are predefined sets of values to be used in specific methods. Their name should be in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple Color.RED , or Shape.RECTANGLE ). The value itself can be of any type (array, string, number\u2026). In this documentation they\u2019re written like this: ValueType.VALUE , i.e. ItemType.SHOT or ItemType.ASSET , and they\u2019re used the same way in the actual code. Warning For the current 0.x versions of the framework, not all enumerated values respect the naming CAPITAL_SNAKE_CASE convention. This will change before the release of 1.0; when using the API during the 0.x development phase, be careful when updating as you may need to rename these values in your code. This reference will be kept up-to-date in real time.","title":"Enumerated values (constants)"},{"location":"dev/add-ons-reference/enum/#filenames","text":"The names of some files reserved by Ramses . Name Actual value Description FileNames. META_DATA \"_ramses_data.json\"","title":"FileNames"},{"location":"dev/add-ons-reference/enum/#foldernames","text":"The names of the folders used by the Ramses Tree . Name Actual value Description FolderNames. admin \"00-ADMIN\" FolderNames. assets \"04-ASSETS FolderNames. export \"06-EXPORT FolderNames. postProd 03-POST-PROD\" FolderNames. preProd \"01-PRE-PROD\" FolderNames. preview \"_preview\" FolderNames. prod \"02-PROD\" FolderNames. projects \"Projects\" FolderNames. publish \"_published\" FolderNames. shots \"05-SHOTS\" FolderNames. config \"Config\" FolderNames. users \"Users\" FolderNames. versions \"_versions\"","title":"FolderNames"},{"location":"dev/add-ons-reference/enum/#itemtype","text":"Used to differenciate between Shots, Assets, and General items. Name Actual value Description ItemType. ASSET 'A' ItemType. GENERAL 'G' ItemType. SHOT 'S'","title":"ItemType"},{"location":"dev/add-ons-reference/enum/#log","text":"A list of messages to be logged / shown to the user. Name Actual value Description Log. MalformedName \"Cannot work on this file as it does not respect the Ramses' naming scheme, sorry.\" Log. NoProject \"There's no current project. Select a project first.\" Log. NotAnItem \"This file does not seem to be a valid Ramses Item, sorry.\" Log. NoUser \"There's no current user. You may need to log in.\" Log. PathNotFound \"The file or folder path could not be found.\" Log. StateNotFound \"State not found.\"","title":"Log"},{"location":"dev/add-ons-reference/enum/#loglevel","text":"Importance of the log messages. The API itself should not log any LogLevel.Info , this level is reserved for the add-ons developped using the API. Name Actual value Description LogLevel. DataReceived -2 The raw data received from the Daemon LogLevel. DataSent -1 The queries sent to the Daemon LogLevel. Debug 0 General debug information LogLevel. Info 1 General information to be shown to the user LogLevel. Critical 2 An non-blocking error LogLevel. Fatal 3 A fatal error","title":"LogLevel"},{"location":"dev/add-ons-reference/enum/#metadatakeys","text":"The available predefined keys to store file metadata. Name Actual value Description MetaDataKeys. COMMENT \"comment\" A comment associated to the file MetaDataKeys. DATE \"date\" A date for the file MetaDataKeys. MODIFICATION_HISTORY \"history\" The list of all modification dates MetaDataKeys. PIPE_TYPE \"pipeFileShortName\" The type of the pipe associated to the file MetaDataKeys. STATE \"stateShortName\" A version file associated to the file MetaDataKeys. VERSION \"version\" A version associated to the file MetaDataKeys. VERSION_FILE \"versionFilePath\" A version file associated to the file","title":"MetaDataKeys"},{"location":"dev/add-ons-reference/enum/#steptype","text":"The type of a step. Usually used to filter available steps. Name Value Description StepType. PRE_PRODUCTION 'PRE_PRODUCTION' StepType. ASSET_PRODUCTION 'ASSET_PRODUCTION' StepType. SHOT_PRODUCTION 'SHOT_PRODUCTION' StepType. POST_PRODUCTION 'POST_PRODUCTION' StepType. PRODUCTION 'PRODUCTION' Use for ASSET and SHOT production together. StepType. ALL 'ALL' Use for all steps.","title":"StepType"},{"location":"dev/add-ons-reference/enum/#userrole","text":"The role of the user (i.e. its administration rights). Name Value Description UserRole. ADMIN 3 UserRole. PROJECT_ADMIN 2 UserRole. LEAD 1 UserRole. STANDARD 0","title":"UserRole"},{"location":"dev/add-ons-reference/enum/#examples","text":"# Python from ramses import RamItem, ItemType # Get an item from a specific file path anItem = RamItem.getFromPath( somePath ) if anItem is not None: # We want it only if it's a shot, # We can use the enum ItemType to compare the value. if anItem.itemType() == ItemType.SHOT: doSomething() // ExtendScript #include ramses.jsxinc // Get an item from a specific file path var anItem = RamItem.getFromPath( somePath ); if (anItem != null) { // We want it only if it's a shot, // We can use the enum ItemType to compare the value. if ( anItem.itemType() == ItemType.SHOT ) doSomething(); }","title":"Examples"},{"location":"dev/add-ons-reference/implementation/","text":"Implementation / API Dev notes Note This section is for the development of the low-level API only; you should not need these notes when developping your own add-on using the API. Hint Some of the elements described in this documentation have to be interpreted depending on the language used in the implementations of the Ramses API and may vary a bit. Enumerated Values Enumerated values (a.k.a. Constants ) are predefined sets of values to be used in specific methods. Their name is in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple color.RED , or shape.RECTANGLE ). The value itself can be of any type (array, string, number\u2026). # Python # Enumerated values are public static attributes of a containing class. They're declared like this: class Group(): VALUE_1 = 0 VALUE_2 = 1 VALUE_3 = 2 # Example: class Color(): RED = [255,0,0] GREEN = [0,255,0] BLUE = [0,0,255] // ExtendScript // Enumerated values are attributes in simple objects. They're declared like this: var Group = { VALUE_1: 0, VALUE_2: 1, VALUE_3: 2 }; // Example: var Color = { RED: [255,0,0], GREEN: [0,255,0], BLUE: [0,0,255] }; Accessing the data In All \u201c RamClasses \u201d, most of the data is retrieved with methods (instead of accessing it directly from an attribute). This allows the API to get and set the data from the Daemon , if and only if Ramses.instance().online is true . Some instances of these classes can be virtual . A virtual instance is an object which is not stored in the database; it\u2019s meant to be temporary. In this case, the data can be set by the API itself and is not retrieved nor updated with the Daemon . There is also a cache system, to prevent having too many calls to the Daemon and improve performance. The Daemon is called if and only if the data stored in the object is more than two second old. That means subsequent calls to the data in a single process should result to a single call to the Daemon . Here are example concepts in Python and ExtendScript, like what\u2019s done in the provided implementations of the Ramses Add-ons API. # Python DAEMON = RamDaemonInterface.instance() class RamClass( object ): # The data can be passed to the constructor. def __init__( self, uuid=\"\", data = None, virtual=True, objectType=\"RamObject\" ): \"\"\" Args: uuid (str): The object's uuid \"\"\" if uuid == \"\" and virtual: self.__virtual = True else: self.__virtual = False if uuid == \"\": uuid = str(UUID.uuid4()) self.__uuid = uuid if isinstance(data, str): data = json.loads(data) if data: self.__data = data self.__cacheTime = time.time() else: self.__data = {} self.__cacheTime = 0 if not virtual: reply = DAEMON.create( self.__uuid, self.__data, objectType ) if not DAEMON.checkReply(reply): log(\"I can't create this object.\") def uuid( self ): return self.__uuid def data( self ): \"\"\"Gets the data for this object\"\"\" if self.__virtual: return self.__data # Check if the cached data is recent enough # there's a 2-second timeout to not post too many queries # and improve performance cacheElapsed = time.time() - self.__cacheTime if self.__data and cacheElapsed < 2: return self.__data # Get the data from the daemon data = DAEMON.getData( self.__uuid ) if data: self.__data = data self.__cacheTime = time.time() return self.__data def setData( self, data): if isinstance(data, str): data = json.loads(data) self.__data = data if not self.__virtual: DAEMON.setData( self.__uuid, data ) def get(self, key, default = None): \"\"\"Get a specific value in the data\"\"\" data = self.data() return data.get(key, default) def name( self ): \"\"\" Returns: str \"\"\" return self.get('name', 'Unknown Object')","title":"Dev Notes"},{"location":"dev/add-ons-reference/implementation/#implementation-api-dev-notes","text":"Note This section is for the development of the low-level API only; you should not need these notes when developping your own add-on using the API. Hint Some of the elements described in this documentation have to be interpreted depending on the language used in the implementations of the Ramses API and may vary a bit.","title":"Implementation / API Dev notes"},{"location":"dev/add-ons-reference/implementation/#enumerated-values","text":"Enumerated values (a.k.a. Constants ) are predefined sets of values to be used in specific methods. Their name is in CAPITAL_SNAKE_CASE, and they\u2019re grouped together by type (for exemple color.RED , or shape.RECTANGLE ). The value itself can be of any type (array, string, number\u2026). # Python # Enumerated values are public static attributes of a containing class. They're declared like this: class Group(): VALUE_1 = 0 VALUE_2 = 1 VALUE_3 = 2 # Example: class Color(): RED = [255,0,0] GREEN = [0,255,0] BLUE = [0,0,255] // ExtendScript // Enumerated values are attributes in simple objects. They're declared like this: var Group = { VALUE_1: 0, VALUE_2: 1, VALUE_3: 2 }; // Example: var Color = { RED: [255,0,0], GREEN: [0,255,0], BLUE: [0,0,255] };","title":"Enumerated Values"},{"location":"dev/add-ons-reference/implementation/#accessing-the-data","text":"In All \u201c RamClasses \u201d, most of the data is retrieved with methods (instead of accessing it directly from an attribute). This allows the API to get and set the data from the Daemon , if and only if Ramses.instance().online is true . Some instances of these classes can be virtual . A virtual instance is an object which is not stored in the database; it\u2019s meant to be temporary. In this case, the data can be set by the API itself and is not retrieved nor updated with the Daemon . There is also a cache system, to prevent having too many calls to the Daemon and improve performance. The Daemon is called if and only if the data stored in the object is more than two second old. That means subsequent calls to the data in a single process should result to a single call to the Daemon . Here are example concepts in Python and ExtendScript, like what\u2019s done in the provided implementations of the Ramses Add-ons API. # Python DAEMON = RamDaemonInterface.instance() class RamClass( object ): # The data can be passed to the constructor. def __init__( self, uuid=\"\", data = None, virtual=True, objectType=\"RamObject\" ): \"\"\" Args: uuid (str): The object's uuid \"\"\" if uuid == \"\" and virtual: self.__virtual = True else: self.__virtual = False if uuid == \"\": uuid = str(UUID.uuid4()) self.__uuid = uuid if isinstance(data, str): data = json.loads(data) if data: self.__data = data self.__cacheTime = time.time() else: self.__data = {} self.__cacheTime = 0 if not virtual: reply = DAEMON.create( self.__uuid, self.__data, objectType ) if not DAEMON.checkReply(reply): log(\"I can't create this object.\") def uuid( self ): return self.__uuid def data( self ): \"\"\"Gets the data for this object\"\"\" if self.__virtual: return self.__data # Check if the cached data is recent enough # there's a 2-second timeout to not post too many queries # and improve performance cacheElapsed = time.time() - self.__cacheTime if self.__data and cacheElapsed < 2: return self.__data # Get the data from the daemon data = DAEMON.getData( self.__uuid ) if data: self.__data = data self.__cacheTime = time.time() return self.__data def setData( self, data): if isinstance(data, str): data = json.loads(data) self.__data = data if not self.__virtual: DAEMON.setData( self.__uuid, data ) def get(self, key, default = None): \"\"\"Get a specific value in the data\"\"\" data = self.data() return data.get(key, default) def name( self ): \"\"\" Returns: str \"\"\" return self.get('name', 'Unknown Object')","title":"Accessing the data"},{"location":"dev/add-ons-reference/ram_asset/","text":"RamAsset A class representing an asset. Inherits object \u25ba RamObject \u25ba RamItem \u25ba RamAsset Static Methods Method Arguments Description fromPath \u25b9 RamAsset string : folderPath Returns a RamAsset instance built using the given path. The path can be any file or folder path from the asset (a version file, a preview file, etc) Methods Method Arguments Description tags \u25b9 list of string Some tags describing the asset. An empty string if the Daemon is not available. group \u25b9 string The name of the group containing this asset. assetGroup \u25b9 RamAssetGroup The group containing this asset.","title":"RamAsset"},{"location":"dev/add-ons-reference/ram_asset/#ramasset","text":"A class representing an asset. Inherits object \u25ba RamObject \u25ba RamItem \u25ba RamAsset","title":"RamAsset"},{"location":"dev/add-ons-reference/ram_asset/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamAsset string : folderPath Returns a RamAsset instance built using the given path. The path can be any file or folder path from the asset (a version file, a preview file, etc)","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_asset/#methods","text":"Method Arguments Description tags \u25b9 list of string Some tags describing the asset. An empty string if the Daemon is not available. group \u25b9 string The name of the group containing this asset. assetGroup \u25b9 RamAssetGroup The group containing this asset.","title":"Methods"},{"location":"dev/add-ons-reference/ram_assetgroup/","text":"RamAssetGroup A group of assets. Inherits object \u25ba RamObject \u25ba RamAssetGroup Static Methods Method Arguments Description fromPath \u25b9 RamAssetGroup or None string : fileOrFolderPath The path can be any file or folder path from inside the group (a version file, a preview file, etc). Methods Method Arguments Description project \u25b9 RamProject The project containing this group.","title":"RamAssetGroup"},{"location":"dev/add-ons-reference/ram_assetgroup/#ramassetgroup","text":"A group of assets. Inherits object \u25ba RamObject \u25ba RamAssetGroup","title":"RamAssetGroup"},{"location":"dev/add-ons-reference/ram_assetgroup/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamAssetGroup or None string : fileOrFolderPath The path can be any file or folder path from inside the group (a version file, a preview file, etc).","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_assetgroup/#methods","text":"Method Arguments Description project \u25b9 RamProject The project containing this group.","title":"Methods"},{"location":"dev/add-ons-reference/ram_daemon_interface/","text":"RamDaemonInterface This is a low-level Class used to communicate with the Ramses Daemon. This is a simple wrapper for the Daemon API . One (and only one) instance is globally available (RamDaemonInterface is a singleton ), by calling RamDaemonInterface.instance() or Ramses.instance().daemonInterface() . Note You should not need this class as all communications are automatically handled by the other classes. Static Methods Method Arguments Description Dev Notes instance \u25b9 RamDaemonInterface Returns the RamDaemonInterface unique instance. checkReply \u25b9 boolean dict : reply Checks if the reply returned by a RamDaemonInterface instance is accepted, successful and has some content. Methods Please refer to the Daemon API reference for more information about these methods. These methods return the reply of the Daemon converted from JSON to an object, dict, structure, or whatever best suits the language in which the add-on is implemented. This returned object can be converted to a RamObject instance using the corresponding RamObject.fromDict() static method. Method Arguments Description Dev Notes create \u25b9 Object / Dict \u2022 string : uuid \u2022 string or Object/ Dict : data \u2022 string : objectType Creates a new object, with the given data getCurrentProject \u25b9 RamProject or None Gets the current project getCurrentUser \u25b9 RamUser or None Gets the current user getData \u25b9 Object / Dict \u2022 string : uuid Gets the data of a specific RamObject . getObjects \u25b9 list of RamObject \u2022 string : objectType Gets the list of objects of a given type. The returned class type depends on the type of object and may be a derived class of RamObject . getPath \u25b9 string \u2022 string : uuid Gets the path for a specific object. getProjects \u25b9 list of RamProject Gets the list of available projects (for the current user) getRamsesFolderPath \u25b9 string Gets the main Ramses folder containing projects, config files, user files\u2026 online \u25b9 boolean True if the Daemon is available ping \u25b9 Object / Dict Gets the version and current user of the Ramses Daemon raiseWindow Raises the Ramses Application main window setCurrentProject \u25b9 Object / Dict \u2022 string : uuid Sets the current project setData \u25b9 Object / Dict \u2022 string : uuid \u2022 string or Object/ Dict : data Sets the data for a specific RamObject . uuidFromPath \u25b9 string \u2022 string : path \u2022 string : type = \"RamObject\" Gets the UUID of a RamObject using its path. Examples # Python daemon = RamDaemonInterface.instance() reply = daemon.getProjects() # Call from the instance if RamDaemonInterface.checkReply(reply): # Call from the class, it's a static method doSomething(reply['content']) else: print (reply['message']) // JavaScript var daemon = RamDaemonInterface.instance(); var reply = daemon.getProjects(); // Call from the instance if ( RamDaemonInterface.checkReply(reply) ) { // Call from the class, it's a static method doSomething(reply['content']); } else { alert (reply['message']); } Implementation Python In Python, the methods from this class return a dict as constructed from the JSON reply of the Daemon using the standard json.loads( str ) method. JavaScript / ExtendScript In JS, the methods from this class return a standard JS object as constructed from the JSON reply of the Daemon using the standard json2 library.","title":"RamDaemonInterface"},{"location":"dev/add-ons-reference/ram_daemon_interface/#ramdaemoninterface","text":"This is a low-level Class used to communicate with the Ramses Daemon. This is a simple wrapper for the Daemon API . One (and only one) instance is globally available (RamDaemonInterface is a singleton ), by calling RamDaemonInterface.instance() or Ramses.instance().daemonInterface() . Note You should not need this class as all communications are automatically handled by the other classes.","title":"RamDaemonInterface"},{"location":"dev/add-ons-reference/ram_daemon_interface/#static-methods","text":"Method Arguments Description Dev Notes instance \u25b9 RamDaemonInterface Returns the RamDaemonInterface unique instance. checkReply \u25b9 boolean dict : reply Checks if the reply returned by a RamDaemonInterface instance is accepted, successful and has some content.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_daemon_interface/#methods","text":"Please refer to the Daemon API reference for more information about these methods. These methods return the reply of the Daemon converted from JSON to an object, dict, structure, or whatever best suits the language in which the add-on is implemented. This returned object can be converted to a RamObject instance using the corresponding RamObject.fromDict() static method. Method Arguments Description Dev Notes create \u25b9 Object / Dict \u2022 string : uuid \u2022 string or Object/ Dict : data \u2022 string : objectType Creates a new object, with the given data getCurrentProject \u25b9 RamProject or None Gets the current project getCurrentUser \u25b9 RamUser or None Gets the current user getData \u25b9 Object / Dict \u2022 string : uuid Gets the data of a specific RamObject . getObjects \u25b9 list of RamObject \u2022 string : objectType Gets the list of objects of a given type. The returned class type depends on the type of object and may be a derived class of RamObject . getPath \u25b9 string \u2022 string : uuid Gets the path for a specific object. getProjects \u25b9 list of RamProject Gets the list of available projects (for the current user) getRamsesFolderPath \u25b9 string Gets the main Ramses folder containing projects, config files, user files\u2026 online \u25b9 boolean True if the Daemon is available ping \u25b9 Object / Dict Gets the version and current user of the Ramses Daemon raiseWindow Raises the Ramses Application main window setCurrentProject \u25b9 Object / Dict \u2022 string : uuid Sets the current project setData \u25b9 Object / Dict \u2022 string : uuid \u2022 string or Object/ Dict : data Sets the data for a specific RamObject . uuidFromPath \u25b9 string \u2022 string : path \u2022 string : type = \"RamObject\" Gets the UUID of a RamObject using its path.","title":"Methods"},{"location":"dev/add-ons-reference/ram_daemon_interface/#examples","text":"# Python daemon = RamDaemonInterface.instance() reply = daemon.getProjects() # Call from the instance if RamDaemonInterface.checkReply(reply): # Call from the class, it's a static method doSomething(reply['content']) else: print (reply['message']) // JavaScript var daemon = RamDaemonInterface.instance(); var reply = daemon.getProjects(); // Call from the instance if ( RamDaemonInterface.checkReply(reply) ) { // Call from the class, it's a static method doSomething(reply['content']); } else { alert (reply['message']); }","title":"Examples"},{"location":"dev/add-ons-reference/ram_daemon_interface/#implementation","text":"","title":"Implementation"},{"location":"dev/add-ons-reference/ram_daemon_interface/#python","text":"In Python, the methods from this class return a dict as constructed from the JSON reply of the Daemon using the standard json.loads( str ) method.","title":"Python"},{"location":"dev/add-ons-reference/ram_daemon_interface/#javascript-extendscript","text":"In JS, the methods from this class return a standard JS object as constructed from the JSON reply of the Daemon using the standard json2 library.","title":"JavaScript / ExtendScript"},{"location":"dev/add-ons-reference/ram_file_info/","text":"RamFileInfo A class to easily handle Ramses names using the Ramses Naming Scheme . Read the sections about the Naming Scheme for more details about names used by Ramses . Attributes These attributes are automatically set by the RamFileInfo.setFileName( name ) or RamFileInfo.setFilePath( name ) methods; They can then be changed and a new file name can be generated using RamFileInfo.fileName( ) or RamFileInfo.filePath( ) Attribute Type Default Description date datetime current date and time The modification date of the file. extension string \"\" The file extension (without the leading . ). isRestoredVersion boolean false True if the corresponding file is a file created from restoring a previous version. project string \"\" The project short name (ID). ramType ItemType \"\" The type of the corresponding item. resource string \"\" The resource string. restoredVersion boolean -1 The version which was restored if isRestoredVersion is true . shortName string \"\" The short name (ID) of the item. state string \"\" The state short name (ID), if any. step string \"\" The step short name (ID). version int -1 The versin, -1 if not set/found. Methods Method Arguments Description constructor Creates a new empty instance. copy \u25b9 RamFileInfo Creates a copy of the current instance. fileName \u25b9 string Constructs and returns the file name based on the attributes. filePath \u25b9 string Constructs and returns the file path based on the attributes. originalFileName \u25b9 string Gets the original file name without any modification. originalFilePath \u25b9 string Gets the original file path if it was set, without any modification. setFileName \u25b9 boolean Sets the filename and parses data from it. Returns true on success. setFilePath Parses all data which can be found from a file path. Special Convert to string RamFileInfo s can be converted to string the usual way. This is equivalent to calling RamFileInfo.fileName() . # Python info = RamFileInfo( ) info.setFileName( aFileName ) print( info ) # implicit conversion print( str(info) ) # explicit conversion # Both will print: >>> PROJ_A_anAsset_aStep_aResource.ext // ExtendScript var info = new RamFileInfo( ); info.setFileName( aFileName ); $.writeln( obj.toString() ); // Prints: // PROJ_A_anAsset_aStep_aResource.ext Comparing objects RamFileInfo can be compared to check if two file info are the same, by comparing the attributes except the state and the version . That means all different versions of the same file are considered equal. The location is not compared either: two identical files but in different locations are considered the same. # Python info = RamFileInfo( ) info.setFileName( aFileName ) other = RamFileInfo( ) other.setFileName( anotherFileName ) same = RamFileInfo( ) same.setFileName( aFileNameButAnotherVersionOrLocation ) # RamFileInfo can be compared as any other value info == other # False info == same # True # It can be used with the `in` operator too infoList = [ info, other ] same in infoList # True # But RamFileInfo is not hashable, so it cannot be used in a `set` or as a key in a `dict` // ExtendScript var info = RamFileInfo( ); info.setFileName( aFileName ); var other = RamFileInfo( ); other.setFileName( anotherFileName ); var same = RamFileInfo( ); same.setFileName( aFileNameButAnotherVersionOrLocation ); // RamObject can be compared with the is() method info.is(other) // false info.is(same) // true Examples # Python from ramses import RamFileInfo, ItemType # Get info from an existing asset file filePath = '/path/to/PROJ_A_MyAsset_RIG_aResource.blend' nm = RamFileInfo() if nm.setFileName(filePath: nm.version = 12 # Set the version to 12 nm.state = \"OK\" # Set thje state print( nm.step ) # Prints: RIG print( nm.fileName() ) # Prints: PROJ_A_MyAsset_RIG_aResource_OK012.blend # Build a filename from scratch nm = RamFileInfo() nm.project = \"OTHER\" nm.shortName = \"MyShot\" nm.ramType = ItemType.SHOT nm.step = \"ANIM\" nm.extension = \"kra\" print( nm.fileName() ) # Prints: OTHER_S_MyShot_ANIM.kra # A function to publish a file # Note that this is actually the implementation of RamFileManager.publishFile() def publishFile( filePath ): \"\"\"Copies the given file to its corresponding publish folder\"\"\" fileInfo = RamFileManager.getPublishInfo( filePath ) if fileInfo.project == \"\": return publishFilePath = fileInfo.filePath() RamFileManager.copy( filePath, publishFilePath ) # Keep the date in the metadata, just in case RamMetaDataManager.setDate( publishFilePath, fileInfo.date ) return publishFilePath // ExtendScript #include ramses.jsxinc // Get info from an existing asset file var filePath = '/path/to/PROJ_A_MyAsset_RIG_aResource.blend'; var nm = new RamFileInfo(); if ( nm.setFileName(filePath) ) { nm.version = 12; // Set the version to 12 nm.state = \"OK\"; // Set thje state alert( nm.step ); // Alerts: RIG alert( nm.fileName() ); // Alerts: PROJ_A_MyAsset_RIG_aResource_OK012.blend } // Build a filename from scratch nm = RamFileInfo(); nm.project = \"OTHER\"; nm.shortName = \"MyShot\"; nm.ramType = ItemType.SHOT; nm.step = \"ANIM\"; nm.extension = \"kra\"; alert( nm.fileName() ); // Alerts: OTHER_S_MyShot_ANIM.kra // A function to publish a file // Note that this is actually the implementation of RamFileManager.publishFile() function publishFile( filePath ) { // Copies the given file to its corresponding publish folder var fileInfo = RamFileManager.getPublishInfo( filePath ); if (fileInfo.project == \"\") return var publishFilePath = fileInfo.filePath(); RamFileManager.copy( filePath, publishFilePath ); // Keep the date in the metadata, just in case RamMetaDataManager.setDate( publishFilePath, fileInfo.date ); return publishFilePath; }","title":"RamFileInfo"},{"location":"dev/add-ons-reference/ram_file_info/#ramfileinfo","text":"A class to easily handle Ramses names using the Ramses Naming Scheme . Read the sections about the Naming Scheme for more details about names used by Ramses .","title":"RamFileInfo"},{"location":"dev/add-ons-reference/ram_file_info/#attributes","text":"These attributes are automatically set by the RamFileInfo.setFileName( name ) or RamFileInfo.setFilePath( name ) methods; They can then be changed and a new file name can be generated using RamFileInfo.fileName( ) or RamFileInfo.filePath( ) Attribute Type Default Description date datetime current date and time The modification date of the file. extension string \"\" The file extension (without the leading . ). isRestoredVersion boolean false True if the corresponding file is a file created from restoring a previous version. project string \"\" The project short name (ID). ramType ItemType \"\" The type of the corresponding item. resource string \"\" The resource string. restoredVersion boolean -1 The version which was restored if isRestoredVersion is true . shortName string \"\" The short name (ID) of the item. state string \"\" The state short name (ID), if any. step string \"\" The step short name (ID). version int -1 The versin, -1 if not set/found.","title":"Attributes"},{"location":"dev/add-ons-reference/ram_file_info/#methods","text":"Method Arguments Description constructor Creates a new empty instance. copy \u25b9 RamFileInfo Creates a copy of the current instance. fileName \u25b9 string Constructs and returns the file name based on the attributes. filePath \u25b9 string Constructs and returns the file path based on the attributes. originalFileName \u25b9 string Gets the original file name without any modification. originalFilePath \u25b9 string Gets the original file path if it was set, without any modification. setFileName \u25b9 boolean Sets the filename and parses data from it. Returns true on success. setFilePath Parses all data which can be found from a file path.","title":"Methods"},{"location":"dev/add-ons-reference/ram_file_info/#special","text":"","title":"Special"},{"location":"dev/add-ons-reference/ram_file_info/#convert-to-string","text":"RamFileInfo s can be converted to string the usual way. This is equivalent to calling RamFileInfo.fileName() . # Python info = RamFileInfo( ) info.setFileName( aFileName ) print( info ) # implicit conversion print( str(info) ) # explicit conversion # Both will print: >>> PROJ_A_anAsset_aStep_aResource.ext // ExtendScript var info = new RamFileInfo( ); info.setFileName( aFileName ); $.writeln( obj.toString() ); // Prints: // PROJ_A_anAsset_aStep_aResource.ext","title":"Convert to string"},{"location":"dev/add-ons-reference/ram_file_info/#comparing-objects","text":"RamFileInfo can be compared to check if two file info are the same, by comparing the attributes except the state and the version . That means all different versions of the same file are considered equal. The location is not compared either: two identical files but in different locations are considered the same. # Python info = RamFileInfo( ) info.setFileName( aFileName ) other = RamFileInfo( ) other.setFileName( anotherFileName ) same = RamFileInfo( ) same.setFileName( aFileNameButAnotherVersionOrLocation ) # RamFileInfo can be compared as any other value info == other # False info == same # True # It can be used with the `in` operator too infoList = [ info, other ] same in infoList # True # But RamFileInfo is not hashable, so it cannot be used in a `set` or as a key in a `dict` // ExtendScript var info = RamFileInfo( ); info.setFileName( aFileName ); var other = RamFileInfo( ); other.setFileName( anotherFileName ); var same = RamFileInfo( ); same.setFileName( aFileNameButAnotherVersionOrLocation ); // RamObject can be compared with the is() method info.is(other) // false info.is(same) // true","title":"Comparing objects"},{"location":"dev/add-ons-reference/ram_file_info/#examples","text":"# Python from ramses import RamFileInfo, ItemType # Get info from an existing asset file filePath = '/path/to/PROJ_A_MyAsset_RIG_aResource.blend' nm = RamFileInfo() if nm.setFileName(filePath: nm.version = 12 # Set the version to 12 nm.state = \"OK\" # Set thje state print( nm.step ) # Prints: RIG print( nm.fileName() ) # Prints: PROJ_A_MyAsset_RIG_aResource_OK012.blend # Build a filename from scratch nm = RamFileInfo() nm.project = \"OTHER\" nm.shortName = \"MyShot\" nm.ramType = ItemType.SHOT nm.step = \"ANIM\" nm.extension = \"kra\" print( nm.fileName() ) # Prints: OTHER_S_MyShot_ANIM.kra # A function to publish a file # Note that this is actually the implementation of RamFileManager.publishFile() def publishFile( filePath ): \"\"\"Copies the given file to its corresponding publish folder\"\"\" fileInfo = RamFileManager.getPublishInfo( filePath ) if fileInfo.project == \"\": return publishFilePath = fileInfo.filePath() RamFileManager.copy( filePath, publishFilePath ) # Keep the date in the metadata, just in case RamMetaDataManager.setDate( publishFilePath, fileInfo.date ) return publishFilePath // ExtendScript #include ramses.jsxinc // Get info from an existing asset file var filePath = '/path/to/PROJ_A_MyAsset_RIG_aResource.blend'; var nm = new RamFileInfo(); if ( nm.setFileName(filePath) ) { nm.version = 12; // Set the version to 12 nm.state = \"OK\"; // Set thje state alert( nm.step ); // Alerts: RIG alert( nm.fileName() ); // Alerts: PROJ_A_MyAsset_RIG_aResource_OK012.blend } // Build a filename from scratch nm = RamFileInfo(); nm.project = \"OTHER\"; nm.shortName = \"MyShot\"; nm.ramType = ItemType.SHOT; nm.step = \"ANIM\"; nm.extension = \"kra\"; alert( nm.fileName() ); // Alerts: OTHER_S_MyShot_ANIM.kra // A function to publish a file // Note that this is actually the implementation of RamFileManager.publishFile() function publishFile( filePath ) { // Copies the given file to its corresponding publish folder var fileInfo = RamFileManager.getPublishInfo( filePath ); if (fileInfo.project == \"\") return var publishFilePath = fileInfo.filePath(); RamFileManager.copy( filePath, publishFilePath ); // Keep the date in the metadata, just in case RamMetaDataManager.setDate( publishFilePath, fileInfo.date ); return publishFilePath; }","title":"Examples"},{"location":"dev/add-ons-reference/ram_file_manager/","text":"RamFileManager Generic tools to handle files and the Ramses Naming Scheme Read the sections about the Ramses Tree and Naming Scheme for more details about names and folders used by Ramses . Static Methods Method Arguments Description buildPath \u25b9 boolean list of string : folders Builds a path with a list of folder names or subpaths, adding the \"/\" only if needed. Paths never include any trailing \"/\" copyToVersion \u25b9 string string : filePath , boolean : increment = false , string : dafaultStateShortName = \"v\" Copies the given file inside the corresponding _versions subfolder, optionnaly incrementing the version number. Use defaultStateShortName to change the state to be used if not found in the current or previous version. Returns the path to the new file. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. getLatestVersionInfo \u25b9 RamFileInfo string : filePath , string : dafaultStateShortName = \"v\" , boolean : previous = false Gets the latest version number and state for the given file, which can be located either in the main folder or one of the _versions , _preview or _published subfolder. Use defaultStateShortName to change the state to be used if not found in the current or previous version. If previous is true, will return the version immediately before the latest one. getLatestVersionFilePath \u25b9 string string : filePath , boolean : previous = false Gets the latest version file path for the given file, which can be located either in the main folder or one of the _versions , _preview or _published subfolder. If previous is true, will return the version immediately before the latest one. getProjectFolder \u25b9 string string : path Gets the root folder of the project this path belongs to. getPublishFolder \u25b9 string string : filePath Gets the published folder path for any given file. getPublishInfo \u25b9 RamFileInfo string : filePath Gets the published information for any given file. getPublishedVersions \u25b9 list of string string : filePath Gets the list of subfolders (versions) from the published folder of this file. getRamsesFiles \u25b9 list of string string : folderPath , string : resource = None Gets all the files respecting the Ramses naming scheme inside the folder, optionally corresponding to the given resource only. getSaveFilePath \u25b9 string string : filePath Gets and returns the path to be used to save the file given as argument, with a name respecting the Ramses Naming Scheme . If the file is in a _versions , _preview or _published folder, the save file is located in the parent folder. getVersionFilePaths \u25b9 string string : filePath Gets the corresponding version files from the _versions folder path for any given file. getVersionFolder \u25b9 string string : filePath Gets the _versions folder path for any given file. inPreviewFolder \u25b9 boolean string : filePath Checks if a given file is located in a _preview folder. inPublishFolder \u25b9 boolean string : filePath Checks if a given file is located in a _published folder. inReservedFolder \u25b9 boolean string : filePath Checks if a given file is located in a _published or _versions or _preview folder. inVersionsFolder \u25b9 boolean string : filePath Checks if a given file is located in a _versions folder. isAssetStep \u25b9 boolean string : stepShortName , string : assetsPath Checks using the information found in assetsPath (which should be the assets folder of a given project) if the given short name corresponds to an asset production step. isProjectFolder \u25b9 boolean string : folderPath Checks if a given folder is the project root folder. isRestoredFilePath \u25b9 boolean or int string : filePath Checks if the file is a working file which has been restored from a previous version (contains \"+restored-vXX+\" in its resource name). If it is a restored older version, the version number is returned, otherwise returns false . isShotStep \u25b9 boolean string : shotShortName , string : shotsPath Checks using the information found in shotsPath (which should be the shots folder of a given project) if the given short name corresponds to a shot production step. publishFile \u25b9 string string : filePath Copies the given file inside the corresponding _published subfolder. Returns the path to the new file. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. restoreVersionFile string : filePath Restores an older version. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. validateName \u25b9 boolean string : name Checks if this name respects the Ramses naming scheme. validateShortName \u25b9 boolean string : shortName Checks if this short name respects the Ramses naming scheme. waitFiles Calling this makes the current thread wait for all file writing threads to finish. API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. Private methods Method Arguments Description _isRamsesItemFoldername \u25b9 boolean string : n Checks if a given folder respects Ramses\u2019 naming convention for items\u2019 root folders. The root folder should look like this: \"projectID_itemType_objectID\"","title":"RamFileManager"},{"location":"dev/add-ons-reference/ram_file_manager/#ramfilemanager","text":"Generic tools to handle files and the Ramses Naming Scheme Read the sections about the Ramses Tree and Naming Scheme for more details about names and folders used by Ramses .","title":"RamFileManager"},{"location":"dev/add-ons-reference/ram_file_manager/#static-methods","text":"Method Arguments Description buildPath \u25b9 boolean list of string : folders Builds a path with a list of folder names or subpaths, adding the \"/\" only if needed. Paths never include any trailing \"/\" copyToVersion \u25b9 string string : filePath , boolean : increment = false , string : dafaultStateShortName = \"v\" Copies the given file inside the corresponding _versions subfolder, optionnaly incrementing the version number. Use defaultStateShortName to change the state to be used if not found in the current or previous version. Returns the path to the new file. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. getLatestVersionInfo \u25b9 RamFileInfo string : filePath , string : dafaultStateShortName = \"v\" , boolean : previous = false Gets the latest version number and state for the given file, which can be located either in the main folder or one of the _versions , _preview or _published subfolder. Use defaultStateShortName to change the state to be used if not found in the current or previous version. If previous is true, will return the version immediately before the latest one. getLatestVersionFilePath \u25b9 string string : filePath , boolean : previous = false Gets the latest version file path for the given file, which can be located either in the main folder or one of the _versions , _preview or _published subfolder. If previous is true, will return the version immediately before the latest one. getProjectFolder \u25b9 string string : path Gets the root folder of the project this path belongs to. getPublishFolder \u25b9 string string : filePath Gets the published folder path for any given file. getPublishInfo \u25b9 RamFileInfo string : filePath Gets the published information for any given file. getPublishedVersions \u25b9 list of string string : filePath Gets the list of subfolders (versions) from the published folder of this file. getRamsesFiles \u25b9 list of string string : folderPath , string : resource = None Gets all the files respecting the Ramses naming scheme inside the folder, optionally corresponding to the given resource only. getSaveFilePath \u25b9 string string : filePath Gets and returns the path to be used to save the file given as argument, with a name respecting the Ramses Naming Scheme . If the file is in a _versions , _preview or _published folder, the save file is located in the parent folder. getVersionFilePaths \u25b9 string string : filePath Gets the corresponding version files from the _versions folder path for any given file. getVersionFolder \u25b9 string string : filePath Gets the _versions folder path for any given file. inPreviewFolder \u25b9 boolean string : filePath Checks if a given file is located in a _preview folder. inPublishFolder \u25b9 boolean string : filePath Checks if a given file is located in a _published folder. inReservedFolder \u25b9 boolean string : filePath Checks if a given file is located in a _published or _versions or _preview folder. inVersionsFolder \u25b9 boolean string : filePath Checks if a given file is located in a _versions folder. isAssetStep \u25b9 boolean string : stepShortName , string : assetsPath Checks using the information found in assetsPath (which should be the assets folder of a given project) if the given short name corresponds to an asset production step. isProjectFolder \u25b9 boolean string : folderPath Checks if a given folder is the project root folder. isRestoredFilePath \u25b9 boolean or int string : filePath Checks if the file is a working file which has been restored from a previous version (contains \"+restored-vXX+\" in its resource name). If it is a restored older version, the version number is returned, otherwise returns false . isShotStep \u25b9 boolean string : shotShortName , string : shotsPath Checks using the information found in shotsPath (which should be the shots folder of a given project) if the given short name corresponds to a shot production step. publishFile \u25b9 string string : filePath Copies the given file inside the corresponding _published subfolder. Returns the path to the new file. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. restoreVersionFile string : filePath Restores an older version. Be careful, this method is multi-threaded, and the script will not wait for the copy to finish to continue; the method may return before the file even exists. validateName \u25b9 boolean string : name Checks if this name respects the Ramses naming scheme. validateShortName \u25b9 boolean string : shortName Checks if this short name respects the Ramses naming scheme. waitFiles Calling this makes the current thread wait for all file writing threads to finish.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_file_manager/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_file_manager/#private-methods","text":"Method Arguments Description _isRamsesItemFoldername \u25b9 boolean string : n Checks if a given folder respects Ramses\u2019 naming convention for items\u2019 root folders. The root folder should look like this: \"projectID_itemType_objectID\"","title":"Private methods"},{"location":"dev/add-ons-reference/ram_filetype/","text":"RamFileType A File type. File types are typically used with RamPipe . Inherits object \u25ba RamObject \u25ba RamFileType Methods Method Arguments Description check \u25b9 boolean string : filePath Checks if the given file is of this type. extensions \u25b9 list of string The extensions which can be used for this file type, excluding the leading \u201c.\u201d","title":"RamFileType"},{"location":"dev/add-ons-reference/ram_filetype/#ramfiletype","text":"A File type. File types are typically used with RamPipe . Inherits object \u25ba RamObject \u25ba RamFileType","title":"RamFileType"},{"location":"dev/add-ons-reference/ram_filetype/#methods","text":"Method Arguments Description check \u25b9 boolean string : filePath Checks if the given file is of this type. extensions \u25b9 list of string The extensions which can be used for this file type, excluding the leading \u201c.\u201d","title":"Methods"},{"location":"dev/add-ons-reference/ram_item/","text":"RamItem Base class for RamAsset and RamShot . An item of the project, either an asset or a shot. Inherits object \u25ba RamObject \u25ba RamItem Inherited by RamShot , RamAsset Static Methods Method Arguments Description fromPath \u25b9 RamItem or None \u2022 string : fileOrFolderPath \u2022 boolean : virtualIfNotFound = false The path can be any file or folder path from the item (a version file, a preview file, etc). Methods Method Arguments Description currentStatus \u25b9 RamStatus \u2022 RamStep or string : step = \"\" The current status for the given step isPublished \u25b9 bool \u2022 RamStep or string : step = \"\" Convenience function to check if there are published files in the publish folder. Equivalent to len(self.publishedVersionFolderPaths(step, resource)) > 0 itemType \u25b9 ItemType The type of this item. One of ItemType.SHOT , ItemType.ASSET , ItemType.GENERAL latestPublishedVersionFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" , \u2022 string : fileName = \"\" , \u2022 string : resource = undefined Folder of the latest published version, for a specific file name and/or resource latestVersion \u25b9 integer \u2022 string : resource = \"\" , \u2022 string : state = \"\" , \u2022 RamStep or string : step *= \"\" Returns the highest version number for the given state (wip, pub\u2026). latestVersionFilePath \u25b9 string \u2022 string : resource = \"\" , \u2022 string : state = \"\" , \u2022 RamStep or string : step = \"\" Latest version file path previewFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Gets the path to the preview folder. Paths are relative to the root of the item folder. previewFilePaths \u25b9 list of string \u2022 string : resource = \"\" , \u2022 RamStep or string : step = \"\" Gets the list of file paths in the preview folder. Paths are relative to the root of the item folder. project \u25b9 RamProject Gets the project this item belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName() projectShortName \u25b9 string Gets the short name of the project this item belongs too. publishedVersionFolderPaths \u25b9 list of string \u2022 RamStep or string : step = \"\" , \u2022 string : fileName = \"\" , \u2022 string : resource * = undefined Gets the list of folder paths in the publish folder, optionally for a given specific file name and/or resource. publishFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Gets the path to the publish folder. Paths are relative to the root of the item folder. setStatus \u2022 RamStatus : status , \u2022 RamStep or string : step Sets the current status for the given step stepFilePath \u25b9 string \u2022 string : resource = \"\" , \u2022 string : extension = \"\" , \u2022 RamStep or string : step *= \"\" Gets the file used for this step with the given file extension. stepFilePaths \u25b9 list of string \u2022 RamStep or string : step *= \"\" Gets the files used for this step (there may be several files, one per resource) stepFolderPath \u25b9 string \u2022 RamStep or string : step *= \"\" The subfolder for the given step stepStatusHistory \u25b9 list of string Gets the list of RamStatus UUIDs for the given step, ordered from oldest to most recent. versionFilePaths \u25b9 string \u2022 string : resource = \"\" , \u2022 RamStep or string : step = \"\" Gets all version files for the given resource. versionFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Path to the version folder relative to the item root folder","title":"RamItem"},{"location":"dev/add-ons-reference/ram_item/#ramitem","text":"Base class for RamAsset and RamShot . An item of the project, either an asset or a shot. Inherits object \u25ba RamObject \u25ba RamItem Inherited by RamShot , RamAsset","title":"RamItem"},{"location":"dev/add-ons-reference/ram_item/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamItem or None \u2022 string : fileOrFolderPath \u2022 boolean : virtualIfNotFound = false The path can be any file or folder path from the item (a version file, a preview file, etc).","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_item/#methods","text":"Method Arguments Description currentStatus \u25b9 RamStatus \u2022 RamStep or string : step = \"\" The current status for the given step isPublished \u25b9 bool \u2022 RamStep or string : step = \"\" Convenience function to check if there are published files in the publish folder. Equivalent to len(self.publishedVersionFolderPaths(step, resource)) > 0 itemType \u25b9 ItemType The type of this item. One of ItemType.SHOT , ItemType.ASSET , ItemType.GENERAL latestPublishedVersionFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" , \u2022 string : fileName = \"\" , \u2022 string : resource = undefined Folder of the latest published version, for a specific file name and/or resource latestVersion \u25b9 integer \u2022 string : resource = \"\" , \u2022 string : state = \"\" , \u2022 RamStep or string : step *= \"\" Returns the highest version number for the given state (wip, pub\u2026). latestVersionFilePath \u25b9 string \u2022 string : resource = \"\" , \u2022 string : state = \"\" , \u2022 RamStep or string : step = \"\" Latest version file path previewFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Gets the path to the preview folder. Paths are relative to the root of the item folder. previewFilePaths \u25b9 list of string \u2022 string : resource = \"\" , \u2022 RamStep or string : step = \"\" Gets the list of file paths in the preview folder. Paths are relative to the root of the item folder. project \u25b9 RamProject Gets the project this item belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName() projectShortName \u25b9 string Gets the short name of the project this item belongs too. publishedVersionFolderPaths \u25b9 list of string \u2022 RamStep or string : step = \"\" , \u2022 string : fileName = \"\" , \u2022 string : resource * = undefined Gets the list of folder paths in the publish folder, optionally for a given specific file name and/or resource. publishFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Gets the path to the publish folder. Paths are relative to the root of the item folder. setStatus \u2022 RamStatus : status , \u2022 RamStep or string : step Sets the current status for the given step stepFilePath \u25b9 string \u2022 string : resource = \"\" , \u2022 string : extension = \"\" , \u2022 RamStep or string : step *= \"\" Gets the file used for this step with the given file extension. stepFilePaths \u25b9 list of string \u2022 RamStep or string : step *= \"\" Gets the files used for this step (there may be several files, one per resource) stepFolderPath \u25b9 string \u2022 RamStep or string : step *= \"\" The subfolder for the given step stepStatusHistory \u25b9 list of string Gets the list of RamStatus UUIDs for the given step, ordered from oldest to most recent. versionFilePaths \u25b9 string \u2022 string : resource = \"\" , \u2022 RamStep or string : step = \"\" Gets all version files for the given resource. versionFolderPath \u25b9 string \u2022 RamStep or string : step = \"\" Path to the version folder relative to the item root folder","title":"Methods"},{"location":"dev/add-ons-reference/ram_metadata_manager/","text":"RamMetaDataManager A Class to get/set metadata from files. Ramses will use a single sidecar file named _ramses_data.json (storing data in json ) for all files located in a given folder; thus the metadata used by Ramses is set on a per-folder basis, and is not copied when a file is copied/moved: it does not make sense for Ramses to have the same metadata when a file is moved. The Meta-Data structure The Meta-Data used by Ramses contains at least these attributes. Key Name Type Default Value Description MetaDataKeys.COMMENT string \"\" A comment associated to the file MetaDataKeys.PIPE_TYPE int \"\" The type of the pipe associated to the file MetaDataKeys.VERSION int -1 A version associated to the file MetaDataKeys.VERSION_FILE string \"\" A version file associated to the file Static Methods Method Arguments Description getComment \u25b9 string string : filePath Gets the comment associated to the file. getDate \u25b9 datetime string : filePath Gets the date associated to the file. getFileMetaData \u25b9 object or dict string : filePath Gets the meta-data of the given file. getMetaData \u25b9 object or dict string : folderPath Gets the meta-data of all the files for the given folder. Each file name is used as a key in the returned object. getMetaDataFile \u25b9 string string : path Gets the path of the file containing the metadata for the given file or folder. getPipeType \u25b9 string string : filePath Gets the type of the pipe which created this file (if it has previously been set by the addon using setPipeType() ). getState \u25b9 string string : filePath Gets the state short name of the file. getValue \u25b9 any string : filePath , string : key Gets the value of a specific key for the file. getVersion \u25b9 int string : filePath Gets the version associated to the file. getVersionFilePath \u25b9 string string : filePath Gets the version file associated to the file. setComment \u25b9 string string : filePath , string : comment Sets the comment associated to a file. setDate \u25b9 string string : filePath , date or datetime or int or string : date Sets the date associated to a file. setFileMetaData string : filePath , object or dict : fileData Writes the given meta-data to the meta-data file associated to this file. setMetaData string : path , object or dict : data Writes the given meta-data to the meta-data file associated to this folder. setPipeType string : filePath , string : pipeType Sets the pipe which created the file. The value should be the short name of the pipe. setState string : filePath , string : state Sets the state for the file. setValue string : filePath , string : key , any : value Sets the value of a specific key for the file. setVersion string : filePath , int : version Sets the version associated to the file. setVersionFilePath string : filePath , string : versionFilePath Sets the version file associated to the file.","title":"RamMetaDataManager"},{"location":"dev/add-ons-reference/ram_metadata_manager/#rammetadatamanager","text":"A Class to get/set metadata from files. Ramses will use a single sidecar file named _ramses_data.json (storing data in json ) for all files located in a given folder; thus the metadata used by Ramses is set on a per-folder basis, and is not copied when a file is copied/moved: it does not make sense for Ramses to have the same metadata when a file is moved.","title":"RamMetaDataManager"},{"location":"dev/add-ons-reference/ram_metadata_manager/#the-meta-data-structure","text":"The Meta-Data used by Ramses contains at least these attributes. Key Name Type Default Value Description MetaDataKeys.COMMENT string \"\" A comment associated to the file MetaDataKeys.PIPE_TYPE int \"\" The type of the pipe associated to the file MetaDataKeys.VERSION int -1 A version associated to the file MetaDataKeys.VERSION_FILE string \"\" A version file associated to the file","title":"The Meta-Data structure"},{"location":"dev/add-ons-reference/ram_metadata_manager/#static-methods","text":"Method Arguments Description getComment \u25b9 string string : filePath Gets the comment associated to the file. getDate \u25b9 datetime string : filePath Gets the date associated to the file. getFileMetaData \u25b9 object or dict string : filePath Gets the meta-data of the given file. getMetaData \u25b9 object or dict string : folderPath Gets the meta-data of all the files for the given folder. Each file name is used as a key in the returned object. getMetaDataFile \u25b9 string string : path Gets the path of the file containing the metadata for the given file or folder. getPipeType \u25b9 string string : filePath Gets the type of the pipe which created this file (if it has previously been set by the addon using setPipeType() ). getState \u25b9 string string : filePath Gets the state short name of the file. getValue \u25b9 any string : filePath , string : key Gets the value of a specific key for the file. getVersion \u25b9 int string : filePath Gets the version associated to the file. getVersionFilePath \u25b9 string string : filePath Gets the version file associated to the file. setComment \u25b9 string string : filePath , string : comment Sets the comment associated to a file. setDate \u25b9 string string : filePath , date or datetime or int or string : date Sets the date associated to a file. setFileMetaData string : filePath , object or dict : fileData Writes the given meta-data to the meta-data file associated to this file. setMetaData string : path , object or dict : data Writes the given meta-data to the meta-data file associated to this folder. setPipeType string : filePath , string : pipeType Sets the pipe which created the file. The value should be the short name of the pipe. setState string : filePath , string : state Sets the state for the file. setValue string : filePath , string : key , any : value Sets the value of a specific key for the file. setVersion string : filePath , int : version Sets the version associated to the file. setVersionFilePath string : filePath , string : versionFilePath Sets the version file associated to the file.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_object/","text":"RamObject The base class for most of Ramses objects. Inherits object \u25ba RamObject Inherited by RamFileType , RamItem , RamPipe , RamPipeFile , RamProject , RamSequence , RamShot , RamState , RamStatus , RamStep , RamUser Static Methods Method Arguments Description isUuid \u25b9 bool \u2022 string : str Checks if a given string is a valid UUID . getUuid \u25b9 string object or string : object Convenience method. Returns the object\u2019s uuid or the string itself; use this to parse arguments in methods which need to use the uuid but can get either an object or a string as an argument. getShortName \u25b9 string object or string : object Convenience method. Returns the object\u2019s short name; the argument could be either the uuid or an object, or even a short name already. Methods Method Arguments Description constructor \u2022 string : uuid = \"\" \u2022 Object / Dict : data = None \u2022 bool : create = false \u2022 string : objectType = \"RamObject\" You should always provide the UUID unless you\u2019re creating a new object. In this case, set create = true and the object type. An object without UUID nor the create option will be virtual . color \u25b9 list of int The color used to display this object, as an [R, G, B] list. colorName \u25b9 string The color used to display this object, as an \"#000000\" string. comment \u25b9 string The comment for this object. data \u25b9 Object / dict The data of this object. folderPath \u25b9 string The path of this object (or an empty string). get \u25b9 any \u2022 string : key \u2022 any : default = None Gets a specific value from the data. If the key can\u2019t be found, returns the default value. name \u25b9 string The name of this object. set \u25b9 any \u2022 string : key \u2022 any : value Sets a specific value in the data. setData \u25b9 string \u2022 string or Object / Dict : data Sets new internal data for this object (and sends it to the application). shortName \u25b9 string The short name of this object. uuid \u25b9 string The universal unique identified (UUID) of this object. virtual \u25b9 bool Checks if this object is virtual. A virtual object is an object which is not saved in the system and will disappear after when the program quits. Invalid UUIDs will be converted to virtual objects. Special Convert to string RamObject s can be converted to string the usual way. # Python obj = RamObject( \"Name\", \"ShortName\" ) print( obj ) # implicit conversion print( str(obj) ) # explicit conversion # Both will print: >>> ShortName | Name // ExtendScript var obj = new RamObject( \"Name\", \"ShortName\" ); $.writeln( obj.toString() ); // Prints: // ShortName | Name Comparing objects RamObjects can be compared to check if two objects are the same (comparing the values, not the object instances). Two objects are considered the same if and only if their UUIDs are the same. Names will not be compared. # Python obj = RamObject( \"unique-uid1\" ) other = RamObject( \"unique-uid2\" ) same = RamObject( \"unique-uid1\" ) # RamObject can be compared as any other value obj == other # False obj == same # True # It can be used with the `in` operator too objList = [ obj, other ] same in objList # True # But RamObject is not hashable, so it cannot be used in a `set` or as a key in a `dict` // ExtendScript var obj = RamObject( \"unique-uid1\" ); var other = RamObject( \"unique-uid2\" ); var same = RamObject( \"unique-uid1\" ); // RamObject can be compared with the is() method obj.is(other) // false obj.is(same) // true Cached data To limit the number of queries to the Ramses Daemon and improve performance, the data is cached for two seconds. That means any change in the Ramses Application (by the user or a sync process) in between two calls on a RamObject instance will be ignored if there is less than two seconds between these calls. A way to force the update of the data is to reinit the internal data of the RamObject to an empty dictionnary/object. # Python # Create an object obj = RamObject(\"unique-uid\") # Get some info name = obj.name() # Do stuff, in less than two seconds. # If we absolutely need the latest data # (i.e. it may have changed since the call to 'name()') # reset the internal data obj.__data = {} # Now we can get up-to-date data name = obj.name() // ExtendScript // Create an object var obj = new RamObject(\"unique-uid\"); // Get some info var name = obj.name(); // Do stuff, in less than two seconds. // If we absolutely need the latest data // (i.e. it may have changed since the call to 'name()') // reset the internal data obj.__data = {}; // Now we can get up-to-date data name = obj.name(); Note When setting new data, the cache is automatically updated first, to be sure to avoid conflicts. API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. Implementation Converting objects to string # Python # Overload the __str__() method class RamObject: def __str__( self ): return self.shortName() + \" | \" + self.name() // ExtendScript // Overload the toString() method function RamObject() {}; RamObject.prototype.toString = function () { return this.shortName() + \" | \" + this.name(); } Object comparison # Python # Overload the __eq__() method class RamObject: def __eq__( self, other ): return self.__uuid == other.uuid() // ExtendScript // Implements an is() method function RamObject() {}; RamObject.prototype.is = function ( other ) { return this.__uuid == other.__uuid; }","title":"RamObject"},{"location":"dev/add-ons-reference/ram_object/#ramobject","text":"The base class for most of Ramses objects. Inherits object \u25ba RamObject Inherited by RamFileType , RamItem , RamPipe , RamPipeFile , RamProject , RamSequence , RamShot , RamState , RamStatus , RamStep , RamUser","title":"RamObject"},{"location":"dev/add-ons-reference/ram_object/#static-methods","text":"Method Arguments Description isUuid \u25b9 bool \u2022 string : str Checks if a given string is a valid UUID . getUuid \u25b9 string object or string : object Convenience method. Returns the object\u2019s uuid or the string itself; use this to parse arguments in methods which need to use the uuid but can get either an object or a string as an argument. getShortName \u25b9 string object or string : object Convenience method. Returns the object\u2019s short name; the argument could be either the uuid or an object, or even a short name already.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_object/#methods","text":"Method Arguments Description constructor \u2022 string : uuid = \"\" \u2022 Object / Dict : data = None \u2022 bool : create = false \u2022 string : objectType = \"RamObject\" You should always provide the UUID unless you\u2019re creating a new object. In this case, set create = true and the object type. An object without UUID nor the create option will be virtual . color \u25b9 list of int The color used to display this object, as an [R, G, B] list. colorName \u25b9 string The color used to display this object, as an \"#000000\" string. comment \u25b9 string The comment for this object. data \u25b9 Object / dict The data of this object. folderPath \u25b9 string The path of this object (or an empty string). get \u25b9 any \u2022 string : key \u2022 any : default = None Gets a specific value from the data. If the key can\u2019t be found, returns the default value. name \u25b9 string The name of this object. set \u25b9 any \u2022 string : key \u2022 any : value Sets a specific value in the data. setData \u25b9 string \u2022 string or Object / Dict : data Sets new internal data for this object (and sends it to the application). shortName \u25b9 string The short name of this object. uuid \u25b9 string The universal unique identified (UUID) of this object. virtual \u25b9 bool Checks if this object is virtual. A virtual object is an object which is not saved in the system and will disappear after when the program quits. Invalid UUIDs will be converted to virtual objects.","title":"Methods"},{"location":"dev/add-ons-reference/ram_object/#special","text":"","title":"Special"},{"location":"dev/add-ons-reference/ram_object/#convert-to-string","text":"RamObject s can be converted to string the usual way. # Python obj = RamObject( \"Name\", \"ShortName\" ) print( obj ) # implicit conversion print( str(obj) ) # explicit conversion # Both will print: >>> ShortName | Name // ExtendScript var obj = new RamObject( \"Name\", \"ShortName\" ); $.writeln( obj.toString() ); // Prints: // ShortName | Name","title":"Convert to string"},{"location":"dev/add-ons-reference/ram_object/#comparing-objects","text":"RamObjects can be compared to check if two objects are the same (comparing the values, not the object instances). Two objects are considered the same if and only if their UUIDs are the same. Names will not be compared. # Python obj = RamObject( \"unique-uid1\" ) other = RamObject( \"unique-uid2\" ) same = RamObject( \"unique-uid1\" ) # RamObject can be compared as any other value obj == other # False obj == same # True # It can be used with the `in` operator too objList = [ obj, other ] same in objList # True # But RamObject is not hashable, so it cannot be used in a `set` or as a key in a `dict` // ExtendScript var obj = RamObject( \"unique-uid1\" ); var other = RamObject( \"unique-uid2\" ); var same = RamObject( \"unique-uid1\" ); // RamObject can be compared with the is() method obj.is(other) // false obj.is(same) // true","title":"Comparing objects"},{"location":"dev/add-ons-reference/ram_object/#cached-data","text":"To limit the number of queries to the Ramses Daemon and improve performance, the data is cached for two seconds. That means any change in the Ramses Application (by the user or a sync process) in between two calls on a RamObject instance will be ignored if there is less than two seconds between these calls. A way to force the update of the data is to reinit the internal data of the RamObject to an empty dictionnary/object. # Python # Create an object obj = RamObject(\"unique-uid\") # Get some info name = obj.name() # Do stuff, in less than two seconds. # If we absolutely need the latest data # (i.e. it may have changed since the call to 'name()') # reset the internal data obj.__data = {} # Now we can get up-to-date data name = obj.name() // ExtendScript // Create an object var obj = new RamObject(\"unique-uid\"); // Get some info var name = obj.name(); // Do stuff, in less than two seconds. // If we absolutely need the latest data // (i.e. it may have changed since the call to 'name()') // reset the internal data obj.__data = {}; // Now we can get up-to-date data name = obj.name(); Note When setting new data, the cache is automatically updated first, to be sure to avoid conflicts.","title":"Cached data"},{"location":"dev/add-ons-reference/ram_object/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_object/#implementation","text":"","title":"Implementation"},{"location":"dev/add-ons-reference/ram_object/#converting-objects-to-string","text":"# Python # Overload the __str__() method class RamObject: def __str__( self ): return self.shortName() + \" | \" + self.name() // ExtendScript // Overload the toString() method function RamObject() {}; RamObject.prototype.toString = function () { return this.shortName() + \" | \" + this.name(); }","title":"Converting objects to string"},{"location":"dev/add-ons-reference/ram_object/#object-comparison","text":"# Python # Overload the __eq__() method class RamObject: def __eq__( self, other ): return self.__uuid == other.uuid() // ExtendScript // Implements an is() method function RamObject() {}; RamObject.prototype.is = function ( other ) { return this.__uuid == other.__uuid; }","title":"Object comparison"},{"location":"dev/add-ons-reference/ram_pipe/","text":"RamPipe A pipe which connects two steps together in the production pipeline. The pipe goes from the output step (which exports data into specific file types represented by the RamPipeFile class) to the input step (which imports that data). Inherits object \u25ba RamObject \u25ba RamPipe Methods Method Arguments Description inputStep \u25b9 RamStep The input step inputStepShortName \u25b9 string The short name of the input step outputStep \u25b9 RamStep The output step outputStepShortName \u25b9 string The short name of the output step pipeFiles \u25b9 list of RamPipeFile The list of pipe files used through this step","title":"RamPipe"},{"location":"dev/add-ons-reference/ram_pipe/#rampipe","text":"A pipe which connects two steps together in the production pipeline. The pipe goes from the output step (which exports data into specific file types represented by the RamPipeFile class) to the input step (which imports that data). Inherits object \u25ba RamObject \u25ba RamPipe","title":"RamPipe"},{"location":"dev/add-ons-reference/ram_pipe/#methods","text":"Method Arguments Description inputStep \u25b9 RamStep The input step inputStepShortName \u25b9 string The short name of the input step outputStep \u25b9 RamStep The output step outputStepShortName \u25b9 string The short name of the output step pipeFiles \u25b9 list of RamPipeFile The list of pipe files used through this step","title":"Methods"},{"location":"dev/add-ons-reference/ram_pipefile/","text":"RamPipeFile A file which goes through a RamPipe . Inherits object \u25ba RamObject \u25ba RamPipeFile Methods Method Arguments Description check \u25b9 boolean string : filePath Checks if the given file can go through this pipe. colorSpace \u25b9 string The color space used through the pipe. customSettings \u25b9 string Can be any string which can be set from the pipeline editor in the Ramses Client Application . Use this to add more information to configure your pipeline and pass this information to the addons. getFiles \u25b9 list of string string : folderPath Gets all the files which can go through this pipe in the given folder. fileType \u25b9 RamFileType The file type used through the pipe.","title":"RamPipeFile"},{"location":"dev/add-ons-reference/ram_pipefile/#rampipefile","text":"A file which goes through a RamPipe . Inherits object \u25ba RamObject \u25ba RamPipeFile","title":"RamPipeFile"},{"location":"dev/add-ons-reference/ram_pipefile/#methods","text":"Method Arguments Description check \u25b9 boolean string : filePath Checks if the given file can go through this pipe. colorSpace \u25b9 string The color space used through the pipe. customSettings \u25b9 string Can be any string which can be set from the pipeline editor in the Ramses Client Application . Use this to add more information to configure your pipeline and pass this information to the addons. getFiles \u25b9 list of string string : folderPath Gets all the files which can go through this pipe in the given folder. fileType \u25b9 RamFileType The file type used through the pipe.","title":"Methods"},{"location":"dev/add-ons-reference/ram_project/","text":"RamProject A project handled by Ramses. Projects contains general items, assets and shots. Inherits object \u25ba RamObject \u25ba RamProject Static Methods Method Arguments Description fromPath \u25b9 RamProject string : path Returns a RamProject instance built using the given path. The path can be any file or folder path from the project Methods Method Arguments Description adminPath \u25b9 str The path to the administration files of this project. When calling this method, the folder will created if it does not exist yet. absolutePath \u25b9 str string : relativePath Builds an absolute path from a path relative to the project path assetGroups \u25b9 list of RamAssetGroup Available asset groups in this project assets \u25b9 list of RamAsset RamAssetGroup : assetGroup = None Available assets in this project and group. If groupName is an empty string, returns all assets. assetsPath \u25b9 str string : assetGroup = \"\" The path to the assets (including the asset group if provided) of this project. When calling this method, the folder will created if it does not exist yet. exportPath \u25b9 str The path to the exported medias of this project. When calling this method, the folder will created if it does not exist yet. folderPath \u25b9 string The project\u2019s root folder. framerate \u25b9 float The project\u2019s framerate, in frames per second. height \u25b9 int The project\u2019s height, in pixels. pipes \u25b9 list of RamPipe Available pipes in this project postProdPath \u25b9 str The path to the post-production steps common files of this project. When calling this method, the folder will created if it does not exist yet. preProdPath \u25b9 str The path to the pre-production steps common files of this project. When calling this method, the folder will created if it does not exist yet. prodPath \u25b9 str The path to the production steps common files of this project. When calling this method, the folder will created if it does not exist yet. sequences \u25b9 list of RamSequence Available sequences in this project shots \u25b9 RamShot string : nameFilter = \"*\" , RamSequence : sequence = None Available shots in this project shotsPath \u25b9 str The path to the shots of this project. When calling this method, the folder will created if it does not exist yet. step \u25b9 RamStep or None string : shortName (Try to) retrieve a step from its short name. steps \u25b9 list of RamStep enumerated value : type = RamStep.ALL Available steps in this project. Use type to filter the results. One of: StepType.ALL , StepType.ASSET_PODUCTION , StepType.SHOT_PRODUCTION , StepType.PRE_PRODUCTION , StepType.PRODUCTION , StepType.POST_PRODUCTION . StepType.PRODUCTION represents a combination of SHOT and ASSET . width \u25b9 int The project\u2019s width, in pixels. API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. Private methods Method Arguments Description _getAssetsInFolder \u25b9 list of RamAsset string : folderPath , RamAssetGroup : assetGroup = None Recursively gets all assets contained in the given folder.","title":"RamProject"},{"location":"dev/add-ons-reference/ram_project/#ramproject","text":"A project handled by Ramses. Projects contains general items, assets and shots. Inherits object \u25ba RamObject \u25ba RamProject","title":"RamProject"},{"location":"dev/add-ons-reference/ram_project/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamProject string : path Returns a RamProject instance built using the given path. The path can be any file or folder path from the project","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_project/#methods","text":"Method Arguments Description adminPath \u25b9 str The path to the administration files of this project. When calling this method, the folder will created if it does not exist yet. absolutePath \u25b9 str string : relativePath Builds an absolute path from a path relative to the project path assetGroups \u25b9 list of RamAssetGroup Available asset groups in this project assets \u25b9 list of RamAsset RamAssetGroup : assetGroup = None Available assets in this project and group. If groupName is an empty string, returns all assets. assetsPath \u25b9 str string : assetGroup = \"\" The path to the assets (including the asset group if provided) of this project. When calling this method, the folder will created if it does not exist yet. exportPath \u25b9 str The path to the exported medias of this project. When calling this method, the folder will created if it does not exist yet. folderPath \u25b9 string The project\u2019s root folder. framerate \u25b9 float The project\u2019s framerate, in frames per second. height \u25b9 int The project\u2019s height, in pixels. pipes \u25b9 list of RamPipe Available pipes in this project postProdPath \u25b9 str The path to the post-production steps common files of this project. When calling this method, the folder will created if it does not exist yet. preProdPath \u25b9 str The path to the pre-production steps common files of this project. When calling this method, the folder will created if it does not exist yet. prodPath \u25b9 str The path to the production steps common files of this project. When calling this method, the folder will created if it does not exist yet. sequences \u25b9 list of RamSequence Available sequences in this project shots \u25b9 RamShot string : nameFilter = \"*\" , RamSequence : sequence = None Available shots in this project shotsPath \u25b9 str The path to the shots of this project. When calling this method, the folder will created if it does not exist yet. step \u25b9 RamStep or None string : shortName (Try to) retrieve a step from its short name. steps \u25b9 list of RamStep enumerated value : type = RamStep.ALL Available steps in this project. Use type to filter the results. One of: StepType.ALL , StepType.ASSET_PODUCTION , StepType.SHOT_PRODUCTION , StepType.PRE_PRODUCTION , StepType.PRODUCTION , StepType.POST_PRODUCTION . StepType.PRODUCTION represents a combination of SHOT and ASSET . width \u25b9 int The project\u2019s width, in pixels.","title":"Methods"},{"location":"dev/add-ons-reference/ram_project/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_project/#private-methods","text":"Method Arguments Description _getAssetsInFolder \u25b9 list of RamAsset string : folderPath , RamAssetGroup : assetGroup = None Recursively gets all assets contained in the given folder.","title":"Private methods"},{"location":"dev/add-ons-reference/ram_sequence/","text":"RamSequence A group of shots. Inherits object \u25ba RamObject \u25ba RamSequence Methods Method Arguments Description project \u25b9 RamProject The project containing this sequence.","title":"RamSequence"},{"location":"dev/add-ons-reference/ram_sequence/#ramsequence","text":"A group of shots. Inherits object \u25ba RamObject \u25ba RamSequence","title":"RamSequence"},{"location":"dev/add-ons-reference/ram_sequence/#methods","text":"Method Arguments Description project \u25b9 RamProject The project containing this sequence.","title":"Methods"},{"location":"dev/add-ons-reference/ram_settings/","text":"RamSettings Gets and saves settings used by Ramses. One (and only one) instance globally available (RamSettings is a singleton ), by calling RamSettings.instance() or Ramses.instance().settings() . To get a setting, just get the corresponding attribute. To change a setting temporarily, just set the corresponding attribute. If you want the change to be permanent (i.e. keep the setting for the next sessions), call the save() method. By default, settings are saved in a ramses_addons_settings.json file, in the user\u2019s OS specific settings folder: Linux: ~/.config/RxLaboratory/Ramses/Config Windows: %appdata%/RxLaboratory/Ramses/Config MacOS: ? Static Methods Method Arguments Description instance \u25b9 RamSettings Returns the RamSettings unique instance. Attributes To retrieve the default values after the settings have been changed, access them with the attributes which names start with default . Attribute Type Default Description addonsHelpUrl string The URL to this page Read-only. A link to the Ramses add-ons documentation apiReferenceUrl string This page URL Read-only. A link to this API documentation autoIncrementTimeout int 120 Timeout before auto incrementing a file, in minutes. debugMode boolean false Set to true to throw errors and other debug info when developping add-ons. defaultAutoIncrementTimeout int 120 defaultDebugMode boolean false defaultOnline boolean true defaultRamsesClientPath string os-specific defaultRamsesClientPort integer 18185 defaultRamsesFolderPath string \"~/Ramses\" defaultLogLevel LogLevel LogLevel.Info generalHelpUrl string The URL to this documentation Read-only. A link to the Ramses documentation logLevel LogLevel LogLevel.Info Changes the quantity of messages in the log. One of: LogLevel.DataReceived , LogLevel.DataSent , LogLevel.Debug , LogLevel.Info , LogLevel.Critical , LogLevel.Fatal online boolean true Wether to always try to (re)connect to the Daemon if offline. ramsesClientPath string os-specific Location of the Ramses Client executable file (.exe on Windows, .app on MacOS, .appimage or binary on Linux) ramsesClientPort integer 18185 Listening port of the Ramses Daemon ramsesFolderPath string \"~/Ramses\" The folder containing all Ramses files (settings, projects, etc) userSettings dict or object {} Use this attribute to store your own settings. You can add as many key/value pairs as you need, they will be saved with the RamSettings.save() method too. version string The current API version Read-only. Methods Method Arguments Description save Saves the current settings to the disk. folderPath \u25b9 string The folder path to the settings filePath \u25b9 string The file path to the settings API Dev notes Note This section is for the development of the API only; you should not need these when developping your add-on using the API. Private Attributes Attribute Type Default Description folderNames FolderNames A simple class containing the common names for subfolders. See the constants for more information. Examples ramses = Ramses.instance settings = ramses.settings theAsset = RamAsset(\"thing\", \"stuff\") thePreviewFolder = theAsset.folderPath() + \"/\" + settings.folderNames.preview","title":"RamSettings"},{"location":"dev/add-ons-reference/ram_settings/#ramsettings","text":"Gets and saves settings used by Ramses. One (and only one) instance globally available (RamSettings is a singleton ), by calling RamSettings.instance() or Ramses.instance().settings() . To get a setting, just get the corresponding attribute. To change a setting temporarily, just set the corresponding attribute. If you want the change to be permanent (i.e. keep the setting for the next sessions), call the save() method. By default, settings are saved in a ramses_addons_settings.json file, in the user\u2019s OS specific settings folder: Linux: ~/.config/RxLaboratory/Ramses/Config Windows: %appdata%/RxLaboratory/Ramses/Config MacOS: ?","title":"RamSettings"},{"location":"dev/add-ons-reference/ram_settings/#static-methods","text":"Method Arguments Description instance \u25b9 RamSettings Returns the RamSettings unique instance.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_settings/#attributes","text":"To retrieve the default values after the settings have been changed, access them with the attributes which names start with default . Attribute Type Default Description addonsHelpUrl string The URL to this page Read-only. A link to the Ramses add-ons documentation apiReferenceUrl string This page URL Read-only. A link to this API documentation autoIncrementTimeout int 120 Timeout before auto incrementing a file, in minutes. debugMode boolean false Set to true to throw errors and other debug info when developping add-ons. defaultAutoIncrementTimeout int 120 defaultDebugMode boolean false defaultOnline boolean true defaultRamsesClientPath string os-specific defaultRamsesClientPort integer 18185 defaultRamsesFolderPath string \"~/Ramses\" defaultLogLevel LogLevel LogLevel.Info generalHelpUrl string The URL to this documentation Read-only. A link to the Ramses documentation logLevel LogLevel LogLevel.Info Changes the quantity of messages in the log. One of: LogLevel.DataReceived , LogLevel.DataSent , LogLevel.Debug , LogLevel.Info , LogLevel.Critical , LogLevel.Fatal online boolean true Wether to always try to (re)connect to the Daemon if offline. ramsesClientPath string os-specific Location of the Ramses Client executable file (.exe on Windows, .app on MacOS, .appimage or binary on Linux) ramsesClientPort integer 18185 Listening port of the Ramses Daemon ramsesFolderPath string \"~/Ramses\" The folder containing all Ramses files (settings, projects, etc) userSettings dict or object {} Use this attribute to store your own settings. You can add as many key/value pairs as you need, they will be saved with the RamSettings.save() method too. version string The current API version Read-only.","title":"Attributes"},{"location":"dev/add-ons-reference/ram_settings/#methods","text":"Method Arguments Description save Saves the current settings to the disk. folderPath \u25b9 string The folder path to the settings filePath \u25b9 string The file path to the settings","title":"Methods"},{"location":"dev/add-ons-reference/ram_settings/#api-dev-notes","text":"Note This section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_settings/#private-attributes","text":"Attribute Type Default Description folderNames FolderNames A simple class containing the common names for subfolders. See the constants for more information.","title":"Private Attributes"},{"location":"dev/add-ons-reference/ram_settings/#examples","text":"ramses = Ramses.instance settings = ramses.settings theAsset = RamAsset(\"thing\", \"stuff\") thePreviewFolder = theAsset.folderPath() + \"/\" + settings.folderNames.preview","title":"Examples"},{"location":"dev/add-ons-reference/ram_shot/","text":"RamShot A shot. Inherits object \u25ba RamObject \u25ba RamItem \u25ba RamShot Static Methods Method Arguments Description fromPath \u25b9 RamShot string : folderPath Returns a RamShot instance built using the given folder path. The path can be any file or folder path from the asset (a version file, a preview file, etc) Methods Method Arguments Description constructor string : shotName , string : shotShortName , string : shotFolder , float : duration = 0.0 duration \u25b9 float The shot duration, in seconds frames \u25b9 int The shot duration, in frames group \u25b9 string The name of the sequence containing this shot. sequence \u25b9 RamSequence The sequence containing this shot. API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. (Im)mutable data The data returned by the methods can be either mutable or immutable . Method Type of the returned data duration Mutable","title":"RamShot"},{"location":"dev/add-ons-reference/ram_shot/#ramshot","text":"A shot. Inherits object \u25ba RamObject \u25ba RamItem \u25ba RamShot","title":"RamShot"},{"location":"dev/add-ons-reference/ram_shot/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamShot string : folderPath Returns a RamShot instance built using the given folder path. The path can be any file or folder path from the asset (a version file, a preview file, etc)","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_shot/#methods","text":"Method Arguments Description constructor string : shotName , string : shotShortName , string : shotFolder , float : duration = 0.0 duration \u25b9 float The shot duration, in seconds frames \u25b9 int The shot duration, in frames group \u25b9 string The name of the sequence containing this shot. sequence \u25b9 RamSequence The sequence containing this shot.","title":"Methods"},{"location":"dev/add-ons-reference/ram_shot/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ram_shot/#immutable-data","text":"The data returned by the methods can be either mutable or immutable . Method Type of the returned data duration Mutable","title":"(Im)mutable data"},{"location":"dev/add-ons-reference/ram_state/","text":"RamState Represents a state used in a status, like \u201cCHK\u201d (To be checked), \u201cOK\u201d (ok), \u201cTODO\u201d, etc. Inherits object \u25ba RamObject \u25ba RamState Methods Method Arguments Description completionRatio \u25b9 integer The ratio of completion of this state in the range [0, 100] .","title":"RamState"},{"location":"dev/add-ons-reference/ram_state/#ramstate","text":"Represents a state used in a status, like \u201cCHK\u201d (To be checked), \u201cOK\u201d (ok), \u201cTODO\u201d, etc. Inherits object \u25ba RamObject \u25ba RamState","title":"RamState"},{"location":"dev/add-ons-reference/ram_state/#methods","text":"Method Arguments Description completionRatio \u25b9 integer The ratio of completion of this state in the range [0, 100] .","title":"Methods"},{"location":"dev/add-ons-reference/ram_status/","text":"RamStatus A state associated to a comment, the user who changed the state, etc. Inherits object \u25ba RamObject \u25ba RamStatus Static Methods Method Arguments Description fromPath \u25b9 RamStatus string : filePath Returns a RamStatus instance built using the given file path. Methods Method Arguments Description completionRatio \u25b9 integer The ratio of completion of this status. date \u25b9 datetime The date at which this status was created. item \u25b9 RamAsset or RamItem or RamShot The item this status refers to. published \u25b9 boolean True if this version of the item has been published. state \u25b9 RamState The corresponding state. user \u25b9 RamUser The user who created this status. version \u25b9 integer The version of the corresponding working file. setCompletionRatio \u2022 integer : completion Sets the ratio of completion of this status. setPublished \u2022 boolean : published = true Sets if this version of the item has been published. setState \u2022 RamState : state Sets the corresponding state. setUser \u2022 RamUser : user Sets the user who created this status. setVersion \u2022 integer : version Sets the version of the corresponding working file. step \u25b9 RamStep The step this status refers to.","title":"RamStatus"},{"location":"dev/add-ons-reference/ram_status/#ramstatus","text":"A state associated to a comment, the user who changed the state, etc. Inherits object \u25ba RamObject \u25ba RamStatus","title":"RamStatus"},{"location":"dev/add-ons-reference/ram_status/#static-methods","text":"Method Arguments Description fromPath \u25b9 RamStatus string : filePath Returns a RamStatus instance built using the given file path.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_status/#methods","text":"Method Arguments Description completionRatio \u25b9 integer The ratio of completion of this status. date \u25b9 datetime The date at which this status was created. item \u25b9 RamAsset or RamItem or RamShot The item this status refers to. published \u25b9 boolean True if this version of the item has been published. state \u25b9 RamState The corresponding state. user \u25b9 RamUser The user who created this status. version \u25b9 integer The version of the corresponding working file. setCompletionRatio \u2022 integer : completion Sets the ratio of completion of this status. setPublished \u2022 boolean : published = true Sets if this version of the item has been published. setState \u2022 RamState : state Sets the corresponding state. setUser \u2022 RamUser : user Sets the user who created this status. setVersion \u2022 integer : version Sets the version of the corresponding working file. step \u25b9 RamStep The step this status refers to.","title":"Methods"},{"location":"dev/add-ons-reference/ram_step/","text":"RamStep A step in the production of the shots or assets of the project. Inherits object \u25ba RamObject \u25ba RamStep Static Methods Method Arguments Description fromDict \u25b9 RamStep dict or object : stepDict Builds a RamStep from a dict or object like the one returned by the RamDaemonInterface fromPath \u25b9 RamStep string : path Returns a RamStep instance built using the given file path. Methods Method Arguments Description constructor string : stepName , string : stepShortName , string : stepFolderPath = \"\" , StepType : stepType = \"\" At least the folder or the type must be provided, but one is enough as the other info can be gotten from the Ramses Tree generalSettings \u25b9 string The general settings for this step. It is meant to be a YAML string, but can actually be anything. inputPipes \u25b9 list of RamPipe The pipes comming into this step. outputPipes \u25b9 list of RamPipe The pipes going out of this step. project \u25b9 RamProject Gets the project this step belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName() projectShortName \u25b9 string Gets the short name of the project this step belongs too. publishSettings \u25b9 string The publish settings for this step. It is meant to be a YAML string, but can actually be anything. setGeneralSettings string : settings Sets new general settings. It is meant to be a YAML string, but can actually be anything. setPublishSettings string : settings Sets new publish settings. It is meant to be a YAML string, but can actually be anything. stepType \u25b9 StepType The type of this step, one of StepType.PRE_PRODUCTION , StepType.SHOT_PRODUCTION , StepType.ASSET_PRODUCTION , StepType.POST_PRODUCTION templatesFolderPath \u25b9 string The absolute path to the folder containing the template files for this step templatesPublishFilePaths \u25b9 list of string The list of published files for the templates templatesPublishPath \u25b9 string The absolute path to the folder where templates are published","title":"RamStep"},{"location":"dev/add-ons-reference/ram_step/#ramstep","text":"A step in the production of the shots or assets of the project. Inherits object \u25ba RamObject \u25ba RamStep","title":"RamStep"},{"location":"dev/add-ons-reference/ram_step/#static-methods","text":"Method Arguments Description fromDict \u25b9 RamStep dict or object : stepDict Builds a RamStep from a dict or object like the one returned by the RamDaemonInterface fromPath \u25b9 RamStep string : path Returns a RamStep instance built using the given file path.","title":"Static Methods"},{"location":"dev/add-ons-reference/ram_step/#methods","text":"Method Arguments Description constructor string : stepName , string : stepShortName , string : stepFolderPath = \"\" , StepType : stepType = \"\" At least the folder or the type must be provided, but one is enough as the other info can be gotten from the Ramses Tree generalSettings \u25b9 string The general settings for this step. It is meant to be a YAML string, but can actually be anything. inputPipes \u25b9 list of RamPipe The pipes comming into this step. outputPipes \u25b9 list of RamPipe The pipes going out of this step. project \u25b9 RamProject Gets the project this step belongs too. To improve performance, if only the shortName is needed, prefer using projectShortName() projectShortName \u25b9 string Gets the short name of the project this step belongs too. publishSettings \u25b9 string The publish settings for this step. It is meant to be a YAML string, but can actually be anything. setGeneralSettings string : settings Sets new general settings. It is meant to be a YAML string, but can actually be anything. setPublishSettings string : settings Sets new publish settings. It is meant to be a YAML string, but can actually be anything. stepType \u25b9 StepType The type of this step, one of StepType.PRE_PRODUCTION , StepType.SHOT_PRODUCTION , StepType.ASSET_PRODUCTION , StepType.POST_PRODUCTION templatesFolderPath \u25b9 string The absolute path to the folder containing the template files for this step templatesPublishFilePaths \u25b9 list of string The list of published files for the templates templatesPublishPath \u25b9 string The absolute path to the folder where templates are published","title":"Methods"},{"location":"dev/add-ons-reference/ram_user/","text":"RamUser The class representing users. Inherits object \u25ba RamObject \u25ba RamUser Methods Method Arguments Description comment \u25b9 string A comment associated to the user configPath \u25b9 string The path to the Config folder for this user role \u25b9 UserRole One of UserRole.ADMIN , UserRole.PROJECT_ADMIN , UserRole.LEAD or UserRole.STANDARD","title":"RamUser"},{"location":"dev/add-ons-reference/ram_user/#ramuser","text":"The class representing users. Inherits object \u25ba RamObject \u25ba RamUser","title":"RamUser"},{"location":"dev/add-ons-reference/ram_user/#methods","text":"Method Arguments Description comment \u25b9 string A comment associated to the user configPath \u25b9 string The path to the Config folder for this user role \u25b9 UserRole One of UserRole.ADMIN , UserRole.PROJECT_ADMIN , UserRole.LEAD or UserRole.STANDARD","title":"Methods"},{"location":"dev/add-ons-reference/ramses/","text":"Ramses The main class. One (and only one) instance globally available (Ramses is a singleton ), by calling Ramses.instance() . Static Methods Method Arguments Description instance \u25b9 Ramses Returns the Ramses unique instance. version \u25b9 string The current version of this API Static Attributes Attribute Type Default Description apiReferenceUrl string This page URL A link to this API documentation addonsHelpUrl string The URL to this page A link to the Ramses add-ons documentation generalHelpUrl string The URL to this documentation A link to the Ramses documentation Attributes Read the section entitled Callbacks below (and see the Examples ) for more information about the methods you can add to these lists. Attribute Type Default Description importScripts list [] A list of scripts/functions to be triggered when Ramses.instance().importItem() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user asks to import an item. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. publishScripts list [] A list of scripts/functions to be triggered when Ramses.instance().publish() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user publishes the current file from the host application. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. replaceScripts list [] A list of scripts/functions to be triggered when Ramses.instance().replaceItem() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user asks to import an item. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. statusScripts list [] A list of scripts/functions to be triggered when Ramses.instance().updateStatus() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user changes the current status of an asset / shot from the host application. userScripts dict or object {} This dict or object is here for your convenience, to make it easy to register and call any method from anywhere you\u2019ve imported Ramses without having to import the file containing the method. Just register with Ramses.instance().userScripts[\"TheFunctionName\"] = aFunction and call the method with Ramses.instance().userScripts[\"TheFunctionName\"](some, args) . Methods Method Arguments Description alternativeFolderPaths \u25b9 list of string A list of alternative absolute paths to the main Ramses folder. Missing files will be looked for in these paths (and copied to the main path if available), and they will be used if the main path is not available. backupFolderPath \u25b9 list of string A copy of the main folder where all files are stored. connect \u25b9 boolean Checks Daemon availability and initiates the connection. Returns success. currentProject \u25b9 RamProject or None The current project. currentUser \u25b9 RamUser or None The current user. daemonInterface \u25b9 RamDaemonInterface The Daemon interface unique instance. Same as RamDaemonInterface.instance() disconnect \u25b9 boolean Gets back to offline mode (stops all communications with the Daemon ). folderPath \u25b9 string The absolute path to main Ramses folder, containing projects by default, config files, user folders, admin files\u2026 importItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Callbacks below for more details. project \u25b9 RamProject or None (Try to) retrieve a project using its short name. projects \u25b9 list of RamProject The list of available projects. projectsPath \u25b9 string The path to the folder containing projects. states \u25b9 list of RamState The list of available states. state \u25b9 RamState \u2022 string : stateShortName = WIP Gets a specific state. online \u25b9 boolean True if connected to the Daemon and the Daemon is responding. publish \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Callbacks below for more details. replaceItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Callbacks below for more details. showClient Raises the Ramses Client window, launches the client if it is not already running. setCurrentProject \u2022 RamProject : project Sets the current project. settings \u25b9 RamSettings The settings unique instance. Same as RamSettings.instance() updateStatus \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Callbacks below for more details. usersPath \u25b9 string The path to the folder containing users. Callbacks The callbacks are the methods you can add to these lists: Ramses.publishScripts , Ramses.statusScripts , Ramses.importScripts , Ramses.userScripts . When using one of the provided Ramses Add-ons , these callbacks will be called automatically when the user publishes an item, changes the status, or wants to import a file. This makes it very easy to extend these add-ons by just adding your own methods. If you\u2019re developping your own add-on from scratch, it may be useful to add your methods to these lists to call them easily anyway; use Ramses.publish() , Ramses.importItem() , and Ramses.updateStatus() . Ramses will pass a few arguments depending on the context to theses methods, which they\u2019ll have to handle. The table below describes the callbacks. Callback Arguments Description importItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false - item is the item from which the user wants to import a file. - filePaths is the list of absolute path to the files the user wants to import. This list can be empty! In this case, it means the add-on must automatically choose the right file from the publish folder of the item and step. - step is the step from which the user wants to import. You can check step.outputPipes() to know which file types have been published, and inputPipes() from the step you\u2019re importing to to know which files to accept. - importOptions is a dictionnary (associative array) containing custom options you can use to import the item. - showImportOptions tells the script to show a UI or not to edit the import options before importing. publish \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false - item is the item from which the user wants to publish a file. - step is the step from which the user is publishing. You can check step.outputPipes() to know which file types to publish. - filePath is the path of the file currently being published. - publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. - showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. replaceItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false - item is the item from which the user wants to import a file. - filePath is the absolute path to the file the user wants to import. - step is the step from which the user wants to import. You can check step.outputPipes() to know which file types have been published, and inputPipes() from the step you\u2019re importing to to know which files to accept. - importOptions is a dictionnary (associative array) containing custom options you can use to import the item. - showImportOptions tells the script to show a UI or not to edit the import options before importing. With this info, the method should replace selected objects with the imported items. updateStatus \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step - item is the item which is being updated. - status is the new status. - step is the step being updated. Examples # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(item, filePath, step): ram.log(\"Hello, I've been published!\") # Another one def aFunction( arg1, arg2): ram.log(\"I'm doing something\") # Adds the method to the scripts which will be run when the add-on publishes a file ramses.publishScripts.append( published ) # Let's store a function in the userScripts to make it available everywhere ramses.userScripts[\"MyFunction\"] = aFunction # The provided Ramses add-ons for Blender, Maya, etc. automatically trigger these scripts. # If you're developping another addon, you have to call Ramses.publish() to run them ramses.publish(currentItem, 'a path', 'STEP') # From anywhere in the app where the Ramses module has been imported, you can call 'aFunction' with ramses.userScripts[\"MyFunction\"](some, arg) // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // A simple method function published(item, filePath, step) { ram.log(\"Hello, I've been published!\"); } // Another one function aFunction( arg1, arg2) { ram.log(\"I'm doing something\"); } // Adds the method to the scripts which will be run when the add-on publishes a file ramses.publishScripts.push( published ); // Let's store a function in the userScripts to make it available everywhere ramses.userScripts[\"MyFunction\"] = aFunction; // The provided Ramses add-ons for Blender, Maya, etc. automatically trigger these scripts. // If you're developping another addon, you have to call Ramses.publish() to run them ramses.publish(currentItem, 'a path', 'STEP'); // From anywhere in the app, you can call 'aFunction' with ramses.userScripts[\"MyFunction\"](some, arg); API Dev notes Note These section is for the development of the API only; you should not need these when developping your add-on using the API. Private attributes Attribute Type Default Description defaultState RamState The state to use as default (\u201cWIP\u201d).","title":"Ramses"},{"location":"dev/add-ons-reference/ramses/#ramses","text":"The main class. One (and only one) instance globally available (Ramses is a singleton ), by calling Ramses.instance() .","title":"Ramses"},{"location":"dev/add-ons-reference/ramses/#static-methods","text":"Method Arguments Description instance \u25b9 Ramses Returns the Ramses unique instance. version \u25b9 string The current version of this API","title":"Static Methods"},{"location":"dev/add-ons-reference/ramses/#static-attributes","text":"Attribute Type Default Description apiReferenceUrl string This page URL A link to this API documentation addonsHelpUrl string The URL to this page A link to the Ramses add-ons documentation generalHelpUrl string The URL to this documentation A link to the Ramses documentation","title":"Static Attributes"},{"location":"dev/add-ons-reference/ramses/#attributes","text":"Read the section entitled Callbacks below (and see the Examples ) for more information about the methods you can add to these lists. Attribute Type Default Description importScripts list [] A list of scripts/functions to be triggered when Ramses.instance().importItem() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user asks to import an item. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. publishScripts list [] A list of scripts/functions to be triggered when Ramses.instance().publish() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user publishes the current file from the host application. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. replaceScripts list [] A list of scripts/functions to be triggered when Ramses.instance().replaceItem() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user asks to import an item. Note: official Ramses Add-ons will add an item to this list to provide a default implementation. If you\u2019re extending an existing add-on, you can reset the list or insert/append your own methods to keep the default behavior. statusScripts list [] A list of scripts/functions to be triggered when Ramses.instance().updateStatus() is called. If you\u2019re using one of the provided Add-ons, you can add your own callbacks to this list so they\u2019re run when the user changes the current status of an asset / shot from the host application. userScripts dict or object {} This dict or object is here for your convenience, to make it easy to register and call any method from anywhere you\u2019ve imported Ramses without having to import the file containing the method. Just register with Ramses.instance().userScripts[\"TheFunctionName\"] = aFunction and call the method with Ramses.instance().userScripts[\"TheFunctionName\"](some, args) .","title":"Attributes"},{"location":"dev/add-ons-reference/ramses/#methods","text":"Method Arguments Description alternativeFolderPaths \u25b9 list of string A list of alternative absolute paths to the main Ramses folder. Missing files will be looked for in these paths (and copied to the main path if available), and they will be used if the main path is not available. backupFolderPath \u25b9 list of string A copy of the main folder where all files are stored. connect \u25b9 boolean Checks Daemon availability and initiates the connection. Returns success. currentProject \u25b9 RamProject or None The current project. currentUser \u25b9 RamUser or None The current user. daemonInterface \u25b9 RamDaemonInterface The Daemon interface unique instance. Same as RamDaemonInterface.instance() disconnect \u25b9 boolean Gets back to offline mode (stops all communications with the Daemon ). folderPath \u25b9 string The absolute path to main Ramses folder, containing projects by default, config files, user folders, admin files\u2026 importItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Callbacks below for more details. project \u25b9 RamProject or None (Try to) retrieve a project using its short name. projects \u25b9 list of RamProject The list of available projects. projectsPath \u25b9 string The path to the folder containing projects. states \u25b9 list of RamState The list of available states. state \u25b9 RamState \u2022 string : stateShortName = WIP Gets a specific state. online \u25b9 boolean True if connected to the Daemon and the Daemon is responding. publish \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Callbacks below for more details. replaceItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Callbacks below for more details. showClient Raises the Ramses Client window, launches the client if it is not already running. setCurrentProject \u2022 RamProject : project Sets the current project. settings \u25b9 RamSettings The settings unique instance. Same as RamSettings.instance() updateStatus \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Callbacks below for more details. usersPath \u25b9 string The path to the folder containing users.","title":"Methods"},{"location":"dev/add-ons-reference/ramses/#callbacks","text":"The callbacks are the methods you can add to these lists: Ramses.publishScripts , Ramses.statusScripts , Ramses.importScripts , Ramses.userScripts . When using one of the provided Ramses Add-ons , these callbacks will be called automatically when the user publishes an item, changes the status, or wants to import a file. This makes it very easy to extend these add-ons by just adding your own methods. If you\u2019re developping your own add-on from scratch, it may be useful to add your methods to these lists to call them easily anyway; use Ramses.publish() , Ramses.importItem() , and Ramses.updateStatus() . Ramses will pass a few arguments depending on the context to theses methods, which they\u2019ll have to handle. The table below describes the callbacks. Callback Arguments Description importItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false - item is the item from which the user wants to import a file. - filePaths is the list of absolute path to the files the user wants to import. This list can be empty! In this case, it means the add-on must automatically choose the right file from the publish folder of the item and step. - step is the step from which the user wants to import. You can check step.outputPipes() to know which file types have been published, and inputPipes() from the step you\u2019re importing to to know which files to accept. - importOptions is a dictionnary (associative array) containing custom options you can use to import the item. - showImportOptions tells the script to show a UI or not to edit the import options before importing. publish \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false - item is the item from which the user wants to publish a file. - step is the step from which the user is publishing. You can check step.outputPipes() to know which file types to publish. - filePath is the path of the file currently being published. - publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. - showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. replaceItem \u2022 RamItem or RamAsset or RamShot : item , \u2022 string : filePath , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false - item is the item from which the user wants to import a file. - filePath is the absolute path to the file the user wants to import. - step is the step from which the user wants to import. You can check step.outputPipes() to know which file types have been published, and inputPipes() from the step you\u2019re importing to to know which files to accept. - importOptions is a dictionnary (associative array) containing custom options you can use to import the item. - showImportOptions tells the script to show a UI or not to edit the import options before importing. With this info, the method should replace selected objects with the imported items. updateStatus \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step - item is the item which is being updated. - status is the new status. - step is the step being updated.","title":"Callbacks"},{"location":"dev/add-ons-reference/ramses/#examples","text":"# Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(item, filePath, step): ram.log(\"Hello, I've been published!\") # Another one def aFunction( arg1, arg2): ram.log(\"I'm doing something\") # Adds the method to the scripts which will be run when the add-on publishes a file ramses.publishScripts.append( published ) # Let's store a function in the userScripts to make it available everywhere ramses.userScripts[\"MyFunction\"] = aFunction # The provided Ramses add-ons for Blender, Maya, etc. automatically trigger these scripts. # If you're developping another addon, you have to call Ramses.publish() to run them ramses.publish(currentItem, 'a path', 'STEP') # From anywhere in the app where the Ramses module has been imported, you can call 'aFunction' with ramses.userScripts[\"MyFunction\"](some, arg) // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // A simple method function published(item, filePath, step) { ram.log(\"Hello, I've been published!\"); } // Another one function aFunction( arg1, arg2) { ram.log(\"I'm doing something\"); } // Adds the method to the scripts which will be run when the add-on publishes a file ramses.publishScripts.push( published ); // Let's store a function in the userScripts to make it available everywhere ramses.userScripts[\"MyFunction\"] = aFunction; // The provided Ramses add-ons for Blender, Maya, etc. automatically trigger these scripts. // If you're developping another addon, you have to call Ramses.publish() to run them ramses.publish(currentItem, 'a path', 'STEP'); // From anywhere in the app, you can call 'aFunction' with ramses.userScripts[\"MyFunction\"](some, arg);","title":"Examples"},{"location":"dev/add-ons-reference/ramses/#api-dev-notes","text":"Note These section is for the development of the API only; you should not need these when developping your add-on using the API.","title":"API Dev notes"},{"location":"dev/add-ons-reference/ramses/#private-attributes","text":"Attribute Type Default Description defaultState RamState The state to use as default (\u201cWIP\u201d).","title":"Private attributes"},{"location":"dev/daemon-reference/","text":"Ramses Daemon API The Ramses Daemon is a local server used by the Ramses Add-ons to get and set data to the client (which in turn may communicate with the Ramses Server to sync data) and the whole system. The Ramses Daemon is automatically run by the Ramses Application , which is the beating heart of Ramses . Connecting to the Daemon Add-ons can communicate with the Daemon through a standard TCP Socket . The Daemon listens on port 18185 1 by default (but this can be adjusted in the Ramses Application settings), and is automatically started by the Ramses Application . It is terminated when the client quits. To avoid conflicts, it may be temporarily suspended when the client is syncing data with the Ramses Server but all requests are queued and all of them should be processed. Most of the Ramses data can only be accessed if a user is logged-in in the Ramses Application , thus before communicating with the Daemon , a Ramses Add-on must check if the Application (and its Daemon ) is running (or start it), and if a user is logged-in. The initial connection to the Daemon usually follows these steps: Check if the Daemon is running by sending the ping query. If the Daemon replies, connection is ready Else, try to start the Application and ping again. Check the version of the Daemon which is part of the reply to the ping . Check if a user is logged-in (this is also part of the reply to the ping ); if not, show an alert and raise the Ramses Application window. After these steps, other queries can be used to get or set new data and information. Communicating with the Daemon Queries Add-ons can post queries with the form of a standard form-encoded URL query; they are a single-line string of key=value pairs (the value may be optional) seperated by the & character. They should be encoded in UTF-8 . There\u2019s no need to enclose strings in quotes. Example queries: ping getProjects setCurrentProject&uuid=unique-uid Replies The Daemon replies with a JSON object (encoded in UTF-8 ) which contains the following attributes: accepted : boolean . True if the Daemon has recognized the query and accepted it. Will be False if the query does not exist. success : boolean . True if the Daemon has successfully processed the query, False in case of any error. message : string . A human-readable feedback about the result, which can be shown to the user by the Add-on . It contains explanation about the error, if any. query : string . The query that was made that the Daemon is replying to. content : object . The actual content of the reply, which varies depending on the query. Read this reference for more details. Note Replies are a single-line string, but they\u2019re prettyfied in this documentation for the sake of readabiliy A reply looks like this: { \"accepted\": true, \"query\": \"ping\", \"success\": true, \"message\": \"Hi, this is the Ramses Daemon.\", \"content\": { \"version\": \"1.0.0\", \"ramses\": \"Ramses\", \"userUuid\": \"unique-uid\" } } Objects and their data In Ramses, everything is represented by Objects . An object consists of a Unique Universal Identifier (UUID) used to identify them across the whole system, and its associated data , encoded as a JSON Object . Ramses Objects (i.e. RamObjects ) can represent a shot, an asset, a user, an application, or a whole project for example. They can also contain lists of other objects. Lists of objects are basic string lists of UUIDs stored in the parent object data. UUIDs and object data are synced by all the Ramses Applications and a Ramses Server , and are mirrored on all workstations and the server itself. Any other software (e.g. APIs , scripts, plugins\u2026) should get the list of objects and all data using this Ramses Daemon run by the Ramses Application which is guaranteed to be up-to-date. You can also use the Daemon to set new data to specific objects. Data can be retrived and updated with these two simple queries: getData and setData . This port was chosen in memory of Karl Marx, whose birth date was 05/05/1818. \u21a9","title":"Reference"},{"location":"dev/daemon-reference/#ramses-daemon-api","text":"The Ramses Daemon is a local server used by the Ramses Add-ons to get and set data to the client (which in turn may communicate with the Ramses Server to sync data) and the whole system. The Ramses Daemon is automatically run by the Ramses Application , which is the beating heart of Ramses .","title":"Ramses Daemon API"},{"location":"dev/daemon-reference/#connecting-to-the-daemon","text":"Add-ons can communicate with the Daemon through a standard TCP Socket . The Daemon listens on port 18185 1 by default (but this can be adjusted in the Ramses Application settings), and is automatically started by the Ramses Application . It is terminated when the client quits. To avoid conflicts, it may be temporarily suspended when the client is syncing data with the Ramses Server but all requests are queued and all of them should be processed. Most of the Ramses data can only be accessed if a user is logged-in in the Ramses Application , thus before communicating with the Daemon , a Ramses Add-on must check if the Application (and its Daemon ) is running (or start it), and if a user is logged-in. The initial connection to the Daemon usually follows these steps: Check if the Daemon is running by sending the ping query. If the Daemon replies, connection is ready Else, try to start the Application and ping again. Check the version of the Daemon which is part of the reply to the ping . Check if a user is logged-in (this is also part of the reply to the ping ); if not, show an alert and raise the Ramses Application window. After these steps, other queries can be used to get or set new data and information.","title":"Connecting to the Daemon"},{"location":"dev/daemon-reference/#communicating-with-the-daemon","text":"","title":"Communicating with the Daemon"},{"location":"dev/daemon-reference/#queries","text":"Add-ons can post queries with the form of a standard form-encoded URL query; they are a single-line string of key=value pairs (the value may be optional) seperated by the & character. They should be encoded in UTF-8 . There\u2019s no need to enclose strings in quotes. Example queries: ping getProjects setCurrentProject&uuid=unique-uid","title":"Queries"},{"location":"dev/daemon-reference/#replies","text":"The Daemon replies with a JSON object (encoded in UTF-8 ) which contains the following attributes: accepted : boolean . True if the Daemon has recognized the query and accepted it. Will be False if the query does not exist. success : boolean . True if the Daemon has successfully processed the query, False in case of any error. message : string . A human-readable feedback about the result, which can be shown to the user by the Add-on . It contains explanation about the error, if any. query : string . The query that was made that the Daemon is replying to. content : object . The actual content of the reply, which varies depending on the query. Read this reference for more details. Note Replies are a single-line string, but they\u2019re prettyfied in this documentation for the sake of readabiliy A reply looks like this: { \"accepted\": true, \"query\": \"ping\", \"success\": true, \"message\": \"Hi, this is the Ramses Daemon.\", \"content\": { \"version\": \"1.0.0\", \"ramses\": \"Ramses\", \"userUuid\": \"unique-uid\" } }","title":"Replies"},{"location":"dev/daemon-reference/#objects-and-their-data","text":"In Ramses, everything is represented by Objects . An object consists of a Unique Universal Identifier (UUID) used to identify them across the whole system, and its associated data , encoded as a JSON Object . Ramses Objects (i.e. RamObjects ) can represent a shot, an asset, a user, an application, or a whole project for example. They can also contain lists of other objects. Lists of objects are basic string lists of UUIDs stored in the parent object data. UUIDs and object data are synced by all the Ramses Applications and a Ramses Server , and are mirrored on all workstations and the server itself. Any other software (e.g. APIs , scripts, plugins\u2026) should get the list of objects and all data using this Ramses Daemon run by the Ramses Application which is guaranteed to be up-to-date. You can also use the Daemon to set new data to specific objects. Data can be retrived and updated with these two simple queries: getData and setData . This port was chosen in memory of Karl Marx, whose birth date was 05/05/1818. \u21a9","title":"Objects and their data"},{"location":"dev/daemon-reference/create/","text":"","title":"create"},{"location":"dev/daemon-reference/getCurrentProject/","text":"getCurrentProject Query: getCurrentProject Gets the current project ( UUID and data). Reply JSON { \"accepted\": true, \"query\": \"getCurrentProject\", \"success\": true, \"message\": \"\\\"Project Name\\\" is the current project.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": \"{some JSON data}\" } } Details uuid : string . The UUID of the project. Empty string if there\u2019s no current project. data : string . The data of the project. Empty JSON object if there\u2019s no current project.","title":"getCurrentProject"},{"location":"dev/daemon-reference/getCurrentProject/#getcurrentproject","text":"Query: getCurrentProject Gets the current project ( UUID and data).","title":"getCurrentProject"},{"location":"dev/daemon-reference/getCurrentProject/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getCurrentProject/#json","text":"{ \"accepted\": true, \"query\": \"getCurrentProject\", \"success\": true, \"message\": \"\\\"Project Name\\\" is the current project.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": \"{some JSON data}\" } }","title":"JSON"},{"location":"dev/daemon-reference/getCurrentProject/#details","text":"uuid : string . The UUID of the project. Empty string if there\u2019s no current project. data : string . The data of the project. Empty JSON object if there\u2019s no current project.","title":"Details"},{"location":"dev/daemon-reference/getData/","text":"getData Query: getData&uuid=unique-uid Gets the data for a specific RamObject . Reply JSON { \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got some data.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"getData"},{"location":"dev/daemon-reference/getData/#getdata","text":"Query: getData&uuid=unique-uid Gets the data for a specific RamObject .","title":"getData"},{"location":"dev/daemon-reference/getData/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getData/#json","text":"{ \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got some data.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"JSON"},{"location":"dev/daemon-reference/getObjects/","text":"getObjects Query: getObjects&type=RamObject Gets all objects of a specific type. Reply JSON { \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got the list of \\\"RamObject\\\".\", \"content\": { \"objects\": [ { \"uuid\": \"unique-uid1\", \"data\": {\"Some JSON Data\"} }, { \"uuid\": \"unique-uid2\", \"data\": {\"Some JSON Data\"} }, { \"...\" } ] } }","title":"getObjets"},{"location":"dev/daemon-reference/getObjects/#getobjects","text":"Query: getObjects&type=RamObject Gets all objects of a specific type.","title":"getObjects"},{"location":"dev/daemon-reference/getObjects/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getObjects/#json","text":"{ \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got the list of \\\"RamObject\\\".\", \"content\": { \"objects\": [ { \"uuid\": \"unique-uid1\", \"data\": {\"Some JSON Data\"} }, { \"uuid\": \"unique-uid2\", \"data\": {\"Some JSON Data\"} }, { \"...\" } ] } }","title":"JSON"},{"location":"dev/daemon-reference/getPath/","text":"getPath Query: getPath&uuid=unique-uid Gets the path for a specific RamObject . Reply JSON { \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got the path of the object.\", \"content\": { \"path\": \"path/to/the/object\" } }","title":"getPath"},{"location":"dev/daemon-reference/getPath/#getpath","text":"Query: getPath&uuid=unique-uid Gets the path for a specific RamObject .","title":"getPath"},{"location":"dev/daemon-reference/getPath/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getPath/#json","text":"{ \"accepted\": true, \"query\": \"getData\", \"success\": true, \"message\": \"I've got the path of the object.\", \"content\": { \"path\": \"path/to/the/object\" } }","title":"JSON"},{"location":"dev/daemon-reference/getProjects/","text":"getProjects Query: getProjects Gets the list of available projects for the current user. Reply JSON { \"accepted\": true, \"query\": \"getProjects\", \"success\": true, \"message\": \"I've got the project list.\", \"content\": { \"projects\": [ { \"uuid\": \"unique-uid1\", \"data\": {\"Some JSON Data\"} }, { \"uuid\": \"unique-uid2\", \"data\": {\"Some JSON Data\"} }, { \"...\" } ] } } Details projects : list of string . The list of available project UUIDs .","title":"getProjects"},{"location":"dev/daemon-reference/getProjects/#getprojects","text":"Query: getProjects Gets the list of available projects for the current user.","title":"getProjects"},{"location":"dev/daemon-reference/getProjects/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getProjects/#json","text":"{ \"accepted\": true, \"query\": \"getProjects\", \"success\": true, \"message\": \"I've got the project list.\", \"content\": { \"projects\": [ { \"uuid\": \"unique-uid1\", \"data\": {\"Some JSON Data\"} }, { \"uuid\": \"unique-uid2\", \"data\": {\"Some JSON Data\"} }, { \"...\" } ] } }","title":"JSON"},{"location":"dev/daemon-reference/getProjects/#details","text":"projects : list of string . The list of available project UUIDs .","title":"Details"},{"location":"dev/daemon-reference/getRamsesFolder/","text":"getRamsesFolder Query: getRamsesFolder Gets the folder where all data is stored. Reply JSON { \"accepted\": true, \"query\": \"getRamsesFolder\", \"success\": true, \"message\": \"I've got the Ramses folder.\", \"content\": { \"path\": \"path/to/ramses/data\" } } Details path : string . The path to the data.","title":"getRamsesFolder"},{"location":"dev/daemon-reference/getRamsesFolder/#getramsesfolder","text":"Query: getRamsesFolder Gets the folder where all data is stored.","title":"getRamsesFolder"},{"location":"dev/daemon-reference/getRamsesFolder/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getRamsesFolder/#json","text":"{ \"accepted\": true, \"query\": \"getRamsesFolder\", \"success\": true, \"message\": \"I've got the Ramses folder.\", \"content\": { \"path\": \"path/to/ramses/data\" } }","title":"JSON"},{"location":"dev/daemon-reference/getRamsesFolder/#details","text":"path : string . The path to the data.","title":"Details"},{"location":"dev/daemon-reference/ping/","text":"ping Query: ping Checks if the Daemon is running, and gets its version and current user information. Reply JSON { \"accepted\": true, \"query\": \"ping\", \"success\": true, \"message\": \"Hi, this is the Ramses Daemon.\", \"content\": { \"version\": \"1.0.0\", \"ramses\": \"Ramses\", \"userUuid\": \"unique-uid\" } } Details The Daemon replies with its version and information about the current user. version : string . The version of the client/daemon. ramses : string . The name of the client, should be \u201cRamses\u201d for the official client. userUuid : string . The UUID of the user. Empty string if there\u2019s no logged-in user.","title":"ping"},{"location":"dev/daemon-reference/ping/#ping","text":"Query: ping Checks if the Daemon is running, and gets its version and current user information.","title":"ping"},{"location":"dev/daemon-reference/ping/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/ping/#json","text":"{ \"accepted\": true, \"query\": \"ping\", \"success\": true, \"message\": \"Hi, this is the Ramses Daemon.\", \"content\": { \"version\": \"1.0.0\", \"ramses\": \"Ramses\", \"userUuid\": \"unique-uid\" } }","title":"JSON"},{"location":"dev/daemon-reference/ping/#details","text":"The Daemon replies with its version and information about the current user. version : string . The version of the client/daemon. ramses : string . The name of the client, should be \u201cRamses\u201d for the official client. userUuid : string . The UUID of the user. Empty string if there\u2019s no logged-in user.","title":"Details"},{"location":"dev/daemon-reference/raise/","text":"raise Query: raise Attempts to raise the Ramses Application window. Depending on the system, this may just show a notification, actually raise the window, or do nothing. This query doesn\u2019t send any reply.","title":"raise"},{"location":"dev/daemon-reference/raise/#raise","text":"Query: raise Attempts to raise the Ramses Application window. Depending on the system, this may just show a notification, actually raise the window, or do nothing. This query doesn\u2019t send any reply.","title":"raise"},{"location":"dev/daemon-reference/setCurrentProject/","text":"setCurrentProject Query: setCurrentProject&uuid=unique-uid Sets the application-side active project. Reply JSON { \"accepted\": true, \"query\": \"setCurrentProject\", \"success\": true, \"message\": \"Current project set to: \\\"Project Name\\\".\", \"content\": { } }","title":"setCurrentProject"},{"location":"dev/daemon-reference/setCurrentProject/#setcurrentproject","text":"Query: setCurrentProject&uuid=unique-uid Sets the application-side active project.","title":"setCurrentProject"},{"location":"dev/daemon-reference/setCurrentProject/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/setCurrentProject/#json","text":"{ \"accepted\": true, \"query\": \"setCurrentProject\", \"success\": true, \"message\": \"Current project set to: \\\"Project Name\\\".\", \"content\": { } }","title":"JSON"},{"location":"dev/daemon-reference/setData/","text":"setData Query: getData&uuid=unique-uid&data={Some JSON Data} Sets the data for a specific RamObject . Reply JSON { \"accepted\": true, \"query\": \"setData\", \"success\": true, \"message\": \"Data updated.\", \"content\": { } }","title":"setData"},{"location":"dev/daemon-reference/setData/#setdata","text":"Query: getData&uuid=unique-uid&data={Some JSON Data} Sets the data for a specific RamObject .","title":"setData"},{"location":"dev/daemon-reference/setData/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/setData/#json","text":"{ \"accepted\": true, \"query\": \"setData\", \"success\": true, \"message\": \"Data updated.\", \"content\": { } }","title":"JSON"},{"location":"dev/daemon-reference/uuidFromPath/","text":"uuidFromPath Query: uuidFromPath&path=some/path Gets the UUID of the object at this path. Reply JSON { \"accepted\": true, \"query\": \"uuidFromPath\", \"success\": true, \"message\": \"I've found an object.\", \"content\": { \"uuid\": \"unique-uid\" } } Details uuid : string . The UUID of the object.","title":"uuidFromPath"},{"location":"dev/daemon-reference/uuidFromPath/#uuidfrompath","text":"Query: uuidFromPath&path=some/path Gets the UUID of the object at this path.","title":"uuidFromPath"},{"location":"dev/daemon-reference/uuidFromPath/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/uuidFromPath/#json","text":"{ \"accepted\": true, \"query\": \"uuidFromPath\", \"success\": true, \"message\": \"I've found an object.\", \"content\": { \"uuid\": \"unique-uid\" } }","title":"JSON"},{"location":"dev/daemon-reference/uuidFromPath/#details","text":"uuid : string . The UUID of the object.","title":"Details"},{"location":"dev/files/naming/","text":"Regular Expressions for files and folder naming. Ramses uses specific file and folder naming conventions . Here are useful regular expressions to manipulate them. Note All names used by Ramses should be compated ignoring the case. Thus all regular expressions should use the i flag. Regular Expressions for files and folder naming. Short Names (IDs) Names Status and versions Extract version from a file name Resource names File names Master media file names Short Names (IDs) /^(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-zA-Z0-9+-]{1,10}$/gi Short names , or ID s are made exclusively of a-z , A-Z, 0-1 and +-` characters, and cannot be more than 10 characters. The negative part of the regular expression, (?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+) , is used to differenciate regular blocks (name, short name, etc.) from versions. Names /^(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[ a-zA-Z0-9+-]{1,256}$/gi Names made exclusively of a-z , A-Z , 0-1 , +- and the space characters, and cannot be more than 256 characters. Warning Names should never be used in file names, as it may generate paths which may be very long. The negative part of the regular expression, (?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+) , is used to differenciate regular blocks (name, short name, etc.) from versions. Status and versions /(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+)/gi The first matching group contains the status (and may be empty), and the second group is the version number. Note The string in the first matching group should be dynamically built using the list of available status ID s ( short names ). By default, it should at least contain the default states: NO , STB , TODO , WIP , OK , PUB , V . Extract version from a file name /(?:(_(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+)))(?:\\.[a-z0-9.]+)?$/gi This regular expressions matches everything including the last underscore, the version block and the file extension if any. The first group contains the underscore and the version block; it can be used to be replaced by an empty string in file names to quickly remove the version block from the name. The second and third groups contain the state and the version. Resource names /(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+\\s-]+/gi Resource names can be made of a-z , 0-9 , +- and white spaces but must not start with a version scheme. File names This is the regular expression for validating, matching and decomposing file names. /^([a-z0-9+-]{1,10})_(?:([ASG])_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+-]{1,10}))(?:_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+-]{1,10}))?(?:_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+\\s-]+))?(?:_(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+))?(?:\\.([a-z0-9.]+))?$/gi Here is the list of matching groups: Project ID Type: A (Asset) or S (Shot) or empty (for general items) Asset or Shot ID or empty (for general items) Type: G (General) or empty Step ID Resource name or empty Status or empty Version number or empty Extension or empty If any string does not match this regular expression, it means it does not follow the Ramses naming scheme. Master media file names /^([a-z0-9+-]{1,10})_([a-z0-9]{1,10})(?:-([a-z0-9]{1,10})?)_(\\d+)x(\\d+)(i|p)?_(\\d+\\.?\\d*)(?:fps)?(?:_([a-z]+))?(?:_([a-z]+)st)\\.([a-z0-9.]+)/gi Here is the list of matching groups: Project ID Codec ID Colorspace ID Width Height p (progressive), i (interlaced), or empty Framerate Language or empty Subtitles language or empty Extension","title":"Naming"},{"location":"dev/files/naming/#regular-expressions-for-files-and-folder-naming","text":"Ramses uses specific file and folder naming conventions . Here are useful regular expressions to manipulate them. Note All names used by Ramses should be compated ignoring the case. Thus all regular expressions should use the i flag. Regular Expressions for files and folder naming. Short Names (IDs) Names Status and versions Extract version from a file name Resource names File names Master media file names","title":"Regular Expressions for files and folder naming."},{"location":"dev/files/naming/#short-names-ids","text":"/^(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-zA-Z0-9+-]{1,10}$/gi Short names , or ID s are made exclusively of a-z , A-Z, 0-1 and +-` characters, and cannot be more than 10 characters. The negative part of the regular expression, (?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+) , is used to differenciate regular blocks (name, short name, etc.) from versions.","title":"Short Names (IDs)"},{"location":"dev/files/naming/#names","text":"/^(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[ a-zA-Z0-9+-]{1,256}$/gi Names made exclusively of a-z , A-Z , 0-1 , +- and the space characters, and cannot be more than 256 characters. Warning Names should never be used in file names, as it may generate paths which may be very long. The negative part of the regular expression, (?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+) , is used to differenciate regular blocks (name, short name, etc.) from versions.","title":"Names"},{"location":"dev/files/naming/#status-and-versions","text":"/(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+)/gi The first matching group contains the status (and may be empty), and the second group is the version number. Note The string in the first matching group should be dynamically built using the list of available status ID s ( short names ). By default, it should at least contain the default states: NO , STB , TODO , WIP , OK , PUB , V .","title":"Status and versions"},{"location":"dev/files/naming/#extract-version-from-a-file-name","text":"/(?:(_(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+)))(?:\\.[a-z0-9.]+)?$/gi This regular expressions matches everything including the last underscore, the version block and the file extension if any. The first group contains the underscore and the version block; it can be used to be replaced by an empty string in file names to quickly remove the version block from the name. The second and third groups contain the state and the version.","title":"Extract version from a file name"},{"location":"dev/files/naming/#resource-names","text":"/(?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+\\s-]+/gi Resource names can be made of a-z , 0-9 , +- and white spaces but must not start with a version scheme.","title":"Resource names"},{"location":"dev/files/naming/#file-names","text":"This is the regular expression for validating, matching and decomposing file names. /^([a-z0-9+-]{1,10})_(?:([ASG])_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+-]{1,10}))(?:_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+-]{1,10}))?(?:_((?!(?:NO|STB|TODO|WIP|OK|PUB|V)?[0-9]+)[a-z0-9+\\s-]+))?(?:_(NO|STB|TODO|WIP|OK|PUB|V)?([0-9]+))?(?:\\.([a-z0-9.]+))?$/gi Here is the list of matching groups: Project ID Type: A (Asset) or S (Shot) or empty (for general items) Asset or Shot ID or empty (for general items) Type: G (General) or empty Step ID Resource name or empty Status or empty Version number or empty Extension or empty If any string does not match this regular expression, it means it does not follow the Ramses naming scheme.","title":"File names"},{"location":"dev/files/naming/#master-media-file-names","text":"/^([a-z0-9+-]{1,10})_([a-z0-9]{1,10})(?:-([a-z0-9]{1,10})?)_(\\d+)x(\\d+)(i|p)?_(\\d+\\.?\\d*)(?:fps)?(?:_([a-z]+))?(?:_([a-z]+)st)\\.([a-z0-9.]+)/gi Here is the list of matching groups: Project ID Codec ID Colorspace ID Width Height p (progressive), i (interlaced), or empty Framerate Language or empty Subtitles language or empty Extension","title":"Master media file names"},{"location":"dev/server-reference/","text":"Ramses Server API The Ramses Server is used to backup and sync data across Ramses Applications and workstations. It provides a standard http(s) REST API . If you\u2019re developping your own client (or contributing to Ramses Client ), you can easily exchange data with the server using this reference. Queries must be a POST request ; the body must be JSON encoded, the Content-Type being application/json . Only one attribute must be set directly in the URL (like a GET request), the name of the query itself. For now, the server only supports the UTF-8 charset, so it is not mandatory to add the charset in the Content-Type , and any value other than utf-8 will be ignored. This may change in future versions. Queries The server provides a single endpoint, which is the root of the folder where it\u2019s installed. For example, for a server installed in a folder called example on the server at https://ramses.rxlab.io , the endpoint will be https://ramses.rxlab.io/example . To query the server, you only need to add the query name as a parameter to this URL . For example, the URL for the ping query is https://ramses.rxlab.io/example/?ping . All queries must be accompanied with a JSON object in the post body, containing at least these values: { \"version\": \"0.6.0\" } version : version of the client connected to the server. Replies The server replies to all queries with a JSON object, containing these values: { \"accepted\": true, \"success\": true, \"message\": \"Server ready.\", \"query\": \"ping\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } accepted : boolean . True if the server has recognized the query and accepted it. Will be False if the query does not exist. success : boolean . True if the server has successfully processed the query, False in case of any error. message : string . A short feedback about the result, which can be shown to the user by the client. query : string . The query that was made that the server is replying to. content : object . The actual content of the reply, which varies depending on the query. Read this reference for more details. serverUuid : string . The universal unique identifier of this server. This value can be used to make sure a local DB/client connects to the right server and avoid corrupting data by mixing servers. debug : array of objects . Server (debug) logs. Debug and logs The debug value of the reply is an array containing these objects: { \"date\": \"2022-11-25 13:05:24\", \"level\": \"DEBUG\", \"message\": \"A debug log entry\" } date : string . The date and time of the log entry. level : string . One of \"DATA\" , \"DEBUG\" , \"INFO\" , \"WARNING\" , \"CRITICAL\" , \"FATAL\" . The minimum level of the logs is \"WARNING\" by default (e.g. Data , Debug and Info logs won\u2019t be returned) and can be changed in the config file . lessage : string . The log entry. Syncing data This is the process to sync data with the server. ping to check if the server is available and check its version. This is mandatory to initiate the session before being able to log in. login to authenticate yourself. sync your data. For the examples in this documentation, we assume the ramses server is available at https://ramses.rxlab.io/example/ . Note For the sake of readability, the JSON replies are pretty formatted with indentation and new lines in this documentation, but the server actually uses one-line replies. ping Query: https://ramses.rxlab.io/example/?ping Request body { \"version\": \"0.6.0\" } version : version of the client. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Server ready.\", \"query\": \"ping\", \"content\": { \"installed\": true, \"version\": \"0.6.0\" }, \"serverUuid\": \"unique-uid\", \"debug\": [] } installed is false if the server has not been correctly installed yet. version is the version of the server, which should match the version of the client. login Query: https://ramses.rxlab.io/example/?login Request body { \"version\": \"0.6.0\", \"username\": \"Duduf\", \"password\": \"123456\" } version : version of the client. username : user name. password : user password. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Successful login. Welcome Duduf!\", \"query\": \"login\", \"content\": { \"username\": \"Duduf\", \"uuid\": \"uuid\", \"token\": \"token\" }, \"serverUuid\": \"unique-uid\", \"debug\": [] } username : the user name of the user. uuid : the uuid of the user. token : a token which must be associated with sync queries later. sync Query: https://ramses.rxlab.io/example/?sync Request body { \"version\": \"0.6.0\", \"token\": \"token\", \"previousSyncDate\": \"2022-06-15 15:44:23\", \"tables\":[ { \"name\": \"RamApplication\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamStep\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamUser\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"userName\": \"Duf\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"userName\": \"Ana\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] } ] } version : version of the client. token : the token got with login . previousSyncDate : the date and time of the previous sync. tables : the list of tables to sync. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Data sync, OK!\", \"query\": \"sync\", \"content\": { \"tables\":[ { \"name\": \"RamApplication\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-08-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-26 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamStep\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-08-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-26 15:44:23\", \"removed\": 1 } ] } ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tables : the list of tables to sync. The modifiedRows are the rows which have been changed or added to the table since the previous sync. clean Query: https://ramses.rxlab.io/example/?clean Deletes rows from tables, using the objects\u2019 uuids. Request body { \"version\": \"0.6.0\", \"token\": \"token\", \"tables\": [ { \"name\": \"tableName\", \"rows\": [\"uuid1\", \"uuid2\", \"uuid3\"] }, { \"name\": \"otherTable\", \"rows\": [\"uuid4\", \"uuid5\", \"uuid6\"] } ] } Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Cleaned data, removed 6 rows.\", \"query\": \"clean\", \"content\": { \"count\": 6 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } count : the number of deleted rows. setPassword Query: https://ramses.rxlab.io/example/?setPassword Request body { \"version\": \"0.6.0\", \"token\": \"token\", \"newPassword\": \"new password\", \"currentPassword\": \"current password\", \"uuid\": \"user-unique-uid\" } version : version of the client. token : the token got with login . newPassword : the new password to set. currentPassword : the current password of the user. uuid : the user UUID . The server will check if the connected user is an administrator, and accept the request accordingly: If the connected user is the same as the user changing its password, the current password is mandatory and will be checked before making any change. If the connected user is not the same as the new password, the request will be accepted if and only if the connected user has the administrator role. In this case, the current password is not mandatory. That means if there\u2019s only one administrator, who has forgotten its current password, only the server provider - someone who has an actual access to the server files (via FTP for example) - can set a new password, using Ramses Server development tools.","title":"Server API"},{"location":"dev/server-reference/#ramses-server-api","text":"The Ramses Server is used to backup and sync data across Ramses Applications and workstations. It provides a standard http(s) REST API . If you\u2019re developping your own client (or contributing to Ramses Client ), you can easily exchange data with the server using this reference. Queries must be a POST request ; the body must be JSON encoded, the Content-Type being application/json . Only one attribute must be set directly in the URL (like a GET request), the name of the query itself. For now, the server only supports the UTF-8 charset, so it is not mandatory to add the charset in the Content-Type , and any value other than utf-8 will be ignored. This may change in future versions.","title":"Ramses Server API"},{"location":"dev/server-reference/#queries","text":"The server provides a single endpoint, which is the root of the folder where it\u2019s installed. For example, for a server installed in a folder called example on the server at https://ramses.rxlab.io , the endpoint will be https://ramses.rxlab.io/example . To query the server, you only need to add the query name as a parameter to this URL . For example, the URL for the ping query is https://ramses.rxlab.io/example/?ping . All queries must be accompanied with a JSON object in the post body, containing at least these values: { \"version\": \"0.6.0\" } version : version of the client connected to the server.","title":"Queries"},{"location":"dev/server-reference/#replies","text":"The server replies to all queries with a JSON object, containing these values: { \"accepted\": true, \"success\": true, \"message\": \"Server ready.\", \"query\": \"ping\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } accepted : boolean . True if the server has recognized the query and accepted it. Will be False if the query does not exist. success : boolean . True if the server has successfully processed the query, False in case of any error. message : string . A short feedback about the result, which can be shown to the user by the client. query : string . The query that was made that the server is replying to. content : object . The actual content of the reply, which varies depending on the query. Read this reference for more details. serverUuid : string . The universal unique identifier of this server. This value can be used to make sure a local DB/client connects to the right server and avoid corrupting data by mixing servers. debug : array of objects . Server (debug) logs.","title":"Replies"},{"location":"dev/server-reference/#debug-and-logs","text":"The debug value of the reply is an array containing these objects: { \"date\": \"2022-11-25 13:05:24\", \"level\": \"DEBUG\", \"message\": \"A debug log entry\" } date : string . The date and time of the log entry. level : string . One of \"DATA\" , \"DEBUG\" , \"INFO\" , \"WARNING\" , \"CRITICAL\" , \"FATAL\" . The minimum level of the logs is \"WARNING\" by default (e.g. Data , Debug and Info logs won\u2019t be returned) and can be changed in the config file . lessage : string . The log entry.","title":"Debug and logs"},{"location":"dev/server-reference/#syncing-data","text":"This is the process to sync data with the server. ping to check if the server is available and check its version. This is mandatory to initiate the session before being able to log in. login to authenticate yourself. sync your data. For the examples in this documentation, we assume the ramses server is available at https://ramses.rxlab.io/example/ . Note For the sake of readability, the JSON replies are pretty formatted with indentation and new lines in this documentation, but the server actually uses one-line replies.","title":"Syncing data"},{"location":"dev/server-reference/#ping","text":"Query: https://ramses.rxlab.io/example/?ping","title":"ping"},{"location":"dev/server-reference/#request-body","text":"{ \"version\": \"0.6.0\" } version : version of the client.","title":"Request body"},{"location":"dev/server-reference/#reply","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Server ready.\", \"query\": \"ping\", \"content\": { \"installed\": true, \"version\": \"0.6.0\" }, \"serverUuid\": \"unique-uid\", \"debug\": [] } installed is false if the server has not been correctly installed yet. version is the version of the server, which should match the version of the client.","title":"Reply"},{"location":"dev/server-reference/#login","text":"Query: https://ramses.rxlab.io/example/?login","title":"login"},{"location":"dev/server-reference/#request-body_1","text":"{ \"version\": \"0.6.0\", \"username\": \"Duduf\", \"password\": \"123456\" } version : version of the client. username : user name. password : user password.","title":"Request body"},{"location":"dev/server-reference/#reply_1","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Successful login. Welcome Duduf!\", \"query\": \"login\", \"content\": { \"username\": \"Duduf\", \"uuid\": \"uuid\", \"token\": \"token\" }, \"serverUuid\": \"unique-uid\", \"debug\": [] } username : the user name of the user. uuid : the uuid of the user. token : a token which must be associated with sync queries later.","title":"Reply"},{"location":"dev/server-reference/#sync","text":"Query: https://ramses.rxlab.io/example/?sync","title":"sync"},{"location":"dev/server-reference/#request-body_2","text":"{ \"version\": \"0.6.0\", \"token\": \"token\", \"previousSyncDate\": \"2022-06-15 15:44:23\", \"tables\":[ { \"name\": \"RamApplication\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamStep\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamUser\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"userName\": \"Duf\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"userName\": \"Ana\", \"data\": \"{some other data}\", \"modified\": \"2022-08-24 15:44:23\", \"removed\": 1 } ] } ] } version : version of the client. token : the token got with login . previousSyncDate : the date and time of the previous sync. tables : the list of tables to sync.","title":"Request body"},{"location":"dev/server-reference/#reply_2","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Data sync, OK!\", \"query\": \"sync\", \"content\": { \"tables\":[ { \"name\": \"RamApplication\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-08-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-26 15:44:23\", \"removed\": 1 } ] }, { \"name\": \"RamStep\", \"modifiedRows\": [ { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-08-15 15:44:23\", \"removed\": 0 }, { \"uuid\": \"789123\", \"data\": \"{some other data}\", \"modified\": \"2022-08-26 15:44:23\", \"removed\": 1 } ] } ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tables : the list of tables to sync. The modifiedRows are the rows which have been changed or added to the table since the previous sync.","title":"Reply"},{"location":"dev/server-reference/#clean","text":"Query: https://ramses.rxlab.io/example/?clean Deletes rows from tables, using the objects\u2019 uuids.","title":"clean"},{"location":"dev/server-reference/#request-body_3","text":"{ \"version\": \"0.6.0\", \"token\": \"token\", \"tables\": [ { \"name\": \"tableName\", \"rows\": [\"uuid1\", \"uuid2\", \"uuid3\"] }, { \"name\": \"otherTable\", \"rows\": [\"uuid4\", \"uuid5\", \"uuid6\"] } ] }","title":"Request body"},{"location":"dev/server-reference/#reply_3","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Cleaned data, removed 6 rows.\", \"query\": \"clean\", \"content\": { \"count\": 6 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } count : the number of deleted rows.","title":"Reply"},{"location":"dev/server-reference/#setpassword","text":"Query: https://ramses.rxlab.io/example/?setPassword","title":"setPassword"},{"location":"dev/server-reference/#request-body_4","text":"{ \"version\": \"0.6.0\", \"token\": \"token\", \"newPassword\": \"new password\", \"currentPassword\": \"current password\", \"uuid\": \"user-unique-uid\" } version : version of the client. token : the token got with login . newPassword : the new password to set. currentPassword : the current password of the user. uuid : the user UUID . The server will check if the connected user is an administrator, and accept the request accordingly: If the connected user is the same as the user changing its password, the current password is mandatory and will be checked before making any change. If the connected user is not the same as the new password, the request will be accepted if and only if the connected user has the administrator role. In this case, the current password is not mandatory. That means if there\u2019s only one administrator, who has forgotten its current password, only the server provider - someone who has an actual access to the server files (via FTP for example) - can set a new password, using Ramses Server development tools.","title":"Request body"},{"location":"licenses/gfdl/","text":"GNU Free Documentation License Version 1.3, 3 November 2008 Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 0. PREAMBLE The purpose of this License is to make a manual, textbook, or other functional and useful document \u201cfree\u201d in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of \u201ccopyleft\u201d, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. 1. APPLICABILITY AND DEFINITIONS This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The \u201cDocument\u201d, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as \u201cyou\u201d. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. A \u201cModified Version\u201d of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. A \u201cSecondary Section\u201d is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document\u2019s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The \u201cInvariant Sections\u201d are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The \u201cCover Texts\u201d are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A \u201cTransparent\u201d copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not \u201cTransparent\u201d is called \u201cOpaque\u201d. Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The \u201cTitle Page\u201d means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, \u201cTitle Page\u201d means the text near the most prominent appearance of the work\u2019s title, preceding the beginning of the body of the text. The \u201cpublisher\u201d means any person or entity that distributes copies of the Document to the public. A section \u201cEntitled XYZ\u201d means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as \u201cAcknowledgements\u201d, \u201cDedications\u201d, \u201cEndorsements\u201d, or \u201cHistory\u201d.) To \u201cPreserve the Title\u201d of such a section when you modify the Document means that it remains a section \u201cEntitled XYZ\u201d according to this definition. The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License. 2. VERBATIM COPYING You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. You may also lend copies, under the same conditions stated above, and you may publicly display copies. 3. COPYING IN QUANTITY If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document\u2019s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. 4. MODIFICATIONS You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement. C. State on the Title page the name of the publisher of the Modified Version, as the publisher. D. Preserve all the copyright notices of the Document. E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document\u2019s license notice. H. Include an unaltered copy of this License. I. Preserve the section Entitled \u201cHistory\u201d, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled \u201cHistory\u201d in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the \u201cHistory\u201d section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission. K. For any section Entitled \u201cAcknowledgements\u201d or \u201cDedications\u201d, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. M. Delete any section Entitled \u201cEndorsements\u201d. Such a section may not be included in the Modified Version. N. Do not retitle any existing section to be Entitled \u201cEndorsements\u201d or to conflict in title with any Invariant Section. O. Preserve any Warranty Disclaimers. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version\u2019s license notice. These titles must be distinct from any other section titles. You may add a section Entitled \u201cEndorsements\u201d, provided it contains nothing but endorsements of your Modified Version by various parties\u00e2\u20ac\u201dfor example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections Entitled \u201cHistory\u201d in the various original documents, forming one section Entitled \u201cHistory\u201d; likewise combine any sections Entitled \u201cAcknowledgements\u201d, and any sections Entitled \u201cDedications\u201d. You must delete all sections Entitled \u201cEndorsements\u201d. 6. COLLECTIONS OF DOCUMENTS You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. 7. AGGREGATION WITH INDEPENDENT WORKS A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an \u201caggregate\u201d if the copyright resulting from the compilation is not used to limit the legal rights of the compilation\u2019s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document\u2019s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate. 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. If a section in the Document is Entitled \u201cAcknowledgements\u201d, \u201cDedications\u201d, or \u201cHistory\u201d, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title. 9. TERMINATION You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License. However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it. 10. FUTURE REVISIONS OF THIS LICENSE The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/ . Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License \u201cor any later version\u201d applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy\u2019s public statement of acceptance of a version permanently authorizes you to choose that version for the Document. 11. RELICENSING \u201cMassive Multiauthor Collaboration Site\u201d (or \u201cMMC Site\u201d) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A \u201cMassive Multiauthor Collaboration\u201d (or \u201cMMC\u201d) contained in the site means any set of copyrightable works thus published on the MMC site. \u201cCC-BY-SA\u201d means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization. \u201cIncorporate\u201d means to publish or republish a Document, in whole or in part, as part of another Document. An MMC is \u201celigible for relicensing\u201d if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008. The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing. ADDENDUM: How to use this License for your documents To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: Copyright (C) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled \"GNU Free Documentation License\". If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the \u201cwith \u00e2\u20ac\u00a6 Texts.\u201d line with this: with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.","title":"Documentation license"},{"location":"licenses/gfdl/#gnu-free-documentation-license","text":"Version 1.3, 3 November 2008 Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.","title":"GNU Free Documentation License"},{"location":"licenses/gfdl/#0-preamble","text":"The purpose of this License is to make a manual, textbook, or other functional and useful document \u201cfree\u201d in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of \u201ccopyleft\u201d, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.","title":"0. PREAMBLE"},{"location":"licenses/gfdl/#1-applicability-and-definitions","text":"This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The \u201cDocument\u201d, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as \u201cyou\u201d. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. A \u201cModified Version\u201d of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. A \u201cSecondary Section\u201d is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document\u2019s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The \u201cInvariant Sections\u201d are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The \u201cCover Texts\u201d are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A \u201cTransparent\u201d copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not \u201cTransparent\u201d is called \u201cOpaque\u201d. Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The \u201cTitle Page\u201d means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, \u201cTitle Page\u201d means the text near the most prominent appearance of the work\u2019s title, preceding the beginning of the body of the text. The \u201cpublisher\u201d means any person or entity that distributes copies of the Document to the public. A section \u201cEntitled XYZ\u201d means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as \u201cAcknowledgements\u201d, \u201cDedications\u201d, \u201cEndorsements\u201d, or \u201cHistory\u201d.) To \u201cPreserve the Title\u201d of such a section when you modify the Document means that it remains a section \u201cEntitled XYZ\u201d according to this definition. The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.","title":"1. APPLICABILITY AND DEFINITIONS"},{"location":"licenses/gfdl/#2-verbatim-copying","text":"You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. You may also lend copies, under the same conditions stated above, and you may publicly display copies.","title":"2. VERBATIM COPYING"},{"location":"licenses/gfdl/#3-copying-in-quantity","text":"If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document\u2019s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.","title":"3. COPYING IN QUANTITY"},{"location":"licenses/gfdl/#4-modifications","text":"You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement. C. State on the Title page the name of the publisher of the Modified Version, as the publisher. D. Preserve all the copyright notices of the Document. E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document\u2019s license notice. H. Include an unaltered copy of this License. I. Preserve the section Entitled \u201cHistory\u201d, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled \u201cHistory\u201d in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the \u201cHistory\u201d section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission. K. For any section Entitled \u201cAcknowledgements\u201d or \u201cDedications\u201d, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. M. Delete any section Entitled \u201cEndorsements\u201d. Such a section may not be included in the Modified Version. N. Do not retitle any existing section to be Entitled \u201cEndorsements\u201d or to conflict in title with any Invariant Section. O. Preserve any Warranty Disclaimers. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version\u2019s license notice. These titles must be distinct from any other section titles. You may add a section Entitled \u201cEndorsements\u201d, provided it contains nothing but endorsements of your Modified Version by various parties\u00e2\u20ac\u201dfor example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.","title":"4. MODIFICATIONS"},{"location":"licenses/gfdl/#5-combining-documents","text":"You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections Entitled \u201cHistory\u201d in the various original documents, forming one section Entitled \u201cHistory\u201d; likewise combine any sections Entitled \u201cAcknowledgements\u201d, and any sections Entitled \u201cDedications\u201d. You must delete all sections Entitled \u201cEndorsements\u201d.","title":"5. COMBINING DOCUMENTS"},{"location":"licenses/gfdl/#6-collections-of-documents","text":"You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.","title":"6. COLLECTIONS OF DOCUMENTS"},{"location":"licenses/gfdl/#7-aggregation-with-independent-works","text":"A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an \u201caggregate\u201d if the copyright resulting from the compilation is not used to limit the legal rights of the compilation\u2019s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document\u2019s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.","title":"7. AGGREGATION WITH INDEPENDENT WORKS"},{"location":"licenses/gfdl/#8-translation","text":"Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. If a section in the Document is Entitled \u201cAcknowledgements\u201d, \u201cDedications\u201d, or \u201cHistory\u201d, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.","title":"8. TRANSLATION"},{"location":"licenses/gfdl/#9-termination","text":"You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License. However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.","title":"9. TERMINATION"},{"location":"licenses/gfdl/#10-future-revisions-of-this-license","text":"The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/ . Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License \u201cor any later version\u201d applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy\u2019s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.","title":"10. FUTURE REVISIONS OF THIS LICENSE"},{"location":"licenses/gfdl/#11-relicensing","text":"\u201cMassive Multiauthor Collaboration Site\u201d (or \u201cMMC Site\u201d) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A \u201cMassive Multiauthor Collaboration\u201d (or \u201cMMC\u201d) contained in the site means any set of copyrightable works thus published on the MMC site. \u201cCC-BY-SA\u201d means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization. \u201cIncorporate\u201d means to publish or republish a Document, in whole or in part, as part of another Document. An MMC is \u201celigible for relicensing\u201d if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008. The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.","title":"11. RELICENSING"},{"location":"licenses/gfdl/#addendum-how-to-use-this-license-for-your-documents","text":"To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: Copyright (C) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled \"GNU Free Documentation License\". If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the \u201cwith \u00e2\u20ac\u00a6 Texts.\u201d line with this: with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.","title":"ADDENDUM: How to use this License for your documents"},{"location":"licenses/gnu-gpl/","text":"GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program\u2013to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers\u2019 and authors\u2019 protection, the GPL clearly explains that there is no warranty for this free software. For both users\u2019 and authors\u2019 sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users\u2019 freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. \u201cThis License\u201d refers to version 3 of the GNU General Public License. \u201cCopyright\u201d also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. \u201cThe Program\u201d refers to any copyrightable work licensed under this License. Each licensee is addressed as \u201cyou\u201d. \u201cLicensees\u201d and \u201crecipients\u201d may be individuals or organizations. To \u201cmodify\u201d a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a \u201cmodified version\u201d of the earlier work or a work \u201cbased on\u201d the earlier work. A \u201ccovered work\u201d means either the unmodified Program or a work based on the Program. To \u201cpropagate\u201d a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To \u201cconvey\u201d a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays \u201cAppropriate Legal Notices\u201d to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The \u201csource code\u201d for a work means the preferred form of the work for making modifications to it. \u201cObject code\u201d means any non-source form of a work. A \u201cStandard Interface\u201d means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The \u201cSystem Libraries\u201d of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A \u201cMajor Component\u201d, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The \u201cCorresponding Source\u201d for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work\u2019s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users\u2019 Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work\u2019s users, your or third parties\u2019 legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program\u2019s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to \u201ckeep intact all notices\u201d. c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an \u201caggregate\u201d if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation\u2019s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A \u201cUser Product\u201d is either (1) a \u201cconsumer product\u201d, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, \u201cnormally used\u201d refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. \u201cInstallation Information\u201d for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. \u201cAdditional permissions\u201d are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered \u201cfurther restrictions\u201d within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An \u201centity transaction\u201d is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party\u2019s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A \u201ccontributor\u201d is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor\u2019s \u201ccontributor version\u201d. A contributor\u2019s \u201cessential patent claims\u201d are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, \u201ccontrol\u201d includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor\u2019s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a \u201cpatent license\u201d is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To \u201cgrant\u201d such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. \u201cKnowingly relying\u201d means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient\u2019s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is \u201cdiscriminatory\u201d if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others\u2019 Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License \u201cor any later version\u201d applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy\u2019s public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \u201cAS IS\u201d WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the \u201ccopyright\u201d line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w\u2019 and `show c\u2019 should show the appropriate parts of the General Public License. Of course, your program\u2019s commands might be different; for a GUI interface, you would use an \u201cabout box\u201d. You should also get your employer (if you work as a programmer) or school, if any, to sign a \u201ccopyright disclaimer\u201d for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see https://www.gnu.org/licenses/ . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read https://www.gnu.org/licenses/why-not-lgpl.html .","title":"GNU GPLv3"},{"location":"licenses/gnu-gpl/#gnu-general-public-license","text":"Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.","title":"GNU GENERAL PUBLIC LICENSE"},{"location":"licenses/gnu-gpl/#preamble","text":"The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program\u2013to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers\u2019 and authors\u2019 protection, the GPL clearly explains that there is no warranty for this free software. For both users\u2019 and authors\u2019 sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users\u2019 freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow.","title":"Preamble"},{"location":"licenses/gnu-gpl/#terms-and-conditions","text":"","title":"TERMS AND CONDITIONS"},{"location":"licenses/gnu-gpl/#0-definitions","text":"\u201cThis License\u201d refers to version 3 of the GNU General Public License. \u201cCopyright\u201d also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. \u201cThe Program\u201d refers to any copyrightable work licensed under this License. Each licensee is addressed as \u201cyou\u201d. \u201cLicensees\u201d and \u201crecipients\u201d may be individuals or organizations. To \u201cmodify\u201d a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a \u201cmodified version\u201d of the earlier work or a work \u201cbased on\u201d the earlier work. A \u201ccovered work\u201d means either the unmodified Program or a work based on the Program. To \u201cpropagate\u201d a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To \u201cconvey\u201d a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays \u201cAppropriate Legal Notices\u201d to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.","title":"0. Definitions."},{"location":"licenses/gnu-gpl/#1-source-code","text":"The \u201csource code\u201d for a work means the preferred form of the work for making modifications to it. \u201cObject code\u201d means any non-source form of a work. A \u201cStandard Interface\u201d means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The \u201cSystem Libraries\u201d of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A \u201cMajor Component\u201d, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The \u201cCorresponding Source\u201d for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work\u2019s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work.","title":"1. Source Code."},{"location":"licenses/gnu-gpl/#2-basic-permissions","text":"All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.","title":"2. Basic Permissions."},{"location":"licenses/gnu-gpl/#3-protecting-users-legal-rights-from-anti-circumvention-law","text":"No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work\u2019s users, your or third parties\u2019 legal rights to forbid circumvention of technological measures.","title":"3. Protecting Users' Legal Rights From Anti-Circumvention Law."},{"location":"licenses/gnu-gpl/#4-conveying-verbatim-copies","text":"You may convey verbatim copies of the Program\u2019s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.","title":"4. Conveying Verbatim Copies."},{"location":"licenses/gnu-gpl/#5-conveying-modified-source-versions","text":"You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to \u201ckeep intact all notices\u201d. c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an \u201caggregate\u201d if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation\u2019s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.","title":"5. Conveying Modified Source Versions."},{"location":"licenses/gnu-gpl/#6-conveying-non-source-forms","text":"You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A \u201cUser Product\u201d is either (1) a \u201cconsumer product\u201d, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, \u201cnormally used\u201d refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. \u201cInstallation Information\u201d for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.","title":"6. Conveying Non-Source Forms."},{"location":"licenses/gnu-gpl/#7-additional-terms","text":"\u201cAdditional permissions\u201d are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered \u201cfurther restrictions\u201d within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.","title":"7. Additional Terms."},{"location":"licenses/gnu-gpl/#8-termination","text":"You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.","title":"8. Termination."},{"location":"licenses/gnu-gpl/#9-acceptance-not-required-for-having-copies","text":"You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.","title":"9. Acceptance Not Required for Having Copies."},{"location":"licenses/gnu-gpl/#10-automatic-licensing-of-downstream-recipients","text":"Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An \u201centity transaction\u201d is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party\u2019s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.","title":"10. Automatic Licensing of Downstream Recipients."},{"location":"licenses/gnu-gpl/#11-patents","text":"A \u201ccontributor\u201d is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor\u2019s \u201ccontributor version\u201d. A contributor\u2019s \u201cessential patent claims\u201d are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, \u201ccontrol\u201d includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor\u2019s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a \u201cpatent license\u201d is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To \u201cgrant\u201d such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. \u201cKnowingly relying\u201d means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient\u2019s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is \u201cdiscriminatory\u201d if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.","title":"11. Patents."},{"location":"licenses/gnu-gpl/#12-no-surrender-of-others-freedom","text":"If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.","title":"12. No Surrender of Others' Freedom."},{"location":"licenses/gnu-gpl/#13-use-with-the-gnu-affero-general-public-license","text":"Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.","title":"13. Use with the GNU Affero General Public License."},{"location":"licenses/gnu-gpl/#14-revised-versions-of-this-license","text":"The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License \u201cor any later version\u201d applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy\u2019s public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.","title":"14. Revised Versions of this License."},{"location":"licenses/gnu-gpl/#15-disclaimer-of-warranty","text":"THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \u201cAS IS\u201d WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.","title":"15. Disclaimer of Warranty."},{"location":"licenses/gnu-gpl/#16-limitation-of-liability","text":"IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.","title":"16. Limitation of Liability."},{"location":"licenses/gnu-gpl/#17-interpretation-of-sections-15-and-16","text":"If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS","title":"17. Interpretation of Sections 15 and 16."},{"location":"licenses/gnu-gpl/#how-to-apply-these-terms-to-your-new-programs","text":"If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the \u201ccopyright\u201d line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w\u2019 and `show c\u2019 should show the appropriate parts of the General Public License. Of course, your program\u2019s commands might be different; for a GUI interface, you would use an \u201cabout box\u201d. You should also get your employer (if you work as a programmer) or school, if any, to sign a \u201ccopyright disclaimer\u201d for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see https://www.gnu.org/licenses/ . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read https://www.gnu.org/licenses/why-not-lgpl.html .","title":"How to Apply These Terms to Your New Programs"},{"location":"pipeline/","text":"Ramses - The Rx Asset Management System: Introduction Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . This first part of the Ramses documention intents to help you understand the general concepts and key features of Ramses without going into technical details. As Ramses is not made of one single application but of several components, the technical description and user guide of each piece of software is available individually in the second part of this documentation . Features Ramses has three different main features, which are closely related and for which each component plays its role: Pipeline automation , Production Tracking and Production Planning , along with the global administration of course. \u25b9 Administration . \u25b9 Pipeline . \u25b9 Production Tracking . \u25b9 Planning . The components Ramses is a complete framework made of several components, as you can see on the image above. Each component has to be installed individually, and not all components are mandatory to use Ramses . Here is the list of all the components along with a few notes about them. Component Relations Description Technical Documentation Ramses Server Serves the data to the Ramses Client . The server stores and serves all shared data between all workstations in the studio. The Ramses Clients installed on these workstations connect to it to retrieve tha data they need. \u25b9 Read the doc . Ramses Client Application Connects to the Ramses Server to share the data. Serves the data that the Ramses Add-ons need to automate the pipeline. The client application is the central node of the Ramses framework. All information is available through the application, and it is able to drive the Ramses Add-ons in the creative applications. Note that it can be used stand-alone in an offline mode without the server, for one-man bands. \u25b9 Read the doc . Ramses Add-ons Connect to the Ramses Client to get the data they need to automate the pipeline. The add-ons integrate Ramses into your favorite creative applications (3D or 2D Animation, designing, compositing software, etc.). They can automate your workflow, and they handle all the file versionning, while providing production tracking data to the Ramses client . \u25b9 Read the doc . Ramses Tree Read by the Ramses Add-ons and the Ramses Client . The Ramses Tree is the way Ramses stores and sorts your files. Thanks to a carefully crafted file and folder naming scheme and conventions, both the Ramses Add-ons and the Ramses Client can efficiently handle all your files and data. \u25b9 Read the doc . Hint Ramses is not meant to be available as a service : we believe you should stay in control of your own data without relying onto unknown people, even people as loving as us (and you won\u2019t have to pay mensual or annual fees just to use Ramses ). Even if you\u2019re running your own small studio or tiny collective, it\u2019s very easy to install and use the Ramses server, it can be done on any computer running Windows , Linux or Mac OS , or better, on any low-cost shared hosting with just a very small available space and a small SQL database. All the installation procedure is explained in the server documentation . This being said, we (will soon) also have a few options for servers we can install and manage for you at a very low cost . Installation In order to use Ramses , you have to install the components you need individually, one after each other. Component Installation notes Ramses Server Requires a standard AMP stack ( Apache , MySQL , PHP ). You can install the Ramses server easily: \u25b9 Installation guide Ramses Client The client is a simple application, installed the same way as other applications: \u25b9 Installation guide Ramses Add-ons Add-ons installation differs depending on the host application: \u25b9 Maya installation \u25b9 Other hosts coming soon!","title":"Introduction"},{"location":"pipeline/#ramses-the-rx-asset-management-system-introduction","text":"Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . This first part of the Ramses documention intents to help you understand the general concepts and key features of Ramses without going into technical details. As Ramses is not made of one single application but of several components, the technical description and user guide of each piece of software is available individually in the second part of this documentation .","title":"Ramses - The Rx Asset Management System: Introduction"},{"location":"pipeline/#features","text":"Ramses has three different main features, which are closely related and for which each component plays its role: Pipeline automation , Production Tracking and Production Planning , along with the global administration of course. \u25b9 Administration . \u25b9 Pipeline . \u25b9 Production Tracking . \u25b9 Planning .","title":"Features"},{"location":"pipeline/#the-components","text":"Ramses is a complete framework made of several components, as you can see on the image above. Each component has to be installed individually, and not all components are mandatory to use Ramses . Here is the list of all the components along with a few notes about them. Component Relations Description Technical Documentation Ramses Server Serves the data to the Ramses Client . The server stores and serves all shared data between all workstations in the studio. The Ramses Clients installed on these workstations connect to it to retrieve tha data they need. \u25b9 Read the doc . Ramses Client Application Connects to the Ramses Server to share the data. Serves the data that the Ramses Add-ons need to automate the pipeline. The client application is the central node of the Ramses framework. All information is available through the application, and it is able to drive the Ramses Add-ons in the creative applications. Note that it can be used stand-alone in an offline mode without the server, for one-man bands. \u25b9 Read the doc . Ramses Add-ons Connect to the Ramses Client to get the data they need to automate the pipeline. The add-ons integrate Ramses into your favorite creative applications (3D or 2D Animation, designing, compositing software, etc.). They can automate your workflow, and they handle all the file versionning, while providing production tracking data to the Ramses client . \u25b9 Read the doc . Ramses Tree Read by the Ramses Add-ons and the Ramses Client . The Ramses Tree is the way Ramses stores and sorts your files. Thanks to a carefully crafted file and folder naming scheme and conventions, both the Ramses Add-ons and the Ramses Client can efficiently handle all your files and data. \u25b9 Read the doc . Hint Ramses is not meant to be available as a service : we believe you should stay in control of your own data without relying onto unknown people, even people as loving as us (and you won\u2019t have to pay mensual or annual fees just to use Ramses ). Even if you\u2019re running your own small studio or tiny collective, it\u2019s very easy to install and use the Ramses server, it can be done on any computer running Windows , Linux or Mac OS , or better, on any low-cost shared hosting with just a very small available space and a small SQL database. All the installation procedure is explained in the server documentation . This being said, we (will soon) also have a few options for servers we can install and manage for you at a very low cost .","title":"The components"},{"location":"pipeline/#installation","text":"In order to use Ramses , you have to install the components you need individually, one after each other. Component Installation notes Ramses Server Requires a standard AMP stack ( Apache , MySQL , PHP ). You can install the Ramses server easily: \u25b9 Installation guide Ramses Client The client is a simple application, installed the same way as other applications: \u25b9 Installation guide Ramses Add-ons Add-ons installation differs depending on the host application: \u25b9 Maya installation \u25b9 Other hosts coming soon!","title":"Installation"},{"location":"pipeline/administration/","text":"Ramses Administration (Projects and Users) The administration panel, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . In order to use Ramses , at least one user and one project are needed; when using the Ramses Client Application , you can also manage other elements. Both users and projects are represented by folders in the Ramses Tree , and Ramses components will list them from the default folders if they can\u2019t get the information from the Ramses Client Application or Ramses Server . Users The list of users is available and can be managed in the Ramses Client Application , under the administration panel (for administrator users) , and by default each user is represented by a folder in the Ramses Tree as shown below. \u250c Ramses Folder \u2502 \u2514\u2500\u252c\u2500 Users # User files \u2502 # The name of the user folders are their individual ID \u2502 \u251c\u2500\u252c\u2500 Duduf # Files for a single user (ID) \u2502 \u2514\u2500\u2500\u2500 Config # Configuration files for this user \u2502 \u251c\u2500\u252c\u2500 John # ID \u2502 \u2514\u2500\u2500\u2500 Config \u2502 \u2514\u2500\u2500\u2500 ... Tip Without using the Ramses Client Application , you can create users by creating their folder in the default location in the Ramses Tree . Each user is represented by its name and ID , and has a role . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The role defines the rights the user has to manage Ramses , the projects, the assets, etc. There are four roles listed below. \u25b9 User management in the Ramses Client Application . Administrator The Administrator has all rights to configure and modify Ramses , especially but non exclusively: Creating, removing projects. Creating, modifying, removing template steps. Creating, modifying, removing users. The Administrator has all other rights from other roles too. Note Althought the administrator has the right to modify all users, he cannot remove himself nor change his own role. Another administrator has to do it. Project Admin The Project Administrator has the necessary rights to configure and modify projects, especially but non exclusively: Modifying projects. Creating, modifying, removing steps. Assigning Users to projects. Creating, modifying, removing Asset Groups. Creating, modifying, removing Sequences. Lead The lead is a user who can manage projects, and has less rights than the administrator : Creating, modifying, removing shots. Creating, modifying, removing assets. Assigning users to assets and shots. Standard User (User) The standard user cannot modify nor remove anything from Ramses , but interacts with shots and assets. Projects Projects represent the final artwork : a feature film or one of its sequence, an episode in a TV series, a short movie, a music video\u2026 They are made of Shots which are in turn made of Assets . Assets and Shots are produced through different Steps which are inter-dependent. Shots are grouped in Sequences , and a project contains at least one sequence. Assets are grouped in Asset Groups (e.g. characters, sets, props\u2026). Note It is not mandatory to use sequences, and for short projects (less than a hundred shots), it is often easier to just have a single sequence. The list of projects is available and can be managed in the Ramses Client Application , under the administration panel (for administrator users) , and by default each project is represented by a folder in the Ramses Tree as shown below. \u250c Ramses Folder \u2502 \u2514\u2500\u252c\u2500 Projects # Project files \u2502 # The name of the project folders are their individual ID \u2502 \u251c\u2500\u2500\u2500 TI # A project (ID) \u2502 \u251c\u2500\u2500\u2500 PPB # Another project (ID) \u2502 \u2514\u2500\u2500\u2500 ... Tip Without using the Ramses Client Application , you can create projects by creating their folder in the default location in the Ramses Tree . Each project is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The projects also have the characteristics of the final video ( width and height in pixels, framerate , duration \u2026). They also have a deadline defining the date when the project has to be finished and delivered. Users can be assigned to specific projects. \u25b9 Project management in the Ramses Client Application .","title":"Administration"},{"location":"pipeline/administration/#ramses-administration-projects-and-users","text":"The administration panel, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . In order to use Ramses , at least one user and one project are needed; when using the Ramses Client Application , you can also manage other elements. Both users and projects are represented by folders in the Ramses Tree , and Ramses components will list them from the default folders if they can\u2019t get the information from the Ramses Client Application or Ramses Server .","title":"Ramses Administration (Projects and Users)"},{"location":"pipeline/administration/#users","text":"The list of users is available and can be managed in the Ramses Client Application , under the administration panel (for administrator users) , and by default each user is represented by a folder in the Ramses Tree as shown below. \u250c Ramses Folder \u2502 \u2514\u2500\u252c\u2500 Users # User files \u2502 # The name of the user folders are their individual ID \u2502 \u251c\u2500\u252c\u2500 Duduf # Files for a single user (ID) \u2502 \u2514\u2500\u2500\u2500 Config # Configuration files for this user \u2502 \u251c\u2500\u252c\u2500 John # ID \u2502 \u2514\u2500\u2500\u2500 Config \u2502 \u2514\u2500\u2500\u2500 ... Tip Without using the Ramses Client Application , you can create users by creating their folder in the default location in the Ramses Tree . Each user is represented by its name and ID , and has a role . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The role defines the rights the user has to manage Ramses , the projects, the assets, etc. There are four roles listed below. \u25b9 User management in the Ramses Client Application .","title":"Users"},{"location":"pipeline/administration/#administrator","text":"The Administrator has all rights to configure and modify Ramses , especially but non exclusively: Creating, removing projects. Creating, modifying, removing template steps. Creating, modifying, removing users. The Administrator has all other rights from other roles too. Note Althought the administrator has the right to modify all users, he cannot remove himself nor change his own role. Another administrator has to do it.","title":"Administrator"},{"location":"pipeline/administration/#project-admin","text":"The Project Administrator has the necessary rights to configure and modify projects, especially but non exclusively: Modifying projects. Creating, modifying, removing steps. Assigning Users to projects. Creating, modifying, removing Asset Groups. Creating, modifying, removing Sequences.","title":"Project Admin"},{"location":"pipeline/administration/#lead","text":"The lead is a user who can manage projects, and has less rights than the administrator : Creating, modifying, removing shots. Creating, modifying, removing assets. Assigning users to assets and shots.","title":"Lead"},{"location":"pipeline/administration/#standard-user-user","text":"The standard user cannot modify nor remove anything from Ramses , but interacts with shots and assets.","title":"Standard User (User)"},{"location":"pipeline/administration/#projects","text":"Projects represent the final artwork : a feature film or one of its sequence, an episode in a TV series, a short movie, a music video\u2026 They are made of Shots which are in turn made of Assets . Assets and Shots are produced through different Steps which are inter-dependent. Shots are grouped in Sequences , and a project contains at least one sequence. Assets are grouped in Asset Groups (e.g. characters, sets, props\u2026). Note It is not mandatory to use sequences, and for short projects (less than a hundred shots), it is often easier to just have a single sequence. The list of projects is available and can be managed in the Ramses Client Application , under the administration panel (for administrator users) , and by default each project is represented by a folder in the Ramses Tree as shown below. \u250c Ramses Folder \u2502 \u2514\u2500\u252c\u2500 Projects # Project files \u2502 # The name of the project folders are their individual ID \u2502 \u251c\u2500\u2500\u2500 TI # A project (ID) \u2502 \u251c\u2500\u2500\u2500 PPB # Another project (ID) \u2502 \u2514\u2500\u2500\u2500 ... Tip Without using the Ramses Client Application , you can create projects by creating their folder in the default location in the Ramses Tree . Each project is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The projects also have the characteristics of the final video ( width and height in pixels, framerate , duration \u2026). They also have a deadline defining the date when the project has to be finished and delivered. Users can be assigned to specific projects. \u25b9 Project management in the Ramses Client Application .","title":"Projects"},{"location":"pipeline/pipeline/","text":"Pipeline The pipeline editor, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . The pipeline describes the way the production of the assets and the shots goes through each step . It actually describes each connection, each pipe between each step, keeping important information like the file type used and its color space for example. In combination with the Ramses Add-ons which integrate Ramses in your favorite creative software, Ramses is able to automate your pipeline , managing the versionning of the files, the exports, imports and all these manual tasks a robot could do for you. The pipeline is made of Steps which are connected together with Pipes . The pipeline also handles your Applications and File types . In the future, Ramses will handle color spaces too. For each pipe, each connection, you can define precisely which file types are to be used, so that the Ramses Add-ons can use this information to automate all exports and imports. The pipes are also used in Production tracking . Ramses Add-ons are also in charge of versionning and creating preview images and videos to be used in other components. The pipeline relies on the Ramses Tree to automatically manage the files and folders. A working folder All working folders should contain a few predefined subfolders, so that Ramses can efficiently handle the versionning and production tracking of all files, assets, and shots. This is a typical working folder (files are not shown): \u250c projectID_A_AssetID_StepID # The working folder, for an asset in this example \u2502 \u251c\u2500\u2500\u2500 _versions # The versionning folder, handled by Ramses. \u2502 # Contains the history and all versions \u251c\u2500\u2500\u2500 _published \u2502 # Contains the published files, to be imported by the next steps \u2514\u2500\u2500\u2500 _preview # Contains media files to be used to preview the work on this step (videos, images...) Ramses Add-ons automatically create and sort the files in these folders when working on an item, but you can manually create and use them, especially the _published and _preview subfolder. Any file added in these folders will be automatically detected and managed by Ramses . Even when not using a Ramses Add-on it is recommended to use this folder structure. All files inside these folders should be correctly named and respect all Ramses naming conventions . \u25b9 More information: The Ramses Tree . Creating a pipeline The creation of a pipeline is better made using the Ramses Client Application and its nodal Pipeline Editor , although it is also possible to use basic pipelines only with Ramses Add-ons or more complex ones thanks to the Add-on API and Ramses extensibility for developpers. A pipeline can be built quite quickly by following these steps: Set the project settings like its resolution and framerate. Create the steps (from scratch or using templates). List the applications which are going to be used. Assign applications to the steps. Connect the steps with pipes. (optional) Set the file types to be used through the pipes. (optional) Create Templates for the steps. (optional) Create default settings for publishing and importing items. (optional) Develop extensions for the Add-ons if you have specific needs for an advanced pipeline with a lot of automations. \u25b9 Pipeline editor in the Ramses Client Application . \u25b9 Available Add-ons . \u25b9 Add-on API for the extension or development of new Add-ons . Project settings From the Ramses Client Application , you can adjust the project settings. Specifically, the Resolution and Framerate can be used by the Add-ons to automatically setup the working files in the creative applications. List steps You can use the Ramses Client Application to list the steps needed to produce the project. Steps represent the stages the assets and shots have to go through before completion, for example Modeling , Rigging , Animation , Lighting \u2026 There are 4 different types of steps: Pre-Production includes all the steps of the work which has to be done to prepare and develop the project, but which will not actually be included in the project (for example: the storyboard, the script, etc.). Pre-production steps aren\u2019t linked to assets nor shots, but work on the project as a whole. Asset Production steps are the steps building assets which are needed to finalize the shots of the project (for example: the characters, props, sets, etc.) Shot Production steps are the steps where shots are built using assets (for example: animation, lighting, compositing, etc.) Post-Production includes all the steps from the edit to the delivery, where the work is made on the whole edit and not individual shots (for example: editing, sound design, music, etc.) The list of steps is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each step is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Project Root folder \u2502 \u251c\u2500\u252c\u2500 01-PRE-PROD \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_SCRIPT # Pre production step \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_STORYBOARD \u2502 \u251c\u2500\u252c\u2500 02-PROD \u2502 \u251c\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the mod step \u2502 \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the mod step \u2502 \u2514\u2500\u252c\u2500 PROJECTID_G_RIG # Common files for the rig step \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the rig step \u2502 \u2514\u2500\u252c\u2500 03-POST-PROD \u2514\u2500\u2500\u2500 PROJECTID_G_EDIT # Post production step Note These folders are not where the working files are stored ; they contain the common files, like libraries, examples, references, and the Templates used for the creation of new assets and shots. Working files are stored in the Assets and Shots subfolder of the project in the Ramses Tree . Tip Without using the Ramses Client Application , you can create steps by creating their folder in the default location in the project subfolder of the Ramses Tree . Each step is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The folder names for the steps respect the Ramses Naming Scheme : ProjectID_G_stepID . Steps are also associated with the applications used to produce the assets and shots (read below). They also have default values for production estimations (read the Planning section for more information). Add Applications In order to manage the assets and the files they use, Ramses keeps track of the Applications used in the production. For each Application , Ramses keeps also three lists of file types : Native types are the file types used natively by the applications; the ones which type can be created with a save command and which store data in a lossless manner. Import types are all the file types the application can import. Export types are all the file types the application can create, usually with an export or bake command for example. The Ramses client can open applications and open files in applications; Ramses Add-ons should be able to save and manage the versionning in an application, as long as import and export assets. \u25b9 Application management in the Ramses Client Application . File types In order to manage the assets and the files they use, Ramses keeps track of the File Types used in the production. Specific file types can be marked as preview types , which means they\u2019re light and standard and can be used to display or preview an asset, but can store data in a lossy manner. File types can be associated with specific applications and pipes . \u25b9 File type management in the Ramses Client Application . Templates Step folders contain a Templates subfolder which contains the template files to be used when creating a new asset or a new shot . This can be done directly from the assets and shots tables in the Ramses Client Application or from Ramses Add-ons . The Templates subfolder is a standard working folder, and templates can have versions, a preview subfolder, and must be published to be used. Tip You can manually add files in the Templates subfolder; if you also copy them in the _published folder, Ramses will automatically detect and use them for asset and shot creation (see the section above entitled \u201c A working folder \u201d). \u25b9 Step management in the Ramses Client Application . \u25b9 Template Step management in the Ramses Client Application . Use pipes to connect steps You can use the Pipeline editor in the Ramses Client Application to build the pipeline and connect steps. Each pipe is a connection between two steps. It keeps the file types used to export from and import to these steps, as long as the color space of the files. Ramses Add-ons can use this information to automate the process. For each pipe you can add specific file types to be used. Tip Configuring pipes and passing the information to the Ramses Add-ons makes the pipeline very customizable and modular, but it is not mandatory when extending or developping an Add-on to use this information. Pipes also handle triggers which run scripts in your applications when a status changes in the production tracking of the corresponding steps (when a file runs through the pipe ). Pipes also automate the production management and are able to automatically update statuses, notify users of changes and of the disponibility of new materials for example. \u25b9 Pipeline editor in the Ramses Client Application . Automate the pipeline Using Ramses Add-ons you can easily automate the workflow with a properly configured pipeline. Publish settings For each step, you can define default publishing settings, either by inputing them in the settings of the step in the Ramses Client Application or through the add-on itself. Using official Ramses Add-ons , these settings should be simple Yaml formatted texts, looking like this: some_setting: true another_setting: false a_list: - item1 - item2 a_value: 42 other_info: \"05/05/1818\" The Ramses Add-ons will read these settings when publishing from the corresponding step to automatically publish the right format with the right parameters. \u25b9 Step settings in the Ramses Client Application . \u25b9 Ramses Add-ons . Import settings When importing previously published items, Ramses can also automate some settings and get default parameters, with the same kind of Yaml formatted presets. The import settings can also be set in the Ramses Client Application or through the add-on itself. \u25b9 Pipe type settings in the Ramses Client Application . \u25b9 Ramses Add-ons .","title":"Pipeline"},{"location":"pipeline/pipeline/#pipeline","text":"The pipeline editor, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . The pipeline describes the way the production of the assets and the shots goes through each step . It actually describes each connection, each pipe between each step, keeping important information like the file type used and its color space for example. In combination with the Ramses Add-ons which integrate Ramses in your favorite creative software, Ramses is able to automate your pipeline , managing the versionning of the files, the exports, imports and all these manual tasks a robot could do for you. The pipeline is made of Steps which are connected together with Pipes . The pipeline also handles your Applications and File types . In the future, Ramses will handle color spaces too. For each pipe, each connection, you can define precisely which file types are to be used, so that the Ramses Add-ons can use this information to automate all exports and imports. The pipes are also used in Production tracking . Ramses Add-ons are also in charge of versionning and creating preview images and videos to be used in other components. The pipeline relies on the Ramses Tree to automatically manage the files and folders.","title":"Pipeline"},{"location":"pipeline/pipeline/#a-working-folder","text":"All working folders should contain a few predefined subfolders, so that Ramses can efficiently handle the versionning and production tracking of all files, assets, and shots. This is a typical working folder (files are not shown): \u250c projectID_A_AssetID_StepID # The working folder, for an asset in this example \u2502 \u251c\u2500\u2500\u2500 _versions # The versionning folder, handled by Ramses. \u2502 # Contains the history and all versions \u251c\u2500\u2500\u2500 _published \u2502 # Contains the published files, to be imported by the next steps \u2514\u2500\u2500\u2500 _preview # Contains media files to be used to preview the work on this step (videos, images...) Ramses Add-ons automatically create and sort the files in these folders when working on an item, but you can manually create and use them, especially the _published and _preview subfolder. Any file added in these folders will be automatically detected and managed by Ramses . Even when not using a Ramses Add-on it is recommended to use this folder structure. All files inside these folders should be correctly named and respect all Ramses naming conventions . \u25b9 More information: The Ramses Tree .","title":"A working folder"},{"location":"pipeline/pipeline/#creating-a-pipeline","text":"The creation of a pipeline is better made using the Ramses Client Application and its nodal Pipeline Editor , although it is also possible to use basic pipelines only with Ramses Add-ons or more complex ones thanks to the Add-on API and Ramses extensibility for developpers. A pipeline can be built quite quickly by following these steps: Set the project settings like its resolution and framerate. Create the steps (from scratch or using templates). List the applications which are going to be used. Assign applications to the steps. Connect the steps with pipes. (optional) Set the file types to be used through the pipes. (optional) Create Templates for the steps. (optional) Create default settings for publishing and importing items. (optional) Develop extensions for the Add-ons if you have specific needs for an advanced pipeline with a lot of automations. \u25b9 Pipeline editor in the Ramses Client Application . \u25b9 Available Add-ons . \u25b9 Add-on API for the extension or development of new Add-ons .","title":"Creating a pipeline"},{"location":"pipeline/pipeline/#project-settings","text":"From the Ramses Client Application , you can adjust the project settings. Specifically, the Resolution and Framerate can be used by the Add-ons to automatically setup the working files in the creative applications.","title":"Project settings"},{"location":"pipeline/pipeline/#list-steps","text":"You can use the Ramses Client Application to list the steps needed to produce the project. Steps represent the stages the assets and shots have to go through before completion, for example Modeling , Rigging , Animation , Lighting \u2026 There are 4 different types of steps: Pre-Production includes all the steps of the work which has to be done to prepare and develop the project, but which will not actually be included in the project (for example: the storyboard, the script, etc.). Pre-production steps aren\u2019t linked to assets nor shots, but work on the project as a whole. Asset Production steps are the steps building assets which are needed to finalize the shots of the project (for example: the characters, props, sets, etc.) Shot Production steps are the steps where shots are built using assets (for example: animation, lighting, compositing, etc.) Post-Production includes all the steps from the edit to the delivery, where the work is made on the whole edit and not individual shots (for example: editing, sound design, music, etc.) The list of steps is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each step is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Project Root folder \u2502 \u251c\u2500\u252c\u2500 01-PRE-PROD \u2502 \u251c\u2500\u2500\u2500 PROJECTID_G_SCRIPT # Pre production step \u2502 \u2514\u2500\u2500\u2500 PROJECTID_G_STORYBOARD \u2502 \u251c\u2500\u252c\u2500 02-PROD \u2502 \u251c\u2500\u252c\u2500 PROJECTID_G_MOD # Common files for the mod step \u2502 \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the mod step \u2502 \u2514\u2500\u252c\u2500 PROJECTID_G_RIG # Common files for the rig step \u2502 \u2514\u2500\u2500\u2500 Templates # Template files for the rig step \u2502 \u2514\u2500\u252c\u2500 03-POST-PROD \u2514\u2500\u2500\u2500 PROJECTID_G_EDIT # Post production step Note These folders are not where the working files are stored ; they contain the common files, like libraries, examples, references, and the Templates used for the creation of new assets and shots. Working files are stored in the Assets and Shots subfolder of the project in the Ramses Tree . Tip Without using the Ramses Client Application , you can create steps by creating their folder in the default location in the project subfolder of the Ramses Tree . Each step is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. The folder names for the steps respect the Ramses Naming Scheme : ProjectID_G_stepID . Steps are also associated with the applications used to produce the assets and shots (read below). They also have default values for production estimations (read the Planning section for more information).","title":"List steps"},{"location":"pipeline/pipeline/#add-applications","text":"In order to manage the assets and the files they use, Ramses keeps track of the Applications used in the production. For each Application , Ramses keeps also three lists of file types : Native types are the file types used natively by the applications; the ones which type can be created with a save command and which store data in a lossless manner. Import types are all the file types the application can import. Export types are all the file types the application can create, usually with an export or bake command for example. The Ramses client can open applications and open files in applications; Ramses Add-ons should be able to save and manage the versionning in an application, as long as import and export assets. \u25b9 Application management in the Ramses Client Application .","title":"Add Applications"},{"location":"pipeline/pipeline/#file-types","text":"In order to manage the assets and the files they use, Ramses keeps track of the File Types used in the production. Specific file types can be marked as preview types , which means they\u2019re light and standard and can be used to display or preview an asset, but can store data in a lossy manner. File types can be associated with specific applications and pipes . \u25b9 File type management in the Ramses Client Application .","title":"File types"},{"location":"pipeline/pipeline/#templates","text":"Step folders contain a Templates subfolder which contains the template files to be used when creating a new asset or a new shot . This can be done directly from the assets and shots tables in the Ramses Client Application or from Ramses Add-ons . The Templates subfolder is a standard working folder, and templates can have versions, a preview subfolder, and must be published to be used. Tip You can manually add files in the Templates subfolder; if you also copy them in the _published folder, Ramses will automatically detect and use them for asset and shot creation (see the section above entitled \u201c A working folder \u201d). \u25b9 Step management in the Ramses Client Application . \u25b9 Template Step management in the Ramses Client Application .","title":"Templates"},{"location":"pipeline/pipeline/#use-pipes-to-connect-steps","text":"You can use the Pipeline editor in the Ramses Client Application to build the pipeline and connect steps. Each pipe is a connection between two steps. It keeps the file types used to export from and import to these steps, as long as the color space of the files. Ramses Add-ons can use this information to automate the process. For each pipe you can add specific file types to be used. Tip Configuring pipes and passing the information to the Ramses Add-ons makes the pipeline very customizable and modular, but it is not mandatory when extending or developping an Add-on to use this information. Pipes also handle triggers which run scripts in your applications when a status changes in the production tracking of the corresponding steps (when a file runs through the pipe ). Pipes also automate the production management and are able to automatically update statuses, notify users of changes and of the disponibility of new materials for example. \u25b9 Pipeline editor in the Ramses Client Application .","title":"Use pipes to connect steps"},{"location":"pipeline/pipeline/#automate-the-pipeline","text":"Using Ramses Add-ons you can easily automate the workflow with a properly configured pipeline.","title":"Automate the pipeline"},{"location":"pipeline/pipeline/#publish-settings","text":"For each step, you can define default publishing settings, either by inputing them in the settings of the step in the Ramses Client Application or through the add-on itself. Using official Ramses Add-ons , these settings should be simple Yaml formatted texts, looking like this: some_setting: true another_setting: false a_list: - item1 - item2 a_value: 42 other_info: \"05/05/1818\" The Ramses Add-ons will read these settings when publishing from the corresponding step to automatically publish the right format with the right parameters. \u25b9 Step settings in the Ramses Client Application . \u25b9 Ramses Add-ons .","title":"Publish settings"},{"location":"pipeline/pipeline/#import-settings","text":"When importing previously published items, Ramses can also automate some settings and get default parameters, with the same kind of Yaml formatted presets. The import settings can also be set in the Ramses Client Application or through the add-on itself. \u25b9 Pipe type settings in the Ramses Client Application . \u25b9 Ramses Add-ons .","title":"Import settings"},{"location":"pipeline/planning/","text":"Production Planning The schedule table, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . As Ramses is able to (automatically) estimate the time needed for the production of the individual assets and shots , it can help you plan the production, and keep track of the time needed to produce any project. At the step level, default estimations can be set to be used on shots and assets, depending on the difficulty of their productions. Then, each individual estimation can be customized for a finer evaluation of the time needed for the production. Estimations To establish a realistic schedule, it is important to be able to estimate the time needed to produce the project, as well as tracking the production to adjust these estimations if needed. Ramses helps you to quickly estimate this time needed, and then helps you to make it as precise as you need. The unit used for estimations by Ramses is the day (which can be divided into smaller parts of a day if you need). Counting in days is precise enough for planning a production, and this way you don\u2019t need to know exactly how many hours are (actually) worked in a day. Note There\u2019s no way with Ramses to link the production tracking data to individual users (meaning that there\u2019s no easy way to build statistics about users or compare their productivity). That\u2019s by design, don\u2019t ask for it. Step estimations For each step, it is possible to set a default estimation which will be used for all assets and shots. This estimation, usually set in days of work, can vary with the difficulty for the production of each specific asset or shot; Ramses lets you define an estimation for five predefined levels of difficulty: very easy , easy , medium , hard , very hard . This default estimation is used to automatically evaluate the time needed for the production of the whole step, depending on the assets or shots which have to be produced, at first based on a medium difficulty. Adjusting the difficulty per shot or asset will then automatically update the global estimation to raise the precision. For the production of shots , the estimations can also be optionnaly and automatically multiplied by the duration of the shot, so that the estimation can be made per second instead of per shot , and also by the number of assets used by the shot , for example to multiply the estimation by the number of characters in the shot. \u25b9 Step management in the Ramses Client Application . Asset and shots estimations The estimation set by default by the step and automatically computed based on the number of assets, the duration and the difficulty can always be individually overriden for each shot and asset, for a more precise control on the estimations. This is done through the Production Tracking \u25b9 Production tracking in the Ramses Client Application . Schedule Based on the estimations, Ramses evaluates the number of days of work needed to complete the work on each step for all assets and shots. It is then easier to prepare the production planning and establish a schedule, by assigning days of work to users and steps . Ramses will keep track of the number of days already assigned and missing (or extra) days to help you plan the production. In case of lateness on the production of a step (shown by Ramses ), it means the quantity or the diffuclty of the work was underestimated; all that needs to be done is then to adjust the estimations at the step level to update all assets and shots estimations, then check if the schedule can still be respected, or assign more users or days of work to the step. \u25b9 Schedule panel in the Ramses Client Application .","title":"Planning"},{"location":"pipeline/planning/#production-planning","text":"The schedule table, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . As Ramses is able to (automatically) estimate the time needed for the production of the individual assets and shots , it can help you plan the production, and keep track of the time needed to produce any project. At the step level, default estimations can be set to be used on shots and assets, depending on the difficulty of their productions. Then, each individual estimation can be customized for a finer evaluation of the time needed for the production.","title":"Production Planning"},{"location":"pipeline/planning/#estimations","text":"To establish a realistic schedule, it is important to be able to estimate the time needed to produce the project, as well as tracking the production to adjust these estimations if needed. Ramses helps you to quickly estimate this time needed, and then helps you to make it as precise as you need. The unit used for estimations by Ramses is the day (which can be divided into smaller parts of a day if you need). Counting in days is precise enough for planning a production, and this way you don\u2019t need to know exactly how many hours are (actually) worked in a day. Note There\u2019s no way with Ramses to link the production tracking data to individual users (meaning that there\u2019s no easy way to build statistics about users or compare their productivity). That\u2019s by design, don\u2019t ask for it.","title":"Estimations"},{"location":"pipeline/planning/#step-estimations","text":"For each step, it is possible to set a default estimation which will be used for all assets and shots. This estimation, usually set in days of work, can vary with the difficulty for the production of each specific asset or shot; Ramses lets you define an estimation for five predefined levels of difficulty: very easy , easy , medium , hard , very hard . This default estimation is used to automatically evaluate the time needed for the production of the whole step, depending on the assets or shots which have to be produced, at first based on a medium difficulty. Adjusting the difficulty per shot or asset will then automatically update the global estimation to raise the precision. For the production of shots , the estimations can also be optionnaly and automatically multiplied by the duration of the shot, so that the estimation can be made per second instead of per shot , and also by the number of assets used by the shot , for example to multiply the estimation by the number of characters in the shot. \u25b9 Step management in the Ramses Client Application .","title":"Step estimations"},{"location":"pipeline/planning/#asset-and-shots-estimations","text":"The estimation set by default by the step and automatically computed based on the number of assets, the duration and the difficulty can always be individually overriden for each shot and asset, for a more precise control on the estimations. This is done through the Production Tracking \u25b9 Production tracking in the Ramses Client Application .","title":"Asset and shots estimations"},{"location":"pipeline/planning/#schedule","text":"Based on the estimations, Ramses evaluates the number of days of work needed to complete the work on each step for all assets and shots. It is then easier to prepare the production planning and establish a schedule, by assigning days of work to users and steps . Ramses will keep track of the number of days already assigned and missing (or extra) days to help you plan the production. In case of lateness on the production of a step (shown by Ramses ), it means the quantity or the diffuclty of the work was underestimated; all that needs to be done is then to adjust the estimations at the step level to update all assets and shots estimations, then check if the schedule can still be respected, or assign more users or days of work to the step. \u25b9 Schedule panel in the Ramses Client Application .","title":"Schedule"},{"location":"pipeline/production/","text":"Production Tracking The asset table, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . Ramses keeps track of the whole production for you, by tracking each asset and each shot at each step of the production. This allows for a precise information about the production of the whole project, and Ramses can summarize all this information in nice graphics. Ramses measures the time spent on the production of each asset and each shot, and the user can set a completion ratio along with setting the state of the production for each step. These values are closely related to the estimations used for production planning and Ramses is able to measure the lateness of the production in real time. To help users track the production, users can comment each task, and each task can be assigned to a specific user . States States are part of assets and shots status , along with comments and estimations . They also define a percentage of completion of the work for the corresponding step , to be used by default when setting a production status to the specific state. They can be configured globally to be used everywhere there\u2019s a need to show a statuss. Each state is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. They also have a color to be used to display them in the user interface. By default, Ramses includes a few predefined states, and some of them cannot be removed as they are needed by Ramses automations. Others are examples and can be customized or removed. These are the predefined states: ID Name Completion Mandatory Description NO Nothing to do 0% Yes There\u2019s nothing to do at this step. STB Stand by 0% Yes Something is missing, let\u2019s wait a bit. TODO Ready to do 0% Yes This step is ready, one can work on this. QST Question 20% No More information is needed to continue working on this. WIP Work in progress 50% Yes This is currently in production. CHK Waiting for approval 80% No This is ready to be reviewed. RDR Rendering 90% No This is currently rendering, soon we\u2019ll be able to watch this beautiful work! CBB Could be better 95% No This works like that, but if possible it can still be improved. OK Finished 100% Yes This has been reviewed and validated. \u25b9 State management in the Ramses Client Application . Assets An Asset is produced independently from the shots and can be used in several shots. They are the characters, sets, props, and any other re-usable item in the production. The list of assets is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each asset is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Root \u2502 \u2514\u2500\u252c\u2500 04-ASSETS \u251c\u2500\u252c\u2500 Characters # An asset group \u2502 \u2502 \u2502 \u251c\u2500\u252c\u2500 PROJECTID_A_TRISTAN # An Asset \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_DESIGN # An asset production step \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_RIG \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_TEX \u2502 \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_ISOLDE # An Asset \u2502 \u251c\u2500\u2500\u2500 Props # A Group of Assets \u2502 \u2514\u2500\u2500\u2500 Sets # A Group of Assets Tip Without using the Ramses Client Application , you can create assets by creating their folder in the default location in the project subfolder of the Ramses Tree . Each asset is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. They\u2019re grouped in Asset Groups to make them easier to sort, and produced through Asset Production Steps . They also have tags to be able to search for specific assets. \u25b9 Asset management in the Ramses Client Application . Shots A Shot is produced using assets and stored in a Sequence . The list of shots is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each shot is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Root \u2502 \u2514\u2500\u252c\u2500 05-SHOTS \u2502 \u251c\u2500\u252c\u2500 PROJECTID_S_01-001 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_ANIM # A shot production step \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_LIGHT \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_01-001_COMP \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-002 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-003 # A Shot \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_02-001 # A Shot Tip Without using the Ramses Client Application , you can create shots by creating their folder in the default location in the project subfolder of the Ramses Tree . Each shot is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. Each shot contains a list of assets which are needed for its production. Shots have a duration , usually shown either in seconds or frames, and the addition of all their duration is the duration of the project. \u25b9 Shot management in the Ramses Client Application . Production status of assets and shots All assets and shots have a production status, which is summarized in an asset table and a shot table in the Ramses Client Application . This status consists of a state , a comment and a completion ratio . Ramses also associates the time spent for the production of the item and the estimation to the status (read the Planning section for more information about estimations). All this information is added and summarized at the step level to show the completion for each step, each asset and each shot. Ramses also keeps track of the whole production at the project level with general statistics. Note There\u2019s no way with Ramses to link the production tracking data to individual users (meaning that there\u2019s no easy way to build statistics about users or compare their productivity). That\u2019s by design, don\u2019t ask for it. Ramses is also able to extract a lateness value from all the available information, available at all levels (shots, assets, steps and whole project). All the history of successive states, comments, completion ratio, etc. is always available. The combination of an asset or a shot and a step can be assigned to a specific user . For use with pipeline automations , status are also associated with specific versions of the files, and store the publication status. When using Ramses Add-ons , the state of a specific version is kept in the file name of the corresponding version file, thanks to the Ramses naming scheme \u25b9 Production tracking in the Ramses Client Application .","title":"Production tracking"},{"location":"pipeline/production/#production-tracking","text":"The asset table, as shown in the Ramses Client Application . Warning Ramses is still under active development , and this documentation is still being written. We strongly invite you to read the changelog to know what\u2019s going on, and especially to have a look at the known issues . Ramses keeps track of the whole production for you, by tracking each asset and each shot at each step of the production. This allows for a precise information about the production of the whole project, and Ramses can summarize all this information in nice graphics. Ramses measures the time spent on the production of each asset and each shot, and the user can set a completion ratio along with setting the state of the production for each step. These values are closely related to the estimations used for production planning and Ramses is able to measure the lateness of the production in real time. To help users track the production, users can comment each task, and each task can be assigned to a specific user .","title":"Production Tracking"},{"location":"pipeline/production/#states","text":"States are part of assets and shots status , along with comments and estimations . They also define a percentage of completion of the work for the corresponding step , to be used by default when setting a production status to the specific state. They can be configured globally to be used everywhere there\u2019s a need to show a statuss. Each state is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. They also have a color to be used to display them in the user interface. By default, Ramses includes a few predefined states, and some of them cannot be removed as they are needed by Ramses automations. Others are examples and can be customized or removed. These are the predefined states: ID Name Completion Mandatory Description NO Nothing to do 0% Yes There\u2019s nothing to do at this step. STB Stand by 0% Yes Something is missing, let\u2019s wait a bit. TODO Ready to do 0% Yes This step is ready, one can work on this. QST Question 20% No More information is needed to continue working on this. WIP Work in progress 50% Yes This is currently in production. CHK Waiting for approval 80% No This is ready to be reviewed. RDR Rendering 90% No This is currently rendering, soon we\u2019ll be able to watch this beautiful work! CBB Could be better 95% No This works like that, but if possible it can still be improved. OK Finished 100% Yes This has been reviewed and validated. \u25b9 State management in the Ramses Client Application .","title":"States"},{"location":"pipeline/production/#assets","text":"An Asset is produced independently from the shots and can be used in several shots. They are the characters, sets, props, and any other re-usable item in the production. The list of assets is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each asset is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Root \u2502 \u2514\u2500\u252c\u2500 04-ASSETS \u251c\u2500\u252c\u2500 Characters # An asset group \u2502 \u2502 \u2502 \u251c\u2500\u252c\u2500 PROJECTID_A_TRISTAN # An Asset \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_DESIGN # An asset production step \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_MOD \u2502 \u2502 \u251c\u2500\u2500\u2500 PROJECTID_A_TRISTAN_RIG \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_TRISTAN_TEX \u2502 \u2502 \u2502 \u2514\u2500\u2500\u2500 PROJECTID_A_ISOLDE # An Asset \u2502 \u251c\u2500\u2500\u2500 Props # A Group of Assets \u2502 \u2514\u2500\u2500\u2500 Sets # A Group of Assets Tip Without using the Ramses Client Application , you can create assets by creating their folder in the default location in the project subfolder of the Ramses Tree . Each asset is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. They\u2019re grouped in Asset Groups to make them easier to sort, and produced through Asset Production Steps . They also have tags to be able to search for specific assets. \u25b9 Asset management in the Ramses Client Application .","title":"Assets"},{"location":"pipeline/production/#shots","text":"A Shot is produced using assets and stored in a Sequence . The list of shots is available and can be managed in the Ramses Client Application , under the project panel (for project admin users) , and by default each shot is represented by a folder in the Ramses Tree as shown below. # (inside the \"Projects\" folder of the Ramses main folder) \u250c PROJECTID # Root \u2502 \u2514\u2500\u252c\u2500 05-SHOTS \u2502 \u251c\u2500\u252c\u2500 PROJECTID_S_01-001 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_ANIM # A shot production step \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-001_LIGHT \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_01-001_COMP \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-002 # A Shot \u2502 \u251c\u2500\u2500\u2500 PROJECTID_S_01-003 # A Shot \u2502 \u2514\u2500\u2500\u2500 PROJECTID_S_02-001 # A Shot Tip Without using the Ramses Client Application , you can create shots by creating their folder in the default location in the project subfolder of the Ramses Tree . Each shot is represented by its name and ID . The ID is used in file and folder names in the Ramses Tree , while the name is used in the user interface. Each shot contains a list of assets which are needed for its production. Shots have a duration , usually shown either in seconds or frames, and the addition of all their duration is the duration of the project. \u25b9 Shot management in the Ramses Client Application .","title":"Shots"},{"location":"pipeline/production/#production-status-of-assets-and-shots","text":"All assets and shots have a production status, which is summarized in an asset table and a shot table in the Ramses Client Application . This status consists of a state , a comment and a completion ratio . Ramses also associates the time spent for the production of the item and the estimation to the status (read the Planning section for more information about estimations). All this information is added and summarized at the step level to show the completion for each step, each asset and each shot. Ramses also keeps track of the whole production at the project level with general statistics. Note There\u2019s no way with Ramses to link the production tracking data to individual users (meaning that there\u2019s no easy way to build statistics about users or compare their productivity). That\u2019s by design, don\u2019t ask for it. Ramses is also able to extract a lateness value from all the available information, available at all levels (shots, assets, steps and whole project). All the history of successive states, comments, completion ratio, etc. is always available. The combination of an asset or a shot and a step can be assigned to a specific user . For use with pipeline automations , status are also associated with specific versions of the files, and store the publication status. When using Ramses Add-ons , the state of a specific version is kept in the file name of the corresponding version file, thanks to the Ramses naming scheme \u25b9 Production tracking in the Ramses Client Application .","title":"Production status of assets and shots"},{"location":"quickstart/","text":"Quick start guide Here\u2019s all you need to know before you start using Ramses . Follow these few steps and you\u2019ll be able to benefit from all it\u2019s features very quickly. Introduction Ramses can help you automate your workflow , plan and track your production. To benefit from all Ramses features, you just need to install the Ramses Application on your workstations. To help you manage your files and automate your workflow, you can also install optional Ramses Add-ons . They can be scripts, extensions, plugins, add-ons for your creative software and how you use them and their features can vary depending on the host software. To sync all the Ramses Data across workstations and between multiple users, you\u2019ll need to connect to an optional Ramses Server . You can either install your own or rent a server managed by RxLaboratory (or any other provider you trust). Note 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\u2019s 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. Tips Although Ramses is made to be as simple as possible to use, it\u2019s a production tool which both helps and needs you to be organized, and you\u2019ll have to familiarize yourself with its organization. Read this documentation before installing everything and clicking everywhere! The Principles section and the Ramses Tree section are especially important. In files and folders , it is important to respect the Ramses naming scheme ; take some time to familiarize yourself with it. On some systems ( Linux and sometimes Mac OS depending on its settings), the text case matters in file and folder names. Even on Windows , it is safer to assume that the name Tristan is different than tristan . Ramses is just a piece of software. It\u2019s dumb. The folder name _preview is not the same as preview . Be careful with naming conventions and folder structure . 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. You must have a Ramses main folder , which stores at least some configuration files. In default configurations, this folder actually stores everything you need : user files, project files, etc. In this case, it should contain at least two subfolders: Users and Projects . The Projects subfolder is the most important one: it is there you\u2019ll work and save all your data. You may store your project files in separate folders , either locally or in a shared location; in this case, for each project, you\u2019ll have to know where its folder is. It\u2019s in this specific location that you\u2019ll work and save your data instead of the Ramses main folder. \u25b9 More details about the Ramses Tree . 1.A - Project folders In short, a project folder should contain at least these subfolders. 00-ADMIN contains the administration files. Ramses doesn\u2019t handle these yet. 01-PRE-PROD contains pre-production step files (with a subfolder for each step). 02-PROD contains production step common files (libraries, templates, etc, with a subfolder for each step), but not the working files. 03-POST-PROD contains post-production step files (with a subfolder for each step. 04-ASSETS contains asset working files (with a subfolder for each group of assets). 05-SHOTS contains shot working files (with a subfolder for each shot). 06-EXPORTS contains media files for the whole project. 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. \u25b9 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\u2019re 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. \u25b9 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 \u2026), read the doc for more information.","title":"Quick start"},{"location":"quickstart/#quick-start-guide","text":"Here\u2019s all you need to know before you start using Ramses . Follow these few steps and you\u2019ll be able to benefit from all it\u2019s features very quickly.","title":"Quick start guide"},{"location":"quickstart/#introduction","text":"Ramses can help you automate your workflow , plan and track your production. To benefit from all Ramses features, you just need to install the Ramses Application on your workstations. To help you manage your files and automate your workflow, you can also install optional Ramses Add-ons . They can be scripts, extensions, plugins, add-ons for your creative software and how you use them and their features can vary depending on the host software. To sync all the Ramses Data across workstations and between multiple users, you\u2019ll need to connect to an optional Ramses Server . You can either install your own or rent a server managed by RxLaboratory (or any other provider you trust). Note 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\u2019s 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.","title":"Introduction"},{"location":"quickstart/#tips","text":"Although Ramses is made to be as simple as possible to use, it\u2019s a production tool which both helps and needs you to be organized, and you\u2019ll have to familiarize yourself with its organization. Read this documentation before installing everything and clicking everywhere! The Principles section and the Ramses Tree section are especially important. In files and folders , it is important to respect the Ramses naming scheme ; take some time to familiarize yourself with it. On some systems ( Linux and sometimes Mac OS depending on its settings), the text case matters in file and folder names. Even on Windows , it is safer to assume that the name Tristan is different than tristan . Ramses is just a piece of software. It\u2019s dumb. The folder name _preview is not the same as preview . Be careful with naming conventions and folder structure .","title":"Tips"},{"location":"quickstart/#1-check-the-ramses-folder-the-ramses-tree","text":"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. You must have a Ramses main folder , which stores at least some configuration files. In default configurations, this folder actually stores everything you need : user files, project files, etc. In this case, it should contain at least two subfolders: Users and Projects . The Projects subfolder is the most important one: it is there you\u2019ll work and save all your data. You may store your project files in separate folders , either locally or in a shared location; in this case, for each project, you\u2019ll have to know where its folder is. It\u2019s in this specific location that you\u2019ll work and save your data instead of the Ramses main folder. \u25b9 More details about the Ramses Tree .","title":"1 - Check the Ramses folder, the Ramses Tree"},{"location":"quickstart/#1a-project-folders","text":"In short, a project folder should contain at least these subfolders. 00-ADMIN contains the administration files. Ramses doesn\u2019t handle these yet. 01-PRE-PROD contains pre-production step files (with a subfolder for each step). 02-PROD contains production step common files (libraries, templates, etc, with a subfolder for each step), but not the working files. 03-POST-PROD contains post-production step files (with a subfolder for each step. 04-ASSETS contains asset working files (with a subfolder for each group of assets). 05-SHOTS contains shot working files (with a subfolder for each shot). 06-EXPORTS contains media files for the whole project. 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. \u25b9 More details about the file and folder structure .","title":"1.A - Project folders"},{"location":"quickstart/#2-the-ramses-application","text":"The Ramses Client Application is the main User Interface of Ramses .","title":"2 - The Ramses Application"},{"location":"quickstart/#2a-installation","text":"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.","title":"2.A - Installation"},{"location":"quickstart/#2b-settings","text":"","title":"2.B - Settings"},{"location":"quickstart/#2c-create-a-database","text":"","title":"2.C - Create a database"},{"location":"quickstart/#2d-project-settings","text":"If you\u2019re 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. \u25b9 Project settings are detailed here .","title":"2.D - Project settings"},{"location":"quickstart/#3-install-the-ramses-add-ons","text":"Finally, you can install the Ramses Add-ons you need. Installation differs depending on the host application ( Maya , Blender , After Effects \u2026), read the doc for more information.","title":"3 - Install the Ramses Add-Ons"}]}
\ No newline at end of file
diff --git a/docs/search/worker.js b/docs/search/worker.js
index 9cce2f79..8628dbce 100644
--- a/docs/search/worker.js
+++ b/docs/search/worker.js
@@ -44,6 +44,9 @@ function onJSONLoaded () {
     if (lang.length > 1) {
       scriptsToLoad.push('lunr.multi.js');
     }
+    if (lang.includes("ja") || lang.includes("jp")) {
+      scriptsToLoad.push('tinyseg.js');
+    }
     for (var i=0; i < lang.length; i++) {
       if (lang[i] != 'en') {
         scriptsToLoad.push(['lunr', lang[i], 'js'].join('.'));
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
index 5d172ae5..b67b3e23 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -1,383 +1,478 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
-     <loc>https://ramses.rxlab.guide/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/quickstart/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/pipeline/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/pipeline/administration/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/pipeline/pipeline/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/pipeline/production/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/pipeline/planning/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/install/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/settings/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/admin/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/users/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/projects/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/templatesteps/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/templateassetgroups/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/states/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/filetypes/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/applications/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/project/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/steps/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/pipetypes/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/assetgroups/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/assets/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/sequences/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/shots/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/pipeline/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/production/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/client/schedule/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/addons/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/addons/maya/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/addons/maya-pipeline/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/addons/maya-scenesetup/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/addons/maya-publish/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/addons/maya-import/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/addons/maya-extend/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/files/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/files/naming/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/files/tree/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/server/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/server/install/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/server/install-src/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/server/install-docker-mysql/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/server/install-docker-sqlite/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/server/config/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/server/update/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/components/server/admin/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/objects/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/files/naming/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/enum/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ramses/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_asset/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_assetgroup/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_daemon_interface/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_file_info/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_file_manager/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_filetype/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_item/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_metadata_manager/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_object/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_pipe/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_pipefile/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_project/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_sequence/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_settings/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_shot/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_state/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_status/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_step/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_user/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/add-ons-reference/implementation/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/ping/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/raise/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/create/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/getRamsesFolder/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/getObjects/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/getPath/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/getProjects/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/getCurrentProject/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/setCurrentProject/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/getData/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/setData/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/daemon-reference/uuidFromPath/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/dev/server-reference/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/credits/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/changelog/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/changelog-app/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/changelog-maya/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/changelog-server/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/changelog-api/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/licenses/gnu-gpl/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
-    </url><url>
-     <loc>https://ramses.rxlab.guide/licenses/gfdl/</loc>
-     <lastmod>2022-11-02</lastmod>
-     <changefreq>daily</changefreq>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+    <url>
+         <loc>https://ramses.rxlab.guide/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/changelog-api/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/changelog-app/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/changelog-maya/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/changelog-server/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/changelog/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/credits/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/addons/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/addons/maya-extend/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/addons/maya-import/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/addons/maya-pipeline/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/addons/maya-publish/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/addons/maya-scenesetup/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/addons/maya/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/admin/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/applications/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/assetgroups/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/assets/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/filetypes/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/install/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/pipeline/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/pipetypes/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/production/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/project/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/projects/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/schedule/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/sequences/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/settings/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/shots/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/states/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/steps/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/templateassetgroups/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/templatesteps/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/client/users/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/files/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/files/naming/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/files/tree/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/server/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/server/admin/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/server/config/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/server/install-docker-mysql/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/server/install-docker-sqlite/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/server/install-src/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/server/install/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/server/update/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/objects/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/enum/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/implementation/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_asset/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_assetgroup/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_daemon_interface/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_file_info/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_file_manager/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_filetype/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_item/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_metadata_manager/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_object/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_pipe/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_pipefile/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_project/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_sequence/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_settings/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_shot/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_state/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_status/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_step/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_user/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ramses/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/create/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/getCurrentProject/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/getData/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/getObjects/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/getPath/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/getProjects/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/getRamsesFolder/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/ping/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/raise/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/setCurrentProject/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/setData/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/daemon-reference/uuidFromPath/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/files/naming/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/dev/server-reference/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/licenses/gfdl/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/licenses/gnu-gpl/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/pipeline/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/pipeline/administration/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/pipeline/pipeline/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/pipeline/planning/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/pipeline/production/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/quickstart/</loc>
+         <lastmod>2022-11-20</lastmod>
+         <changefreq>daily</changefreq>
     </url>
 </urlset>
\ No newline at end of file
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
index 2864bac5e5b27e133837b6bc8aafd51a44bcdc57..b553bea841db4116b71cd543938014ffc3038056 100644
GIT binary patch
literal 796
zcmV+%1LOQ3iwFo&LV9BY|8r?{Wo=<_E_iKh0M*;eZW=KZ2H<_30<j+kShW=)i&oh-
zs@iqr*k=YezTry}-o7@F6bTZko9g^*W*98%)9BbfzOcG^v1al_F=_9vr;FKqIw2>$
z(r&z-{`z^_eVX2^uT~|RM0rvRyL3I><Q%^A{qytlEa^;Egf#PU?33KoFR4F1?B}!3
z)AiM)ep&^GyZvWnyj-_hQmrNmn<&lVixCgAv1mp8s&55O%Zrq)SL@|`x$G8;ZaJ?-
zj?Yet$&GL$4Ux8MCA8VC`jaOINdG4JN7JDu<Ht?}&0ZLo3$54*=EOv?HVocKp1Md%
z=fu<IZSam9f1XgvI}~MW&K<pEatcYT>(iK##6br#+7XnwJQ$reNaQ5RQO$Tt08(?O
zN~7x)L@AWj4#gUR(Nbg$FkrlrQ*B*i^d&%vQLuwHly`wpyxOHKi~-T248kW|q+kfq
zt0G%(h6DahGGl2`qM<D+sbWwXTcT|tCt(^}9n`XRBMf)raUwU1j1vc$U{bM6HkkTu
z@sh|_InvuMi6VPzOL#$$PSly@h+)l<*bls%*Xhrc5X%ZjtMqQrBMA05gY1--j}$w*
zOIw3UuW+3S%$}me5`$<<P=aYND0*V+@(+BcxXmY&>by%`q=90aE&@r(6$`}GHRC2*
z+mv9tqI4Nv3*PT%IEd!`tPBjU1X=IywaXL-0o5iOzh&$dKX^p96;6yyv-pqcZDk#d
z-Hzvhku7CWGa&&QD2IFm4BhsP0LiUUqOlooAib}C-Rgj2Gv4v|fW7f>0g^e-UEens
zxY)>qmTb3O1uSwRzF~2gx&SOEoIzzI&Yi@WcclEa#Co6am=D^Q=-+Az4F&$rd?D|W
z`A*~w7MSyip!d)}_C;^KQH%$YGkD;-^?Okpg-$?ybHeSL6I$O~>QA@PTh^T&`vVsZ
zdD!V=p1T<>$+Zl49F$=$bfp^uPbBM;<8QeAAr+l+<hy0|X2p1;!3gKLc0zxZybs=Q
ai<XZmi~sSD&Hbeg%IiPKRCgsJK>z@ru81)J

literal 800
zcmV+*1K<1~iwFqwEMj8<|8r?{Wo=<_E_iKh0M*(}ZyGTW2H<;s1>(LeaB3^EIke*1
zs%p=Xv1fPP_zQm|;oo<>K$R*aQV*40av@m^d1UX5$6jylo~@ZZQcT*r+xcp-oX^Nf
zue2L(=RbdJn-BB5?q*Y>Nt9>Y*rnU~m~;5lwogw_i=;DI5z@lPp-pn+KT><T*e(|z
z=Ux45cQdO$8{=hHKb-i}QP@Oj5uc6NEry~MwVSp!IJXrkTd%tHa=mU=t7f_8w@=qj
zP2?!tKz*crr-U|#P5a`?)MnGx|NakzebMqEWf3!iCg?y$JA$$ZWwp~ON0Irafuce7
zSBPE}iPu*~ILBd*fRf$@@5to@rjbVTD<(=i&Qr!<;&`^md~<=0=aj-QX(jPwj7j4}
z_KPHHjB?4rDJ@gV6u^lhad-^T7gQ)G7Vbz)Tdxh}LqO$;5R8^nX@nidsCOQ0^w!D=
z`Nl&}DiaVj;nBYEx)*h9)95pBRG=)mF6KI*wbzA#l_RNQ(0WfOg*SbjP*xlSuB-u#
zhnK`8$r0z`5|I0`?2Jw$uu${Wn1O-xoXIILU@hMhq{#`3w;gt*<w$4=B~g5&h>617
z8T%X8q$sh0%F73ejXk8jxe6&ebq0+S>0Pe}Oj`*`p!OTgPOYLx6o%iyY{OO#+U!|P
zTn05<2Q`s;igjU+3nN!7uI|_n+IK%~EL{O{+ML67DnZt}d+jpCULc1})z-|z*4|$M
z(+VdBjDq=nY2D(+R@T!+*g{KLa7`tyW7LoJ1h%nmtKkc4{D3QQ9{#<JJU@*=SK=IT
zc}F>V^wG{BtIzj|1%041fftwcXcMkb+hE9&%P_}UtMgcp<E>*~xdPDY{}nC@op8HO
zMgq!!uXqFH?^DyQHwq_$FFC(r?TlR_eiM0w_5mI8e9QQ`ME?Cug_WkOk#e7Y;pHlF
zPeS_&zqO6tA_e#H0SZ>-z%!lFASc<TFED<9!ZacTED+3bt3M*3lLs$`O(TGemgMU5
en!%N32nNg4tN#bOnO=CF=zar%5R3TJIsgEMevBIc

diff --git a/src-docs/docs/changelog-api.md b/src-docs/docs/changelog-api.md
index ea978960..5da91a9c 100644
--- a/src-docs/docs/changelog-api.md
+++ b/src-docs/docs/changelog-api.md
@@ -1,7 +1,13 @@
-![META](authors:Nicolas "Duduf" Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/01)
+![META](authors:Nicolas "Duduf" Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/20)
 
 # Ramses API Changelog
 
+## 0.7.0-Beta
+
+### New
+
+- 0.7.0 compatibility update.
+
 ## 0.6.0-Beta
 
 ### New
diff --git a/src-docs/docs/changelog-app.md b/src-docs/docs/changelog-app.md
index dabea183..ea49409a 100644
--- a/src-docs/docs/changelog-app.md
+++ b/src-docs/docs/changelog-app.md
@@ -1,13 +1,23 @@
-![META](authors:Nicolas "Duduf" Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/01)
+![META](authors:Nicolas "Duduf" Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/20)
 
 # Ramses Application Changelog
 
-## Known Issues
+## 0.7.0-Beta
 
-- ***[#263](https://github.com/RxLaboratory/Ramses/issues/263)***: The client may crash when removing a project which is not empty.
-- On ***Windows***, the tray icon may not be removed if the client crashes.
-- On ***Mac OS***, the user specific settings (current project, location of the nodes in the pipeline editor, ...) may not be saved.
-- On ***Linux***, interaction with the timeline may be limited (impossible to select a shot, or open its folder).
+### New
+
+- New syncing methods with the *Ramses Server* which are slower but more reliable, especially with big sets of data.
+
+### Improvements
+
+- Performance improvements, especially with big sets of data
+
+### Fixes
+
+- Fixed potential crash when loading some items from the *Ramses Scripting API*.
+- Fixed potential crash when adding entries to the schedule.
+- Fixed potential crash when loading specific databases.
+- Fixed schedule entries which may not be correctly shown. No data was lost, it was just a display issue.
 
 ## 0.6.0-Beta
 
diff --git a/src-docs/docs/changelog-maya.md b/src-docs/docs/changelog-maya.md
index e01f799e..75ce7f74 100644
--- a/src-docs/docs/changelog-maya.md
+++ b/src-docs/docs/changelog-maya.md
@@ -1,7 +1,13 @@
-![META](authors:Nicolas "Duduf" Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/01)
+![META](authors:Nicolas "Duduf" Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/20)
 
 # Ramses Laya Add-on Changelog
 
+## 0.7.0-Beta
+
+### Fixes
+
+- Fixed 'save scene as' failing with random items.
+
 ## 0.6.0-Beta
 
 ### Fixes
diff --git a/src-docs/docs/changelog-server.md b/src-docs/docs/changelog-server.md
index 6cb152c7..e38445b4 100644
--- a/src-docs/docs/changelog-server.md
+++ b/src-docs/docs/changelog-server.md
@@ -1,7 +1,22 @@
-![META](authors:Nicolas "Duduf" Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/01)
+![META](authors:Nicolas "Duduf" Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/11/20)
 
 # Ramses Server Changelog
 
+## 0.7.0-Beta
+
+Starting with this version, the *Ramses Server* is compatible only with versions of MySQL more recent than 8.0, though it can still use SQLite too.
+
+### New
+
+- New syncing methods which are slower but more reliable, especially with big sets of data.
+- Improved performance with big sets of data.
+- When using SQLite, 'VACUUM' is run at regular intervals to optimize the size of the file and fix potential issues with failed queries.
+- Refuse client connexions if they're using the wrong version.
+
+### Fixes
+
+- Accepts requests with missing 'Content-Type' header. Assumes it's *JSON* by default.
+
 ## 0.6.0-Beta
 
 ### New
diff --git a/src-docs/mkdocs.yml b/src-docs/mkdocs.yml
index ff68216f..f3c2f49d 100644
--- a/src-docs/mkdocs.yml
+++ b/src-docs/mkdocs.yml
@@ -29,7 +29,7 @@ extra_javascript:
 site_dir: ../docs/
 dev_addr: '127.0.0.1:8001'
 nav:
-    - v0.6 (Beta): index.md
+    - v0.7 (Beta): index.md
     - Quick start: quickstart/index.md
     - Principles:
         - Introduction: pipeline/index.md