From 042df20e04a39516a77c44de752f4bb5d02c21ab Mon Sep 17 00:00:00 2001
From: Duduf <git@duduf.com>
Date: Thu, 14 Dec 2023 14:57:35 +0100
Subject: [PATCH 1/3] Update Maya doc

---
 docs/changelog/index.html                     |   10 +
 docs/components/addons/index.html             |   10 +
 docs/components/addons/maya-extend/index.html |   10 +
 docs/components/addons/maya-import/index.html |   10 +
 .../addons/maya-pipeline/index.html           |   10 +
 .../components/addons/maya-publish/index.html |   12 +
 .../addons/maya-scenesetup/index.html         |   10 +
 docs/components/addons/maya/index.html        |   22 +-
 docs/components/client/admin/index.html       |   10 +
 .../components/client/applications/index.html |   10 +
 docs/components/client/assetgroups/index.html |   10 +
 docs/components/client/assets/index.html      |   10 +
 docs/components/client/filetypes/index.html   |   10 +
 docs/components/client/index.html             |   10 +
 docs/components/client/install/index.html     |   10 +
 docs/components/client/pipeline/index.html    |   10 +
 docs/components/client/pipetypes/index.html   |   10 +
 docs/components/client/production/index.html  |   10 +
 docs/components/client/project/index.html     |   10 +
 docs/components/client/projects/index.html    |   10 +
 docs/components/client/schedule/index.html    |   10 +
 docs/components/client/sequences/index.html   |   10 +
 docs/components/client/settings/index.html    |   10 +
 docs/components/client/shots/index.html       |   10 +
 docs/components/client/states/index.html      |   10 +
 docs/components/client/steps/index.html       |   10 +
 .../client/templateassetgroups/index.html     |   10 +
 .../client/templatesteps/index.html           |   10 +
 docs/components/client/users/index.html       |   10 +
 docs/components/files/index.html              |   10 +
 docs/components/files/naming/index.html       |   10 +
 docs/components/files/tree/index.html         |   10 +
 docs/components/index.html                    |   10 +
 docs/components/server/admin/index.html       |   10 +
 docs/components/server/config/index.html      |   14 +-
 docs/components/server/index.html             |   10 +
 .../server/install-docker-mysql/index.html    |   10 +
 .../server/install-docker-sqlite/index.html   |   14 +-
 docs/components/server/install-src/index.html |   10 +
 .../server/install-synology/index.html        | 1531 +++++++++++++++++
 docs/components/server/install/index.html     |   11 +
 docs/components/server/update/index.html      |   10 +
 docs/credits/index.html                       |   10 +
 docs/dev/add-ons-reference/enum/index.html    |   10 +
 .../implementation/index.html                 |   10 +
 docs/dev/add-ons-reference/index.html         |   10 +
 .../add-ons-reference/ram_asset/index.html    |   10 +
 .../ram_assetgroup/index.html                 |   10 +
 .../ram_daemon_interface/index.html           |   10 +
 .../ram_file_info/index.html                  |   10 +
 .../ram_file_manager/index.html               |   10 +
 .../add-ons-reference/ram_filetype/index.html |   10 +
 .../dev/add-ons-reference/ram_item/index.html |   10 +
 .../ram_metadata_manager/index.html           |   10 +
 .../add-ons-reference/ram_object/index.html   |   10 +
 .../dev/add-ons-reference/ram_pipe/index.html |   10 +
 .../add-ons-reference/ram_pipefile/index.html |   10 +
 .../add-ons-reference/ram_project/index.html  |   10 +
 .../add-ons-reference/ram_sequence/index.html |   10 +
 .../add-ons-reference/ram_settings/index.html |   10 +
 .../dev/add-ons-reference/ram_shot/index.html |   10 +
 .../add-ons-reference/ram_state/index.html    |   10 +
 .../add-ons-reference/ram_status/index.html   |   10 +
 .../dev/add-ons-reference/ram_step/index.html |   10 +
 .../dev/add-ons-reference/ram_user/index.html |   10 +
 docs/dev/add-ons-reference/ramses/index.html  |   10 +
 docs/dev/daemon-reference/create/index.html   |   10 +
 .../getAssetGroups/index.html                 |   10 +
 .../dev/daemon-reference/getAssets/index.html |   10 +
 .../getCurrentProject/index.html              |   10 +
 docs/dev/daemon-reference/getData/index.html  |   10 +
 .../daemon-reference/getObjects/index.html    |   10 +
 docs/dev/daemon-reference/getPath/index.html  |   10 +
 docs/dev/daemon-reference/getPipes/index.html |   10 +
 .../daemon-reference/getProjects/index.html   |   10 +
 .../getRamsesFolder/index.html                |   10 +
 .../daemon-reference/getSequences/index.html  |   10 +
 docs/dev/daemon-reference/getShots/index.html |   10 +
 .../dev/daemon-reference/getStatus/index.html |   10 +
 docs/dev/daemon-reference/getSteps/index.html |   10 +
 docs/dev/daemon-reference/index.html          |   10 +
 docs/dev/daemon-reference/ping/index.html     |   10 +
 docs/dev/daemon-reference/raise/index.html    |   10 +
 .../setCurrentProject/index.html              |   10 +
 docs/dev/daemon-reference/setData/index.html  |   10 +
 .../daemon-reference/uuidFromPath/index.html  |   10 +
 docs/dev/files/naming/index.html              |   10 +
 docs/dev/index.html                           |   10 +
 docs/dev/objects/index.html                   |   10 +
 docs/dev/server-reference/index.html          |   10 +
 docs/img/maya/publishsettings_alembic.png     |  Bin 34379 -> 42747 bytes
 docs/img/server/syno_packages.png             |  Bin 0 -> 175246 bytes
 docs/index.html                               |   12 +-
 docs/licenses/gfdl/index.html                 |   10 +
 docs/licenses/gnu-gpl/index.html              |   10 +
 docs/pipeline/administration/index.html       |   10 +
 docs/pipeline/index.html                      |   10 +
 docs/pipeline/pipeline/index.html             |   10 +
 docs/pipeline/planning/index.html             |   10 +
 docs/pipeline/production/index.html           |   10 +
 docs/quickstart/index.html                    |   10 +
 docs/search/search_index.json                 |    2 +-
 docs/sitemap.xml                              |  201 +--
 docs/sitemap.xml.gz                           |  Bin 820 -> 826 bytes
 .../docs/components/addons/maya-publish.md    |    2 +
 src-docs/docs/components/addons/maya.md       |   11 +-
 .../docs/img/maya/publishsettings_alembic.png |  Bin 34379 -> 42747 bytes
 107 files changed, 2646 insertions(+), 106 deletions(-)
 create mode 100644 docs/components/server/install-synology/index.html
 create mode 100644 docs/img/server/syno_packages.png

diff --git a/docs/changelog/index.html b/docs/changelog/index.html
index 2fef8143..ab82fd09 100644
--- a/docs/changelog/index.html
+++ b/docs/changelog/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/addons/index.html b/docs/components/addons/index.html
index d5515ede..6f686947 100644
--- a/docs/components/addons/index.html
+++ b/docs/components/addons/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/addons/maya-extend/index.html b/docs/components/addons/maya-extend/index.html
index ce351161..763a7935 100644
--- a/docs/components/addons/maya-extend/index.html
+++ b/docs/components/addons/maya-extend/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/addons/maya-import/index.html b/docs/components/addons/maya-import/index.html
index f252e9ee..88cc5e95 100644
--- a/docs/components/addons/maya-import/index.html
+++ b/docs/components/addons/maya-import/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/addons/maya-pipeline/index.html b/docs/components/addons/maya-pipeline/index.html
index b98c751a..5ffc7e2a 100644
--- a/docs/components/addons/maya-pipeline/index.html
+++ b/docs/components/addons/maya-pipeline/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/addons/maya-publish/index.html b/docs/components/addons/maya-publish/index.html
index 965109f0..847855a2 100644
--- a/docs/components/addons/maya-publish/index.html
+++ b/docs/components/addons/maya-publish/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
@@ -1455,6 +1465,8 @@ <h2 id="alembic">Alembic</h2>
 <li>Use the <strong>handles</strong> control to add some time before and after the scene&rsquo;s time range.</li>
 <li>You can change the <strong>frame step</strong> to make the exported file lighter or more detailed (e.g. for precise motion blur).</li>
 <li>You can automatically <strong>filter Euler rotations</strong>.</li>
+<li>You can automatically add all custom attributes.</li>
+<li>You can set a list of attributes to include, using their exact names, or a prefix.</li>
 </ul>
 <h2 id="arnold-scene-source">Arnold Scene Source</h2>
 <p>There are no options for this format.</p>
diff --git a/docs/components/addons/maya-scenesetup/index.html b/docs/components/addons/maya-scenesetup/index.html
index 72b05c7c..efeafafc 100644
--- a/docs/components/addons/maya-scenesetup/index.html
+++ b/docs/components/addons/maya-scenesetup/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/addons/maya/index.html b/docs/components/addons/maya/index.html
index f021306a..51556aee 100644
--- a/docs/components/addons/maya/index.html
+++ b/docs/components/addons/maya/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
@@ -1787,12 +1797,22 @@ <h2 id="update"><img alt="" src="../../../img/icons/ramupdate.png" style="width:
 <p>Use the Update command to update (or downgrade) the assets included in the scene.</p>
 <p><img alt="" src="/img/maya/update.png" /></p>
 <p>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.</p>
-<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramUpdate</code>.</p>
+<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramUpdate</code>. It can take two parameters:</p>
+<ul>
+<li><code>updateAll</code> or <code>-a</code>: boolean. When <code>True</code>, the dialog isn&rsquo;t shown, and all items are automatically updated.</li>
+<li><code>updateSelection</code> or <code>-s</code>: boolean. When <code>True</code>, the dialog isn&rsquo;t shown, and the selected items are automatically updated.</li>
+</ul>
 <pre><code class="language-py"># Python
 import maya.cmds as cmds
 
 # Shows the update dialog
 cmds.ramUpdate()
+
+# Updates all the items in the current scene
+cmds.ramUpdate( a=True )
+
+# Updates the selected items in the current scene
+cmds.ramUpdate( s=True )
 </code></pre>
 <h2 id="retrieve-version"><img alt="" src="../../../img/icons/restoreversion.svg" style="width:32px" /> Retrieve Version</h2>
 <p>The <em>Retrieve version</em> command can be used to check and restore a previous version of the current scene.</p>
diff --git a/docs/components/client/admin/index.html b/docs/components/client/admin/index.html
index 08cfd566..58e82ddb 100644
--- a/docs/components/client/admin/index.html
+++ b/docs/components/client/admin/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/applications/index.html b/docs/components/client/applications/index.html
index c0f89a5a..7ba3edf6 100644
--- a/docs/components/client/applications/index.html
+++ b/docs/components/client/applications/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/assetgroups/index.html b/docs/components/client/assetgroups/index.html
index 542230de..195e8f4c 100644
--- a/docs/components/client/assetgroups/index.html
+++ b/docs/components/client/assetgroups/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/assets/index.html b/docs/components/client/assets/index.html
index 0de59ae9..b0f23e9b 100644
--- a/docs/components/client/assets/index.html
+++ b/docs/components/client/assets/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/filetypes/index.html b/docs/components/client/filetypes/index.html
index d0a9c5eb..9563a7c6 100644
--- a/docs/components/client/filetypes/index.html
+++ b/docs/components/client/filetypes/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/index.html b/docs/components/client/index.html
index 0a94aa4c..e9848c3c 100644
--- a/docs/components/client/index.html
+++ b/docs/components/client/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/install/index.html b/docs/components/client/install/index.html
index 796d96f5..6a065836 100644
--- a/docs/components/client/install/index.html
+++ b/docs/components/client/install/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/pipeline/index.html b/docs/components/client/pipeline/index.html
index a9f0ba38..66b07c75 100644
--- a/docs/components/client/pipeline/index.html
+++ b/docs/components/client/pipeline/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/pipetypes/index.html b/docs/components/client/pipetypes/index.html
index 579cca3d..11d1dee2 100644
--- a/docs/components/client/pipetypes/index.html
+++ b/docs/components/client/pipetypes/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/production/index.html b/docs/components/client/production/index.html
index 8fad7f3f..cc66083a 100644
--- a/docs/components/client/production/index.html
+++ b/docs/components/client/production/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/project/index.html b/docs/components/client/project/index.html
index 184d15d6..b4d5597c 100644
--- a/docs/components/client/project/index.html
+++ b/docs/components/client/project/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/projects/index.html b/docs/components/client/projects/index.html
index 1c6aae92..2401de74 100644
--- a/docs/components/client/projects/index.html
+++ b/docs/components/client/projects/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/schedule/index.html b/docs/components/client/schedule/index.html
index 92b2bf4e..ae6059e6 100644
--- a/docs/components/client/schedule/index.html
+++ b/docs/components/client/schedule/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/sequences/index.html b/docs/components/client/sequences/index.html
index 0c927040..de0450a5 100644
--- a/docs/components/client/sequences/index.html
+++ b/docs/components/client/sequences/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/settings/index.html b/docs/components/client/settings/index.html
index b9323e7c..0ef84159 100644
--- a/docs/components/client/settings/index.html
+++ b/docs/components/client/settings/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/shots/index.html b/docs/components/client/shots/index.html
index 938cddd6..156a3844 100644
--- a/docs/components/client/shots/index.html
+++ b/docs/components/client/shots/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/states/index.html b/docs/components/client/states/index.html
index b37ba18c..6fa678bd 100644
--- a/docs/components/client/states/index.html
+++ b/docs/components/client/states/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/steps/index.html b/docs/components/client/steps/index.html
index 9c5afacc..6acfefa6 100644
--- a/docs/components/client/steps/index.html
+++ b/docs/components/client/steps/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/templateassetgroups/index.html b/docs/components/client/templateassetgroups/index.html
index 107858ee..53ef7db2 100644
--- a/docs/components/client/templateassetgroups/index.html
+++ b/docs/components/client/templateassetgroups/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/templatesteps/index.html b/docs/components/client/templatesteps/index.html
index f0519bb9..1111019c 100644
--- a/docs/components/client/templatesteps/index.html
+++ b/docs/components/client/templatesteps/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/client/users/index.html b/docs/components/client/users/index.html
index d6067b7a..0a872aca 100644
--- a/docs/components/client/users/index.html
+++ b/docs/components/client/users/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/files/index.html b/docs/components/files/index.html
index f556f5e2..068641d8 100644
--- a/docs/components/files/index.html
+++ b/docs/components/files/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/files/naming/index.html b/docs/components/files/naming/index.html
index 38dc26e7..7d6db1a6 100644
--- a/docs/components/files/naming/index.html
+++ b/docs/components/files/naming/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/files/tree/index.html b/docs/components/files/tree/index.html
index 683a966d..96ec2d60 100644
--- a/docs/components/files/tree/index.html
+++ b/docs/components/files/tree/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/index.html b/docs/components/index.html
index fcea89bd..ac9bebc4 100644
--- a/docs/components/index.html
+++ b/docs/components/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/server/admin/index.html b/docs/components/server/admin/index.html
index 735fc77e..c06a6d45 100644
--- a/docs/components/server/admin/index.html
+++ b/docs/components/server/admin/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/server/config/index.html b/docs/components/server/config/index.html
index 2b1766ce..a5ef2f01 100644
--- a/docs/components/server/config/index.html
+++ b/docs/components/server/config/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li class="active">
     <a href="./">Configuration</a>
 </li>
@@ -835,7 +841,7 @@
                         </a>
                     </li>
                     <li >
-                        <a rel="prev" href="../install-docker-sqlite/">
+                        <a rel="prev" href="../install-synology/">
                             <i class="fas fa-arrow-left"></i> Previous
                         </a>
                     </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level active"><a href="./">Configuration</a></li>
                                     
                                 
@@ -1562,7 +1572,7 @@ <h2 id="config_logsphp">config_logs.php</h2>
             <div class="nav-footer">
             <ul>
                 <li class="nav-footer-prev">
-                    <a rel="prev" href="../install-docker-sqlite/">
+                    <a rel="prev" href="../install-synology/">
                         <i class="fas fa-arrow-left"></i> Previous
                     </a>
                 </li>
diff --git a/docs/components/server/index.html b/docs/components/server/index.html
index 8d2696c2..14eee89b 100644
--- a/docs/components/server/index.html
+++ b/docs/components/server/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/server/install-docker-mysql/index.html b/docs/components/server/install-docker-mysql/index.html
index cdd83927..fe6d89c1 100644
--- a/docs/components/server/install-docker-mysql/index.html
+++ b/docs/components/server/install-docker-mysql/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/server/install-docker-sqlite/index.html b/docs/components/server/install-docker-sqlite/index.html
index 9c27d5e2..ff107a3d 100644
--- a/docs/components/server/install-docker-sqlite/index.html
+++ b/docs/components/server/install-docker-sqlite/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../config/">Configuration</a>
 </li>
@@ -840,7 +846,7 @@
                         </a>
                     </li>
                     <li >
-                        <a rel="next" href="../config/">
+                        <a rel="next" href="../install-synology/">
                             Next <i class="fas fa-arrow-right"></i>
                         </a>
                     </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../config/">Configuration</a></li>
                                     
                                 
@@ -1423,7 +1433,7 @@ <h3 id="secured-connection-ssl">Secured connection (SSL)</h3>
                     </a>
                 </li>
                 <li class="nav-footer-next">
-                    <a rel="next" href="../config/">
+                    <a rel="next" href="../install-synology/">
                         Next <i class="fas fa-arrow-right"></i>
                     </a>
                 </li>
diff --git a/docs/components/server/install-src/index.html b/docs/components/server/install-src/index.html
index d2836d27..813ddf26 100644
--- a/docs/components/server/install-src/index.html
+++ b/docs/components/server/install-src/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/components/server/install-synology/index.html b/docs/components/server/install-synology/index.html
new file mode 100644
index 00000000..82b5756c
--- /dev/null
+++ b/docs/components/server/install-synology/index.html
@@ -0,0 +1,1531 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="The Ramses comprehensive documentation">
+    <meta name="author" content="Nicolas Dufresne and contributors">
+    <link rel="canonical" href="https://ramses.rxlab.guide/components/server/install-synology/">
+    <link rel="shortcut icon" href="../../../img/favicon.ico">
+
+    
+    <title>Synology NAS - Ramses</title>
+    
+
+    <link rel="stylesheet" href="../../../css/fontawesome.css">
+    <link rel="stylesheet" href="../../../css/fontawesome-v4-shims.css">
+    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css">
+    <link href='//rsms.me/inter/inter.css' rel='stylesheet' type='text/css'>
+    <link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,600,700&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
+    <link href="../../../css/bootstrap-custom.min.css" rel="stylesheet">
+    <link href="../../../css/base.min.css" rel="stylesheet">
+    <link href="../../../css/cinder.min.css" rel="stylesheet">
+
+    
+        
+        <link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/styles/zenburn.min.css">
+        
+    
+    <link href="../../../style.css" rel="stylesheet">
+    <link href="../../../video.css" rel="stylesheet">
+
+    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+    <!--[if lt IE 9]>
+            <script src="https://cdn.jsdelivr.net/npm/html5shiv@3.7.3/dist/html5shiv.min.js"></script>
+            <script src="https://cdn.jsdelivr.net/npm/respond.js@1.4.2/dest/respond.min.js"></script>
+        <![endif]-->
+
+    
+
+     
+</head>
+
+<body>
+
+    <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+    <div class="container">
+
+        <!-- Collapsed navigation -->
+        <div class="navbar-header">
+            <!-- Expander button -->
+            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+                <span class="sr-only">Toggle navigation</span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+                <span class="icon-bar"></span>
+            </button>
+            
+
+            <!-- Main title -->
+
+            
+              <a class="navbar-brand" href="../../..">Ramses</a>
+            
+        </div>
+
+        <!-- Expanded navigation -->
+        <div class="navbar-collapse collapse">
+                <!-- Main navigation -->
+                <ul class="nav navbar-nav">
+                
+                
+                    <li >
+                        <a href="../../..">v0.8 (Beta)</a>
+                    </li>
+                
+                
+                
+                    <li >
+                        <a href="../../../quickstart/">Quick start</a>
+                    </li>
+                
+                
+                
+                    <li class="dropdown">
+                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Principles <b class="caret"></b></a>
+                        <ul class="dropdown-menu">
+                        
+                            
+<li >
+    <a href="../../../pipeline/">Introduction</a>
+</li>
+
+                        
+                            
+<li >
+    <a href="../../../pipeline/administration/">Administration</a>
+</li>
+
+                        
+                            
+<li >
+    <a href="../../../pipeline/pipeline/">Pipeline</a>
+</li>
+
+                        
+                            
+<li >
+    <a href="../../../pipeline/production/">Production tracking</a>
+</li>
+
+                        
+                            
+<li >
+    <a href="../../../pipeline/planning/">Planning</a>
+</li>
+
+                        
+                        </ul>
+                    </li>
+                
+                
+                
+                    <li class="dropdown active">
+                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+                        <ul class="dropdown-menu">
+                        
+                            
+<li >
+    <a href="../../">Introduction</a>
+</li>
+
+                        
+                            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Ramses Application</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../client/">Introduction</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/install/">Installation</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/settings/">Overview and settings</a>
+</li>
+
+        
+            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Administration</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../client/admin/">Introduction</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/users/">Users</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/projects/">Projects</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/templatesteps/">Template Steps</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/templateassetgroups/">Template Asset Groups</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/states/">States</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/filetypes/">File Types</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/applications/">Applications</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+        
+            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Project settings</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../client/project/">Introduction</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/steps/">Steps</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/pipetypes/">Pipe Types</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/assetgroups/">Asset Groups</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/assets/">Assets</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/sequences/">Sequences</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/shots/">Shots</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+        
+            
+<li >
+    <a href="../../client/pipeline/">Pipeline editor</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/production/">Asset and shot production tracking</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../client/schedule/">Schedule and planning</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+                        
+                            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Ramses Add-ons</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../addons/">General Information</a>
+</li>
+
+        
+            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Autodesk Maya</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../addons/maya/">Maya Add-on</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../addons/maya-pipeline/">Maya pipeline</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../addons/maya-scenesetup/">Scene setup</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../addons/maya-publish/">Publish settings</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../addons/maya-import/">Import settings</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../addons/maya-extend/">Extensibility</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+        
+    </ul>
+  </li>
+
+                        
+                            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Ramses Tree</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../files/">Introduction</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../files/naming/">Naming scheme</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../files/tree/">Folder structure</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+                        
+                            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Ramses Server</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../">Introduction</a>
+</li>
+
+        
+            
+<li >
+    <a href="../install/">Installation</a>
+</li>
+
+        
+            
+<li >
+    <a href="../install-src/">Install from source</a>
+</li>
+
+        
+            
+<li >
+    <a href="../install-docker-mysql/">Docker (MySQL)</a>
+</li>
+
+        
+            
+<li >
+    <a href="../install-docker-sqlite/">Docker (SQLite)</a>
+</li>
+
+        
+            
+<li class="active">
+    <a href="./">Synology NAS</a>
+</li>
+
+        
+            
+<li >
+    <a href="../config/">Configuration</a>
+</li>
+
+        
+            
+<li >
+    <a href="../update/">Update</a>
+</li>
+
+        
+            
+<li >
+    <a href="../admin/">Administration</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+                        
+                        </ul>
+                    </li>
+                
+                
+                
+                    <li class="dropdown">
+                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Extensibility <b class="caret"></b></a>
+                        <ul class="dropdown-menu">
+                        
+                            
+<li >
+    <a href="../../../dev/">Introduction</a>
+</li>
+
+                        
+                            
+<li >
+    <a href="../../../dev/objects/">Objects</a>
+</li>
+
+                        
+                            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Files and Folders</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../../dev/files/naming/">Naming</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+                        
+                            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Scripting API (Add-ons)</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/">Reference</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/enum/">Constants</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ramses/">Ramses</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_asset/">RamAsset</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_assetgroup/">RamAssetGroup</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_daemon_interface/">RamDaemonInterface</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_file_info/">RamFileInfo</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_file_manager/">RamFileManager</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_filetype/">RamFileType</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_item/">RamItem</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_metadata_manager/">RamMetaDataManager</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_object/">RamObject</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_pipe/">RamPipe</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_pipefile/">RamPipeFile</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_project/">RamProject</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_sequence/">RamSequence</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_settings/">RamSettings</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_shot/">RamShot</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_state/">RamState</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_status/">RamStatus</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_step/">RamStep</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/ram_user/">RamUser</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/add-ons-reference/implementation/">Dev Notes</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+                        
+                            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Daemon API</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/">Reference</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/create/">create</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getAssetGroups/">getAssetGroups</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getAssets/">getAssets</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getCurrentProject/">getCurrentProject</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getData/">getData</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getObjects/">getObjets</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getPath/">getPath</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getPipes/">getPipes</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getProjects/">getProjects</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getRamsesFolder/">getRamsesFolder</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getSequences/">getSequences</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getShots/">getShots</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getStatus/">getStatus</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/getSteps/">getSteps</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/ping/">ping</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/raise/">raise</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/setCurrentProject/">setCurrentProject</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/setData/">setData</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../dev/daemon-reference/uuidFromPath/">uuidFromPath</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+                        
+                            
+<li >
+    <a href="../../../dev/server-reference/">Server API</a>
+</li>
+
+                        
+                        </ul>
+                    </li>
+                
+                
+                
+                    <li class="dropdown">
+                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">... <b class="caret"></b></a>
+                        <ul class="dropdown-menu">
+                        
+                            
+<li >
+    <a href="../../../credits/">Credits</a>
+</li>
+
+                        
+                            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Changelog</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../../changelog/">General</a>
+</li>
+
+        
+            
+<li >
+    <a href="https://github.com/RxLaboratory/Ramses-Client/releases">Application</a>
+</li>
+
+        
+            
+<li >
+    <a href="https://github.com/RxLaboratory/Ramses-Maya/releases">Maya</a>
+</li>
+
+        
+            
+<li >
+    <a href="https://github.com/RxLaboratory/Ramses-Server/releases">Server</a>
+</li>
+
+        
+            
+<li >
+    <a href="https://github.com/RxLaboratory/Ramses-Py/releases">API</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+                        
+                            
+  <li class="dropdown-submenu">
+    <a tabindex="-1" href="">Licenses</a>
+    <ul class="dropdown-menu">
+        
+            
+<li >
+    <a href="../../../licenses/gnu-gpl/">GNU GPLv3</a>
+</li>
+
+        
+            
+<li >
+    <a href="../../../licenses/gfdl/">Documentation license</a>
+</li>
+
+        
+    </ul>
+  </li>
+
+                        
+                        </ul>
+                    </li>
+                
+                
+                </ul>
+
+            <ul class="nav navbar-nav navbar-right">
+                    <li>
+                        <a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
+                            <i class="fas fa-search"></i> Search
+                        </a>
+                    </li>
+                    <li >
+                        <a rel="prev" href="../install-docker-sqlite/">
+                            <i class="fas fa-arrow-left"></i> Previous
+                        </a>
+                    </li>
+                    <li >
+                        <a rel="next" href="../config/">
+                            Next <i class="fas fa-arrow-right"></i>
+                        </a>
+                    </li>
+                    <li>
+                        <a href="https://github.com/RxLaboratory/Ramses/edit/master/src-docs/docs/components/server/install-synology.md"><i class="fab fa-github"></i> Edit on GitHub</a>
+                    </li>
+            </ul>
+        </div>
+    </div>
+</div>
+
+    <div class="container">
+        
+        
+        <div class="col-md-3"><div id="side-menu">
+    <div class="bs-sidebar hidden-print  affix well collapsible" role="complementary">
+        <!-- Main navigation -->
+        <ul class="nav bs-sidenav">
+        
+        
+            <li >
+                <a href="../../..">v0.8 (Beta)</a>
+            </li>
+        
+        
+        
+            <li >
+                <a href="../../../quickstart/">Quick start</a>
+            </li>
+        
+        
+        
+            <li class="first-level">
+                <button  type="button" class="collapse-button ">Principles</button>
+                <ul class="collapsible-content ">
+                    
+                        
+                        <li class="second-level "><a href="../../../pipeline/">Introduction</a></li>
+                        
+                    
+                        
+                        <li class="second-level "><a href="../../../pipeline/administration/">Administration</a></li>
+                        
+                    
+                        
+                        <li class="second-level "><a href="../../../pipeline/pipeline/">Pipeline</a></li>
+                        
+                    
+                        
+                        <li class="second-level "><a href="../../../pipeline/production/">Production tracking</a></li>
+                        
+                    
+                        
+                        <li class="second-level "><a href="../../../pipeline/planning/">Planning</a></li>
+                        
+                    
+                </ul>
+            </li>
+        
+        
+        
+            <li class="first-level">
+                <button  type="button" class="collapse-button active-collapse-button">Documentation</button>
+                <ul class="collapsible-content collapsible-content-active">
+                    
+                        
+                        <li class="second-level "><a href="../../">Introduction</a></li>
+                        
+                    
+                        
+                        <li class="second-level">
+                            <button  type="button" class="collapse-button ">Ramses Application</button>
+                            <ul class="collapsible-content ">
+                                
+                                    
+                                    <li class="third-level "><a href="../../client/">Introduction</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../client/install/">Installation</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../client/settings/">Overview and settings</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level">
+                                        <button  type="button" class="collapse-button ">Administration</button>
+                                        <ul class="collapsible-content ">
+                                            
+                                                <li class="fourth-level "><a href="../../client/admin/">Introduction</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/users/">Users</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/projects/">Projects</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/templatesteps/">Template Steps</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/templateassetgroups/">Template Asset Groups</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/states/">States</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/filetypes/">File Types</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/applications/">Applications</a></li>
+                                            
+                                        </ul>
+                                    </li>
+                                    
+                                
+                                    
+                                    <li class="third-level">
+                                        <button  type="button" class="collapse-button ">Project settings</button>
+                                        <ul class="collapsible-content ">
+                                            
+                                                <li class="fourth-level "><a href="../../client/project/">Introduction</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/steps/">Steps</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/pipetypes/">Pipe Types</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/assetgroups/">Asset Groups</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/assets/">Assets</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/sequences/">Sequences</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../client/shots/">Shots</a></li>
+                                            
+                                        </ul>
+                                    </li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../client/pipeline/">Pipeline editor</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../client/production/">Asset and shot production tracking</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../client/schedule/">Schedule and planning</a></li>
+                                    
+                                
+                            </ul>
+                        </li>
+                        
+                    
+                        
+                        <li class="second-level">
+                            <button  type="button" class="collapse-button ">Ramses Add-ons</button>
+                            <ul class="collapsible-content ">
+                                
+                                    
+                                    <li class="third-level "><a href="../../addons/">General Information</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level">
+                                        <button  type="button" class="collapse-button ">Autodesk Maya</button>
+                                        <ul class="collapsible-content ">
+                                            
+                                                <li class="fourth-level "><a href="../../addons/maya/">Maya Add-on</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../addons/maya-pipeline/">Maya pipeline</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../addons/maya-scenesetup/">Scene setup</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../addons/maya-publish/">Publish settings</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../addons/maya-import/">Import settings</a></li>
+                                            
+                                                <li class="fourth-level "><a href="../../addons/maya-extend/">Extensibility</a></li>
+                                            
+                                        </ul>
+                                    </li>
+                                    
+                                
+                            </ul>
+                        </li>
+                        
+                    
+                        
+                        <li class="second-level">
+                            <button  type="button" class="collapse-button ">Ramses Tree</button>
+                            <ul class="collapsible-content ">
+                                
+                                    
+                                    <li class="third-level "><a href="../../files/">Introduction</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../files/naming/">Naming scheme</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../files/tree/">Folder structure</a></li>
+                                    
+                                
+                            </ul>
+                        </li>
+                        
+                    
+                        
+                        <li class="second-level">
+                            <button  type="button" class="collapse-button active-collapse-button">Ramses Server</button>
+                            <ul class="collapsible-content collapsible-content-active">
+                                
+                                    
+                                    <li class="third-level "><a href="../">Introduction</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../install/">Installation</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../install-src/">Install from source</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../install-docker-mysql/">Docker (MySQL)</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../install-docker-sqlite/">Docker (SQLite)</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level active"><a href="./">Synology NAS</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../config/">Configuration</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../update/">Update</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../admin/">Administration</a></li>
+                                    
+                                
+                            </ul>
+                        </li>
+                        
+                    
+                </ul>
+            </li>
+        
+        
+        
+            <li class="first-level">
+                <button  type="button" class="collapse-button ">Extensibility</button>
+                <ul class="collapsible-content ">
+                    
+                        
+                        <li class="second-level "><a href="../../../dev/">Introduction</a></li>
+                        
+                    
+                        
+                        <li class="second-level "><a href="../../../dev/objects/">Objects</a></li>
+                        
+                    
+                        
+                        <li class="second-level">
+                            <button  type="button" class="collapse-button ">Files and Folders</button>
+                            <ul class="collapsible-content ">
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/files/naming/">Naming</a></li>
+                                    
+                                
+                            </ul>
+                        </li>
+                        
+                    
+                        
+                        <li class="second-level">
+                            <button  type="button" class="collapse-button ">Scripting API (Add-ons)</button>
+                            <ul class="collapsible-content ">
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/">Reference</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/enum/">Constants</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ramses/">Ramses</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_asset/">RamAsset</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_assetgroup/">RamAssetGroup</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_daemon_interface/">RamDaemonInterface</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_file_info/">RamFileInfo</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_file_manager/">RamFileManager</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_filetype/">RamFileType</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_item/">RamItem</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_metadata_manager/">RamMetaDataManager</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_object/">RamObject</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_pipe/">RamPipe</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_pipefile/">RamPipeFile</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_project/">RamProject</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_sequence/">RamSequence</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_settings/">RamSettings</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_shot/">RamShot</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_state/">RamState</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_status/">RamStatus</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_step/">RamStep</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/ram_user/">RamUser</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/add-ons-reference/implementation/">Dev Notes</a></li>
+                                    
+                                
+                            </ul>
+                        </li>
+                        
+                    
+                        
+                        <li class="second-level">
+                            <button  type="button" class="collapse-button ">Daemon API</button>
+                            <ul class="collapsible-content ">
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/">Reference</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/create/">create</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getAssetGroups/">getAssetGroups</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getAssets/">getAssets</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getCurrentProject/">getCurrentProject</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getData/">getData</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getObjects/">getObjets</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getPath/">getPath</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getPipes/">getPipes</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getProjects/">getProjects</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getRamsesFolder/">getRamsesFolder</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getSequences/">getSequences</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getShots/">getShots</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getStatus/">getStatus</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/getSteps/">getSteps</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/ping/">ping</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/raise/">raise</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/setCurrentProject/">setCurrentProject</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/setData/">setData</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../dev/daemon-reference/uuidFromPath/">uuidFromPath</a></li>
+                                    
+                                
+                            </ul>
+                        </li>
+                        
+                    
+                        
+                        <li class="second-level "><a href="../../../dev/server-reference/">Server API</a></li>
+                        
+                    
+                </ul>
+            </li>
+        
+        
+        
+            <li class="first-level">
+                <button  type="button" class="collapse-button ">...</button>
+                <ul class="collapsible-content ">
+                    
+                        
+                        <li class="second-level "><a href="../../../credits/">Credits</a></li>
+                        
+                    
+                        
+                        <li class="second-level">
+                            <button  type="button" class="collapse-button ">Changelog</button>
+                            <ul class="collapsible-content ">
+                                
+                                    
+                                    <li class="third-level "><a href="../../../changelog/">General</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="https://github.com/RxLaboratory/Ramses-Client/releases">Application</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="https://github.com/RxLaboratory/Ramses-Maya/releases">Maya</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="https://github.com/RxLaboratory/Ramses-Server/releases">Server</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="https://github.com/RxLaboratory/Ramses-Py/releases">API</a></li>
+                                    
+                                
+                            </ul>
+                        </li>
+                        
+                    
+                        
+                        <li class="second-level">
+                            <button  type="button" class="collapse-button ">Licenses</button>
+                            <ul class="collapsible-content ">
+                                
+                                    
+                                    <li class="third-level "><a href="../../../licenses/gnu-gpl/">GNU GPLv3</a></li>
+                                    
+                                
+                                    
+                                    <li class="third-level "><a href="../../../licenses/gfdl/">Documentation license</a></li>
+                                    
+                                
+                            </ul>
+                        </li>
+                        
+                    
+                </ul>
+            </li>
+        
+        
+        </ul>
+    </div>
+    <div class="bs-sidebar hidden-print affix well" role="complementary">
+        <ul class="nav bs-sidenav">
+            <li class="first-level active"><a href="#synology-nas">Synology NAS</a></li>
+                <li class="second-level"><a href="#prepare-the-server">Prepare the server</a></li>
+                    
+                <li class="second-level"><a href="#install-ramses">Install ramses</a></li>
+                    
+        </ul>
+    </div>
+    <div class="footer-meta"></div>
+</div></div>
+        <div class="col-md-9" role="main">
+
+<h1 id="synology-nas">Synology NAS</h1>
+<p>It is relatively easy to install the Ramses server on a Synology NAS server running DSM.</p>
+<h2 id="prepare-the-server">Prepare the server</h2>
+<ol>
+<li>Install the needed packages using DSM and the package center on your NAS:<ul>
+<li><strong><em>PHP 8.2</em></strong> (or more recent)</li>
+<li><strong><em>MariaDB 10</em></strong></li>
+<li><strong><em>Web Station</em></strong></li>
+<li><strong><em>phpMyAdmin</em></strong>, to make it easier to manage the SQL databases.</li>
+</ul>
+</li>
+<li>You may create a specific web portal and web service for your Ramses server. The web service must use a <em>PHP 8.x</em> version, and should use <em>Apache</em> if available.</li>
+<li>Create a new SQL base, along with its user and password, using phpMyAdmin.</li>
+</ol>
+<h2 id="install-ramses">Install ramses</h2>
+<ol>
+<li>Unzip the Ramses server zip archive you&rsquo;ve downloaded</li>
+</ol>
+<p>&hellip;</p></div>
+        
+            <div class="nav-footer">
+            <ul>
+                <li class="nav-footer-prev">
+                    <a rel="prev" href="../install-docker-sqlite/">
+                        <i class="fas fa-arrow-left"></i> Previous
+                    </a>
+                </li>
+                <li class="nav-footer-next">
+                    <a rel="next" href="../config/">
+                        Next <i class="fas fa-arrow-right"></i>
+                    </a>
+                </li>
+            </ul>
+            </div>
+        
+    </div>
+
+    
+      <footer class="col-md-12 text-center">
+          
+<div></div>
+
+      </footer>
+    
+    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
+    <script src="../../../js/bootstrap-3.0.3.min.js"></script>
+
+    
+    <script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/highlight.min.js"></script>
+        
+    <script>hljs.initHighlightingOnLoad();</script>
+    
+
+    <script>var base_url = "../../.."</script>
+    
+    <script src="../../../js/base.js"></script>
+    <script src="../../../video.js"></script>
+    <script src="../../../meta.js"></script>
+    <script src="../../../collapser.js"></script>
+    <script src="../../../search/main.js"></script>
+
+    <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
+    <div class="modal-dialog modal-lg">
+        <div class="modal-content">
+            <div class="modal-header">
+                <button type="button" class="close" data-dismiss="modal">
+                    <span aria-hidden="true">&times;</span>
+                    <span class="sr-only">Close</span>
+                </button>
+                <h4 class="modal-title" id="searchModalLabel">Search</h4>
+            </div>
+            <div class="modal-body">
+                <p>
+                    From here you can search these documents. Enter
+                    your search terms below.
+                </p>
+                <form>
+                    <div class="form-group">
+                        <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
+                    </div>
+                </form>
+                <div id="mkdocs-search-results"></div>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
+    <div class="modal-dialog">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+              <table class="table">
+                <thead>
+                  <tr>
+                    <th style="width: 20%;">Keys</th>
+                    <th>Action</th>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <td class="help shortcut"><kbd>?</kbd></td>
+                    <td>Open this help</td>
+                  </tr>
+                  <tr>
+                    <td class="next shortcut"><kbd>n</kbd></td>
+                    <td>Next page</td>
+                  </tr>
+                  <tr>
+                    <td class="prev shortcut"><kbd>p</kbd></td>
+                    <td>Previous page</td>
+                  </tr>
+                  <tr>
+                    <td class="search shortcut"><kbd>s</kbd></td>
+                    <td>Search</td>
+                  </tr>
+                </tbody>
+              </table>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div>
+    </body>
+
+</html>
diff --git a/docs/components/server/install/index.html b/docs/components/server/install/index.html
index 54ec40b3..976cb173 100644
--- a/docs/components/server/install/index.html
+++ b/docs/components/server/install/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../config/">Configuration</a></li>
                                     
                                 
@@ -1419,6 +1429,7 @@ <h2 id="installation">Installation</h2>
 <p>▹ <strong><a href="../install-src/">Install from source</a></strong></p>
 <p>▹ <strong><a href="../install-docker-mysql/">Docker (MySQL)</a></strong></p>
 <p>▹ <strong><a href="../install-docker-sqlite/">Docker (SQLite)</a></strong></p>
+<p>▹ <strong><a href="../install-synology/">Synology NAS</a></strong></p>
 <p>You can <a href="../config/">adjust the server configuration</a> by editing <code>config/config.php</code> and <code>config/config_logs.php</code>.</p></div>
         
             <div class="nav-footer">
diff --git a/docs/components/server/update/index.html b/docs/components/server/update/index.html
index ac71ec49..971a9213 100644
--- a/docs/components/server/update/index.html
+++ b/docs/components/server/update/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/credits/index.html b/docs/credits/index.html
index 35839fcf..c388ba24 100644
--- a/docs/credits/index.html
+++ b/docs/credits/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/add-ons-reference/enum/index.html b/docs/dev/add-ons-reference/enum/index.html
index dbc47b31..74ef2d7a 100644
--- a/docs/dev/add-ons-reference/enum/index.html
+++ b/docs/dev/add-ons-reference/enum/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/add-ons-reference/implementation/index.html b/docs/dev/add-ons-reference/implementation/index.html
index 6b47a2a2..e5ae7b54 100644
--- a/docs/dev/add-ons-reference/implementation/index.html
+++ b/docs/dev/add-ons-reference/implementation/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/add-ons-reference/index.html b/docs/dev/add-ons-reference/index.html
index 4a1ad8da..6a0e9fa4 100644
--- a/docs/dev/add-ons-reference/index.html
+++ b/docs/dev/add-ons-reference/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</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 df6b6008..e6c75dd5 100644
--- a/docs/dev/add-ons-reference/ram_asset/index.html
+++ b/docs/dev/add-ons-reference/ram_asset/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 6ce5f649..50d07b90 100644
--- a/docs/dev/add-ons-reference/ram_assetgroup/index.html
+++ b/docs/dev/add-ons-reference/ram_assetgroup/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 3e5ec66d..f512cb83 100644
--- a/docs/dev/add-ons-reference/ram_daemon_interface/index.html
+++ b/docs/dev/add-ons-reference/ram_daemon_interface/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 4e365fb7..b5556f18 100644
--- a/docs/dev/add-ons-reference/ram_file_info/index.html
+++ b/docs/dev/add-ons-reference/ram_file_info/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 c307db1f..dd940e63 100644
--- a/docs/dev/add-ons-reference/ram_file_manager/index.html
+++ b/docs/dev/add-ons-reference/ram_file_manager/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 fda14bff..6620deaa 100644
--- a/docs/dev/add-ons-reference/ram_filetype/index.html
+++ b/docs/dev/add-ons-reference/ram_filetype/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 f944c76d..69c407f3 100644
--- a/docs/dev/add-ons-reference/ram_item/index.html
+++ b/docs/dev/add-ons-reference/ram_item/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 fb1047e0..2955f9f6 100644
--- a/docs/dev/add-ons-reference/ram_metadata_manager/index.html
+++ b/docs/dev/add-ons-reference/ram_metadata_manager/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 b989bd8a..729196c9 100644
--- a/docs/dev/add-ons-reference/ram_object/index.html
+++ b/docs/dev/add-ons-reference/ram_object/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 eba603e7..ba2d25b1 100644
--- a/docs/dev/add-ons-reference/ram_pipe/index.html
+++ b/docs/dev/add-ons-reference/ram_pipe/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 01fdf7cc..72382282 100644
--- a/docs/dev/add-ons-reference/ram_pipefile/index.html
+++ b/docs/dev/add-ons-reference/ram_pipefile/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 9882b34d..e69d77e4 100644
--- a/docs/dev/add-ons-reference/ram_project/index.html
+++ b/docs/dev/add-ons-reference/ram_project/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 560e3a56..22cd8e7e 100644
--- a/docs/dev/add-ons-reference/ram_sequence/index.html
+++ b/docs/dev/add-ons-reference/ram_sequence/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 a6219d28..3a359eae 100644
--- a/docs/dev/add-ons-reference/ram_settings/index.html
+++ b/docs/dev/add-ons-reference/ram_settings/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 7a98ae61..542f586a 100644
--- a/docs/dev/add-ons-reference/ram_shot/index.html
+++ b/docs/dev/add-ons-reference/ram_shot/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 1b976bbd..6a3c9046 100644
--- a/docs/dev/add-ons-reference/ram_state/index.html
+++ b/docs/dev/add-ons-reference/ram_state/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 e7d61b98..f69d272f 100644
--- a/docs/dev/add-ons-reference/ram_status/index.html
+++ b/docs/dev/add-ons-reference/ram_status/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 8b6e2e71..29a93818 100644
--- a/docs/dev/add-ons-reference/ram_step/index.html
+++ b/docs/dev/add-ons-reference/ram_step/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</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 60861484..5cf665c9 100644
--- a/docs/dev/add-ons-reference/ram_user/index.html
+++ b/docs/dev/add-ons-reference/ram_user/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/add-ons-reference/ramses/index.html b/docs/dev/add-ons-reference/ramses/index.html
index 508b3cb1..4a440f66 100644
--- a/docs/dev/add-ons-reference/ramses/index.html
+++ b/docs/dev/add-ons-reference/ramses/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/create/index.html b/docs/dev/daemon-reference/create/index.html
index 491ad2e6..5f6f69c1 100644
--- a/docs/dev/daemon-reference/create/index.html
+++ b/docs/dev/daemon-reference/create/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getAssetGroups/index.html b/docs/dev/daemon-reference/getAssetGroups/index.html
index ce34037f..d889d5f3 100644
--- a/docs/dev/daemon-reference/getAssetGroups/index.html
+++ b/docs/dev/daemon-reference/getAssetGroups/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getAssets/index.html b/docs/dev/daemon-reference/getAssets/index.html
index 811a5218..af531baf 100644
--- a/docs/dev/daemon-reference/getAssets/index.html
+++ b/docs/dev/daemon-reference/getAssets/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getCurrentProject/index.html b/docs/dev/daemon-reference/getCurrentProject/index.html
index 9ef11146..d5667819 100644
--- a/docs/dev/daemon-reference/getCurrentProject/index.html
+++ b/docs/dev/daemon-reference/getCurrentProject/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getData/index.html b/docs/dev/daemon-reference/getData/index.html
index e8c984c5..7194e239 100644
--- a/docs/dev/daemon-reference/getData/index.html
+++ b/docs/dev/daemon-reference/getData/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getObjects/index.html b/docs/dev/daemon-reference/getObjects/index.html
index 7335c8a7..0c556597 100644
--- a/docs/dev/daemon-reference/getObjects/index.html
+++ b/docs/dev/daemon-reference/getObjects/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getPath/index.html b/docs/dev/daemon-reference/getPath/index.html
index 9e7fd6d2..dd3fc78e 100644
--- a/docs/dev/daemon-reference/getPath/index.html
+++ b/docs/dev/daemon-reference/getPath/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getPipes/index.html b/docs/dev/daemon-reference/getPipes/index.html
index 37334e61..0e999fe6 100644
--- a/docs/dev/daemon-reference/getPipes/index.html
+++ b/docs/dev/daemon-reference/getPipes/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getProjects/index.html b/docs/dev/daemon-reference/getProjects/index.html
index 79305fe4..e4c51a89 100644
--- a/docs/dev/daemon-reference/getProjects/index.html
+++ b/docs/dev/daemon-reference/getProjects/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getRamsesFolder/index.html b/docs/dev/daemon-reference/getRamsesFolder/index.html
index cc3f81a7..2f8b9c19 100644
--- a/docs/dev/daemon-reference/getRamsesFolder/index.html
+++ b/docs/dev/daemon-reference/getRamsesFolder/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getSequences/index.html b/docs/dev/daemon-reference/getSequences/index.html
index 9c64c5fc..ebb3dba4 100644
--- a/docs/dev/daemon-reference/getSequences/index.html
+++ b/docs/dev/daemon-reference/getSequences/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getShots/index.html b/docs/dev/daemon-reference/getShots/index.html
index 9206bf2a..ffee9d49 100644
--- a/docs/dev/daemon-reference/getShots/index.html
+++ b/docs/dev/daemon-reference/getShots/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getStatus/index.html b/docs/dev/daemon-reference/getStatus/index.html
index 6d479e07..8f34f434 100644
--- a/docs/dev/daemon-reference/getStatus/index.html
+++ b/docs/dev/daemon-reference/getStatus/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/getSteps/index.html b/docs/dev/daemon-reference/getSteps/index.html
index fd235042..3b878bb7 100644
--- a/docs/dev/daemon-reference/getSteps/index.html
+++ b/docs/dev/daemon-reference/getSteps/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/index.html b/docs/dev/daemon-reference/index.html
index 5fa429d5..43c0ebee 100644
--- a/docs/dev/daemon-reference/index.html
+++ b/docs/dev/daemon-reference/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/ping/index.html b/docs/dev/daemon-reference/ping/index.html
index 98eb23b8..2f263795 100644
--- a/docs/dev/daemon-reference/ping/index.html
+++ b/docs/dev/daemon-reference/ping/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/raise/index.html b/docs/dev/daemon-reference/raise/index.html
index fcc002e3..9be8b480 100644
--- a/docs/dev/daemon-reference/raise/index.html
+++ b/docs/dev/daemon-reference/raise/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/setCurrentProject/index.html b/docs/dev/daemon-reference/setCurrentProject/index.html
index dced1ccf..56f1e9cd 100644
--- a/docs/dev/daemon-reference/setCurrentProject/index.html
+++ b/docs/dev/daemon-reference/setCurrentProject/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/setData/index.html b/docs/dev/daemon-reference/setData/index.html
index 0b7a8bf4..9ed111d1 100644
--- a/docs/dev/daemon-reference/setData/index.html
+++ b/docs/dev/daemon-reference/setData/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/daemon-reference/uuidFromPath/index.html b/docs/dev/daemon-reference/uuidFromPath/index.html
index 42c50b2b..5fd341b0 100644
--- a/docs/dev/daemon-reference/uuidFromPath/index.html
+++ b/docs/dev/daemon-reference/uuidFromPath/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/files/naming/index.html b/docs/dev/files/naming/index.html
index 1893c011..830c8303 100644
--- a/docs/dev/files/naming/index.html
+++ b/docs/dev/files/naming/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/index.html b/docs/dev/index.html
index 74669f1c..822c1d41 100644
--- a/docs/dev/index.html
+++ b/docs/dev/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/objects/index.html b/docs/dev/objects/index.html
index 50ebb5d9..33e83abf 100644
--- a/docs/dev/objects/index.html
+++ b/docs/dev/objects/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/dev/server-reference/index.html b/docs/dev/server-reference/index.html
index 5a5ea4ac..3dc27735 100644
--- a/docs/dev/server-reference/index.html
+++ b/docs/dev/server-reference/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/img/maya/publishsettings_alembic.png b/docs/img/maya/publishsettings_alembic.png
index 3bec291a00fcfb04b9ad7d5f3a78e69e88bca68a..d221ca7cf25d5afc5d3a0b94cbda921512abbab8 100644
GIT binary patch
literal 42747
zcmce-bx>R3yEO_elp;k+v0}xg#fw{uyKC{{?oN<Gk>c(S#ofIWNpY8;#Vts%U?E@H
z{=Re0%(-*t{&n{ZFniA?dG&eLv(|beRFtG&V7$gaLPB~WD<h$Xg!EJp2?_bf^Jj=B
zUw1rK5Py(e)uhFcs>jI=5H~269~D0$A=SlVKA4~)?$MoObX}2<u>1b}AOjss%@7Yw
ztTlAp)E%sy6wTdC%uL)&5YLd1e5p<CtesRGtsUH4sRi_WslBKL*xylmBYp$k{k`Mk
z<o$oVfB&BEKX3ed|IfVv!1cQZ5DDo!jjY5+4KKrE7>*O!0)XMppGq!CL99qptRIQ?
zO*#i-Tr*Z2jd*XGNu!4u{vb_naV>#m7evG+4+zi{19hxn9DUXARS8)c0W0!!%QzS?
z6GQCPAl<WK^|FL7mNI|6)P7AL{vohAH6)z2Ih57{3E2$gO98FiPr;s(87|@IliM)l
za1uY!>bmb8%DJxXXef8QJu@Zp6oAVqlEoG8z3iKQ1`(47&)f5z)~y)9%arAc&QARv
z`QvQQwW(8u(=KQZWZn0q4R}*?b6Fx94S_g!N&LOOT3J{;qYQYcgWR3<;Y6Ev6d7CY
z3@5jqcHh_fLLG!|eh1&omWY_Y!^it`vG649xBA`IL+&zrZb@mToR8*Ny5<PMe&>m~
z{WXt=HJdE~_bpuG1-SoSe}<2b&*uRq_J6#{1xkC8n9kA`&MYp5!*3|zG*8K?|6I&`
z=H}+lp9SBHT8fyiB+#71@p5V$uRml4m{z{|_lAb=HJD@f4I>j%FZsFD$&`sySoog{
zBiqcY`?8pg1Vm2LK$D2~?^_9iUy$+;H^`-e*SdUnl^?g2r^nlQu6m_!rjn0tdIDZ^
zsfit|bb+zmV23`lH3s<$|Nd`GG`+a0p+Wsgj^Ok&0k{|JX^2$yXR|{<7kw90^p05j
zyXd6+zhT2Py*ixR6&Cd2FOGnU{;Y~kq@28Ht53dJ5<jZ-j!tjW?XK+Caae05)EeSt
z?fweCnlCl{+ZXCjd?cuX4&Al>+}%4hKON^X@JVM^jcne*msvzib+aB1GKp1?asCdU
zDsxv?SNPy(A8Q^Ey?K4SYb}if;F6;`dEK@X?sv=VCzO~4lihR8y(c^Ag09^hjiz(?
zM7D@NZi(_3I&A-j!+PM*G*#FQ4tzuOx6$KBfOV&5VmZa%hJ4a7TI?pT=|2Bv`-A4l
zEHi0nFzZWpfX|-rit8SEX*bltZ_Sg9)exZVIJ7e1f6b-e<4-R72#JO4um$MWWOs<(
z6^j0Z_P}9L^y+`-sbIO{=U!ip==EY{AP~dt|9)hwg#|mG2RXdpP~=976*v&kUDje&
zQ&)%A10n5+SM~TemEU5yey7Xl(d@nghxf!90DIQ-V|pRhX8hmAG$kb^r=8w!=o4O3
zIXQs)X3YXBDzWSv8V=*(?Jv9&e~&C_59<^;_-5CivIX4ASAJ?@?lw%Rsy{!s8R^Ce
z7XH)UPs3p33H>MJe+F?z&ZzZ{bzEY-_m}8;zfq6-3rEGSFgUljc<Qeh6k7OAEIe)M
zsS<o9;7*y(|Dl!R;TY<F3bjCGS5g+aEmGAo<ZK-KT(dWm`}p3_4<gw`X99nOLGnFB
zVF$|5?k`(A?+z<u-G`m{(Lb9hIqEXp%LH1~wOqaJIe!ajK0G{hI$3G+GMJ|LJIiAR
z<GtgMfUF+@kN3}64FV{Y;bW4Weh06+d4)p9xq2jcJcooH&ibUJOxL>s5Myd`bf?O^
zeZBQN!pFNB_>$MDWGE2Sz)9#UEa(CLu``ky4fQa(n@)`qS(44W5bU`S^cgZUH>-RX
z4K_VZ?W!_@Um5W(C5%q6`9mVT2Bi(_?aV{|?x&R3_mkZBan1Up-o(rLy1Mw@JBRAI
zcS-(xC&j6Tob}8v6^cfl@WWE!=SET8L){L@iP<Pp>gwu{t)cC-qSJ8z=a9qSP7#pq
z2@8z-detX;*Iqz?Hv`HO$f5vpu06w%{jU{mlEz01HNX+Jp32m~Q^2Y3UG~9OBE!j3
zV=RKiH#FqvZ)oFWQc=%8qp~Kr$B&LuKJ-!&j}WFCZ#X{gI@Y)E4Pw}=giieZCKfuw
zM7&YD-$RUxkktk(!G*OTqX%%wVLANM!&UU)L|&Z@OS7n#Xt#!X&{KFUoAIq8!7Cke
z2SA=JVzRMaj3T*d!9i#glX?m-S9JQiX@A6l<(aS1kzy!>%NHyLMfw#^VDU(jq2ogV
zRaf&UsG@gMv9+#y<2OF{!h(h|<boEnwl$G|#?PwE8`iX7fhs`w_IErdh!NCaIWcPV
zFkrMV>F5}(OnnnT_LVzqF?;0X2jycAoO>K*ih>hRjuCJ*yuLB?o%{x#bC>%ZUV~?V
zanlkTfV}S2smk`ZlXzo2jsf?}ZR-tNdKa<}zpolvJz&rLIo*&Ev76(u#xx+<S9_&U
z{$C(l6(K<rgeF)2$ne!Zr2BootPM%*y|{U_eac5668X3h@N-hM^D89`HsOZ;Hx?8u
zGi;gI{U;-QR_a^)yBfj?xt<CBeW;N{4F3Dks;ZxB#s5B%jOfMwH`8?g`z6kt1}<UY
zDx!$LpM$YJ7)_cEqWbey1)KfG|Jm>_gZ~r%<*+>dzE{e~vH0($f}}9x5^SS@6Mi8}
zUqF|Vqg=r-Y>gMvs@xNBa&!o<g3jNy)wh^9>+L1UlKkxgGp+Y9xHDQCzKx4b&S@0j
ztyFXEh8^I&&o&4Dm%GMdy(tFiN$|5Fw|AC7FS`VC#^T|RZ|w$QH&-ROeY`}pP1N?E
z050+$58h2|87U{0{TrKscgnpnB$a8sLEJ)$UtbtGN`ekVIk-eb(QK~nP=?MPJoP8j
z^G_dR(+ow4uDgH9qpCyR$lqPo1j1QKN=17s%wxT=4Ak8#@7qA9aDU`XxaMZszYepH
z_ObKWdVL}n(Gv{15S>9DZOb+F8uSzFNeG)IPcUX)t3I5uDE%$@C9ec>1YM7H-|<m@
zsR>-)|L9S^PNWj*-kJM%G)wbFFW8$07?<z=F2wLs+%eNyu24wCecg^p_RF&ScQ*EY
zLk>7|B`x-V^CZSC-v<sm|9hcI6oP+~80y_>3Cys16AFiD*NEA(F9Z-0^I!^Q^-Zw7
zn?*s55dodB$zAi%&%?f}?j9JS8Nw>y`Pa06r&LU>-f|)*{oug5OUA`$Vj<v^BMN@t
z8J~Ll@^3e-dhJ(Qotf4e{;eE&WUl|LDz~)%EQ*4G|1XQ;|83<I14{RsY!}W>I!+Ji
z3RbFg>YhMXJ#+u%+ziokm8qoO7=ryu{Wi54s^QgWQeNV-KP!6biwr4Pzs+UfxtqgU
zXW0VoPIYA^*4EaRPLF?=;ok<o7o}a?5dL2qVVHFhy|IwtmDn#Y_xz?$HJ$_?d}EWC
zrbg0--9$B6*N86WiUpGFZQByBUHL`+E~QV;)6oRys=Q8QDV5xtsfe-47d~D}T{bV%
zhjuF+MBWON3cN3DK{QL%dAS~nbnP&OdE}8-Wsf$0FtFKz>WkB8BK;7UJ>pSsUvmc^
zU|ff#0I+`t9uvSxbl<CyyLP{mApJ@;Vq(V;W$1#*V5ggM9cZ{mOG4Vhc?}5A>%uAM
z?hpGOL&2p^1ESRw>3E2!swx6Urbk;lo{E)L5X@bhYiccFHbVRFtxhzf=UFRQ8=`b$
z4;k!W?}uL^21|@zROm~_rwcg`gJb&No9u(pbaEaPY~=p3uz>ubru9TV*GqP6O063F
zLrb%T&o3^msNPjnRl&y5DE;z?5)BXtVkDIf7)I&;ywjBeUhBu(eRW*36%>KL-&2Ii
z6m)%>cW#D@26uZtqUVpP_qbu66;Of^d$JaCpuN+TbnsyZCs)n<nZ5ZapyxFvmDicF
zb0@rHUsNOr%|rY18OU)%dA#(AX6$EA^H&Vu7q2y7EP`jYu}yi!1Ae-&gy!ZK!jX=!
z(|{mT{M_Dvn<{3kE<cLXeSlwZK)B=MP<qjhBjA+&QL^?$MNurniCCYb!%ts^J7?Ks
z0r<HynJ8-wy5H_H{D~(;03Ms1sGf$Xpt~p&OS;FW@41FeHpzb$%zHG))I2{=BxtO@
zl<sdTh3-dD$oz|2se4)QS~vM}i{oH@e1lE)tCTC2^2&w!?5db^TQ8Uxx<{jMbd4~p
zy9037oQBU9Ty&&!{igf6X*I^)qior*rSOGvz_D{v0DpCtKe8hbS_kdbw@t9`Pzfd|
zU9xFvdy?6ry|D^ixl54sB{Z1#P}o^83<Gtx*}LBIfFH$}q{h3yl2X7%!D%PjBja1O
zxq`kume3KH{<>pM7!{y;$I{G~gg#27QvR0zHL&U4*%apcSOVET(T`!$)TP>4jR9#X
zPfys_KV&Twi&J<eXj(8#`#!ht#XU2N9ghk}dbs+~^@$S0J#T1FeBhaBa5S^JcEPaB
ze7~X8b#(rz&LZOu^GbB{NiFcKaofah)r5)8KH5Y@Qg~2g13ByM`nS*<m?THjn8@R}
zeojQxXN9g<L#>J^sECHvfuCZYfu+Z&os#*mZ!#jNSeax2Z7l;852+nz=Gc{DD@MAz
zI%;=ERbf?+n(t4>{jD-*Rk>V#R&LP^y^Y#(iyePOCK6N;y*#&5Y|ip}By>wRq)B#}
zvkrBcv}Q9z)ss4s3ZU|KuDy`2f&Mpf3@u44KJgSu6a~MNI6c7Gkxkb{cql!-Nr%gs
zEX-GlRQEm9-@-@15V%2i@7m=cjl`XZpT?e|77#P&Os*-a5`C{CSUFq@P2_HBSK!H2
zFLwp|kE$u(<u2a})C{nMffj%6I~+-@k193xOBeD7V|NKeB-NcjA<PZWW%FjpBul1F
zaYHX{5MiSoHW<eCgqyon;9aV}o{An<L}cIH=E(!Q)Vzb3z1CEWE--x|flYOeptu`N
zqMO4gxZW$fxqjMkx>=zV6EgG~EZ1HqahHc}o7&id6K%UtP^sW3$CTLJ+O(HcPO*G@
z1-2B49b%nvt@=^`*o6t)5C4Sx7>(O>eIH}%_e6W{9z7x^3aXWE7sHh3YG?U4S`2T?
zuDSTM;_}=hi<Rc}g^4Y-`=;1%QU#}GjISQ&BJYu}$4_EDOWU`<rB@f<BqZ>IzD56B
zG?>$LtbFq+W6gVyT!K12%1A9I+{zHdrnDES{|1fTNy8FF>hkb`z2Sv4!;{0$b2%SX
ziLU1X42R~lY3DyHy7b$wT=QdxhHRuc$va-+zZyMo9o<bk2gI<n+;<Xw2V0m%u3xSP
zeXk>O^PvB-Mg#bu9=0|g15$rg$~lqyb95YA*u6<ps!EhtY;<WMt@Q_%)~?G|K<hnf
ze`WI*kt~7p0+PyYYN5dVyF8Gns9iew+ys@9$_M#K6gJN_Z_7b81kh=$9XItdW8u*?
zif}BG9NU&mGfEq2*=%;~GSBqS9DPSr)92zYW?;jdb6=d$eGHiaI$KQVNID&eQ_!{S
zC0Q+#J+sIbFPVku@0(^QqM`vOjH3a>Ygr;da17HGf3y6RtKjmnXwBDRvxyvGu9=w`
z9}ZCRTkTqx9l4cGZ*@fSGDyE;5fu@MxjI@n;?}UD)uZ{SAi&mn_Ju?LYQ9RZw0c+3
zLE?Sx_AVHSKIWPj3Qim0l#u<!yEgA5*$rARW^<O7VpnSzY|hQD!fx~2qgzZlzHe)?
zH)@91ErU`XKN)_XURx;riOul^zu^QH$Bgr#JWI&+m2k<3+U3CQT5%U&LuHY$jZKmJ
zJ%8f@&B!-fQQ@UCzVF+Jpu%U_(-kwpSUG0M#(Q<T?1m@pOJ6H|yq9(e_zv7wowvB=
zSiW|CTp2W<L2Kbj$w4Gy&c*z%eZ~yx*G697<MA)DQ&M<VAFXIdXcyx@NEcyy?A{Y|
z3FeFzmA}nBE~-~K#>Im`Ul8D+dz?E>VB_r=nZ)!oJ;@$jjDeu!27f?+)7#WrSC8=B
z@CndR(iRDFMp2>O3Gd!8?=A@1Q?fS=^`ZC@=eWPJdz^YT-|&*+!`v3KUE>50QJnFe
z+0sGwP<6H`vII|@;4%Fa`$D(diGu;6k2j{3hFwcux$ov&aYL%sA$x>rfNTH3FMwP@
zC--9pyS>Sd?*0pEho7f+52&l!%MEW|?k(Qxwl!^;z1_OT!d=*ESZa$x^FOk_S)Vx`
zsZC3{ziMC&4?o|q*Y{ez>ypq|toI+s#$!q9Z%m($db?*-pM##a2Z}B6MPR%*pEds@
zUG#MzoGtS9#?rzf3SDr!XMTiYAH3Yc)-9qwH1U!BK3aEz1$S*iM@C@Yg!V<eyr$8n
zH{R|$-oeL1zapQQP;J8Dj_eS(T-ifQnJCknO|#7ih`BBM5W^q>A$ubLO}uqpG-!5v
z?(2LKlpJkxjmEq_yX4&rOoRU*j3YSHynC7U6XUgs-MnJi`B^9TqWcHd6r-7=5ay%1
zl_0l^>*d_!-%gKo3#81)i0Uch(ugWZY4;_v!MQ80nlRU!NK@{0rm`b>0kj0BAw-r*
z7dm<avrMQa_x}ECJA;$pO_lgDy;ndeVh-h35NNJG%jXUOl?EuWd~my5y*(5S`*AP0
zOVHcHzX5OhHMe@S83=)>4ktk|wNC_quDDq9JQv(h-xSVLN2Lj)+U<^Y*1<4mJmwEe
zY88*`zBXzF#UDchnnCrY<2zzWHKsD24rXmCC&{DWtY1!!w?E5S_7W`}85($ITm?@t
z;ryep6|bQM?+i+QEYnDn%Y^00SJ~$2$<}p=;0QgE`|h5qH8fSD&%XYO8DZbBbIAJV
zVO37Co_6-*!xEt7E1EWBXt!32$3go_4xPmN^;x!8rb)BtZ>)(mKl{VB_o&Qx9Rpsr
zohd`MEst`@<gbHbvM>0bw+V6ms8gQ4z^^ZzxVXhM+*@Q#^w>R1?;ld($*XKum=+-W
zDJ8)#5SzM5gZ3>boj;W=3&S>J=j#m_#?{KU^e+CZ|G&Uh`6GV7mj=@A=m6(E=eZJ)
zy#uKa;riV={0Wd=B-jzI#T{xWg5y1!-`HVai@&b19J7AQ_-M2&2f<;wfBl2Ey9<LM
z7!6Vayx#!7C<dZqaMJM>E)+Ucco%lM7vA|kuJ?bB1VRd1{3C|Ujea=3#((u8nWb+G
zO7Zh#HP+O2PBH7Y;&iLCyYBKBbK&gwg8xh>$s^TbGrwbH04d#0?3TRIH19x<Ui7g!
zJ`)4uA1d-13`*pjjKBBb%*gvasMq=qc-gA(%86o+jjgZQpyRC7`C+HkLP7sGxB+nc
zY_0y(6{s22&%o$pcTuiPFT2<^BBU*QFVA1&npJ=U@klU#OkYe*Y+2R0edEDf-P_jl
znA`qtYMM3?FuTa0?QQ$@)^UI*U*>ZG4%NDtB}YWKs+2OyR+d7)4$nFRy?|~+4K2&a
zHkE_@p@4;=%z5A^wmz$4VA4bEN?P8oZLFX_u=NULI3axq9Zw~{lG7Uk#t)&eXQr~K
zy9-l@Ql7x-D*Lb(B8;Yw8Nk3Khw1d~EpCQ*h>ad)#nGNMtQvsxSQ5G88VAVQ8~jvr
zf5;ycf5nv*x1xmZKX$b@r{(!A*ZV$1?jV4|g(f|lET@4+H}=gT@NUw(mI#kVyddRD
zi=!x|qff1xWXcjJpLg2o#B?O5e<VaBUFklK@7}-6!KwMQV$D-?b1`4F@gcoS(N{R;
zT=sZr`SQ?~`%{O&ByEtcr;cO3-5I~&#YcbdcPkgT+x&tfvuukB2nJi)uXJB1P84JJ
z>3QXSR(J~Y-suNjEh3}&r$o_c-f~ha54-xI=d;)&xaw`VYcI%hVIAtj;4iR`aSrx6
zBNo1#2jQ^ZxCrwa9`&mkP)@d8#Xv0${_oXL?VjwBbCD}=OocR{*~6nX%4nEjI~17R
zWp@Vy+h@RZ3zy%w6pI=PS}vE32QT{;z9jVpphrSooto42Q>S9Ews;=DrvYl=SPZRA
zTZW$3q8DX|QA*x&_4se}26P#iTwsDi(%7InABJ_H_g=|En#90oEuZ1|$uS#NZ7xT)
zC|zj5`%yfu#H1{`3B~b9^fRfxT462>0eskL0l#CoCaGL_(?3%uj?&{roaW-~nXz5(
zXxRH)aS@QP>IECf_C;~=S1S|=I7XPh7A0?9o!OtKL~AR}=7z|(!xEO?-<u9?dKoN_
zhdp^9OK8nnkD_NEF3Q%}>pfbmKMwHtZ=5Dx?&w&o(8jF36E2CsX=B2IDKe+B{T>cq
z*}iL+B3b>;su~NVysG<nNt#Y3-C?6=(1~2rok86tJy~*HwVgWG$oNZVy}yO&Lh%dH
z(5%_r=h{Ta`O8I2XgWRtk$WBYdSdu!!UWIQI`SV3CpPVWx_ivWx-myNHcU(mt5<$V
zu;^*z<TIRTzR3R}64p7?m~A)F_i!b84_e&hz4y$s27i?p+>)W3oQ>by1!(Txs;7ZK
z`6boO!!pgZA!$uD93+7xMTqUlK5R}Mbwc!+5qcm=w*vcu5$Klrk@7C)SFPa2egh?+
zWhIdzAUWT${+&2T>2SjlkyA8?x0kov62n`QITi+bvU9kDWSP?&)4TqGw8tv1$7LC(
z*;AK?A(-=7)(zd9f7#OLpMm9pP8?q-XsP6iC$uT1B(@`lma1;ezCL%`$J}ap<!LV2
zDTr$L1>zTVfnVbNQ;)KWZrLr0U``<HY0N$P{PBn7ZYlR6I;l;l80`#{@YizDJ?3Tc
z&adZEHuH-obuv>qPWD_^{zE`BO<MgsdZCyR-B@UwoGaP&oh5mXe847nxdEgMv74!5
z+2MD$)#EY0_9k4|Gp^BIyyoEKps=TRcC?)LmV?}uO3u#yBDBmL_c32xIo*o)^&kdM
zelht&+G#BEeH`9Y@yZo1e`E8w&G!-c5B0-B;9_FGwm*Tc=D^^O-DYADMu_!~pJ`P2
zFM1|f(n6Y|(>h@ByHModBm1P?5ZK~6EZ#yb_rfI4V;n8`j^j*&_h<D4ouZ~PMvzCy
z7p>Tts|8T#h|91DA*F=}#=78Xr)eiAow~B?o%NrphP*y2dW=G$w8C}kC*@%=>-^ZJ
zu8aPIrA987ajokmTd~HKSE+-fHc$)8qBFK3nr!JECzc0>5$(%fgs4@PI(`2~ui8VP
z!Lig1(Ix`Vs-07kg5u42Gn7;KXBD>MlpQ;}abq#oH5l=8>>o9(n;a;!_s^!hRdUQ}
zmfhwp7(<#**e${+9eM++CqOa6rZo4L1Cz667CNCCg1Z;~WIJ~58Z9DWG2bzms)CtT
zo2znkj2N)XVn%<7E5M$54TCIc7R!FfE*L8;&Fivlc?Ff&>sIKj%ZGCxH?hd;k)Aa+
z^pqsryRuUd$OeqveFgx^tE&z>>0*va-0kQfrh1*k;8)!W!P!KHUdX-1xGfH=f5_E~
zK@7L=-@jkJre^l2(5f2d`<<>{Yl?!a7pCFF^^MS->ZHLS3vEgK3`Yi6EqZ?M`sqaG
zJ?#u~7`8{bUWW$Y<-4*wyJOmxx4kj#``XBoD%4p;c5#LJ)4l`}WzT8xp6~ze)r$S5
zdG;mA`trHQtHM}C5xqcjj7Dhb7C^45qMp3wlH1wOA~R;ENTmER%T<t77b~CNCdY`Y
zm8qABW^oFr^+tT-Z`;3+qq|9z8%ytQ*N``hYJ$w=<c<y&bQLSoZEQxCxsK`Z#&V~n
zKSh181karwa7$=d$;r!Kb&OW}x)G&R=|ms!#vE|3xuoU&_(MyDh*7yuiH63-58!cN
zU1y$dQ?D7}%%X{x>!W2b`;{){@s3en$?})6SyZqk6W_%g$j}G{QfW$?53|Lv(Y&q@
zuNBTqWf{84%2d75NG^r0QlvAw=P&rG82tD;tC@A^s{MA<Vh%E&T)LHfk#ORr9{-rd
zu})8(nl;gX8-4kxay92wv2W@t5O`CiA<+^~uwUfr?}ftM)VxRSST>L$ODpW`Z2)?$
zU`V#xn1Ki=Ne%CU$=jHE#%>0A(p-KeB_(q1R_IM*BPhOVAeNmN<VT+&t0uq|@8fAc
zkDFAc=JGMKTUrHsdvNx?IR2;2WY9#U$Qr5%If9_K^ycR&SOGoFX2|t>$;HL=NUoq@
z?4n3gIcXtp|DxKklW{7>um!s*Gcd9b@*d~<&=Ql3Z!(k|k|s0XVsg61LuR#%SHsrZ
zyuS9S%b~fy0rR?CI7Ig}hTQk+?&%_F?AW}CbY``B*V4;uRq(N{U~3f(f{y>nj-#$D
z-`pEk^<r)a6e`1p-E{C{P~@2%A*e?vo*ex~HB}>Cx24p<UJ77`3n@~=h+m`GSBJ@E
zqpF$7WMT|*P9&wlR+m(`l|jk<x9>*<C|&F(wlv-co6-zFMgP1lk9k{jRgWfce|;QT
z1AQ+N6}gDQ72kkuZY#y^_h~-43_eu;sp*QkQpa*+%|OR>ml2y%B&v_0y1=<bxK=lk
z8z1PrXx^$f?cety+A!A+vzga$0G-M8hOS?FzRZVoB-A~VrW9n3Dz?S9N@Kp`{zRL!
z<><=7mz#!R)ZQm5r&2w+!d=?gLh%P-DI(s*XI@`>z#L9?sTL#hpnnog5XI1@%pg?-
z<A-B-pKB>s=+`nB><53>z$@{}&pmZjh3NZ&2@d<2E2K2A{SWHkqHZI4G|rDf&O%xS
zRDkuE!_$ir_J$enP7^Gw^uEjXPjncvhT{)OwBvi=3lqWSI({-zRqX$&hb#s;>}XwP
zlY3Bjw8J#xIAS6yxY?yzlFQ;4L_+K_ZEWfBb#pHIh;?mI<$gA^M2z_F3WlL8D9jr#
zR924Aj(2_+r!-yXW^7nWx{rvmi^g!+JQ};+yeBrx#;Es@1p%z|JLdV`BVw$JC91&f
zbFXTHj+8MJ)J9@r{8x75KO4d{;#yP+cg{obU%e7Z&oc(qn@iD`6w&gVd1AVW-0jnx
zf)@XzEQdFKs;I2^!n<auFC}KNw@^Gl^z3ma#@7+3;E^_m#2quvB>UX>jd-xqH^2xO
zpP|S`xyT_gd^Z&T6)u6uJqoG=vXZA~i@#;Y9y-RpN1X2O(WnHo205q0Uy-Op`zp@y
zzAj+SiT%a>e7hh;Z4Ns+aoXT|`oIrkGM}?CghQq0>FL=P)gm*7`f+(36Y8A7mff!0
z{&#%i3QP68GT;se={Id-75EnOOl3;azRz0R5qolbJ9#MGHZ-hP37Oq8sDa)kuB?LO
zVDi`!m5(1);F&Aq@+b7?m#=AR+u8|jrOkBoe%_{TucZNYC+iGsop!zGXH;XiE+Jfj
zO-3w2p>?v?k~mx)uba({>7ASGTIx=_rD&Iu0xK<2<+EMbVykioYx$%pH}T)#PW?;(
zin{d@Yo5r4hRUaFJRRdI14cI0=)vk)<|M?^FIgyeUHl~4<cTH`YUKty&nI@WL9Lrg
z6T5Ud{wRCZtuw9yvAA1yp0@B7(WCKblvnc?r=8szqeT>K^W9~K&;;4_a}!pebW*0|
zbrv~7(AKIkv`1l2?=BL;n>waK{=$zUG<&je^v*@q(f%SMh`TMSjZC7;U&{D%J(aH@
zi4aP`hIK=w58a%}NGWY-jeN6oi{59EqsgY#BD*MEZQqXaLR-qmTmz~`Jub<isD|^b
z55gCAoU2OH5Lr?!1Dl?gt{{-sdHspH7T5C2vD|lG$ZwHb9##3_Cf;?As;#irWq8o9
zd%qG#_W*;(y7V3i&I7obF`UdLIaZ()SLTd5Jww6hD=9b&C?A$SN5yOwbj`3KIA@KG
zOc~f7uKc_a4cXm<GHGu&nRg34^(eB4v)kf|S1G4~=x3b2)bHN4a0rr%H5%KmhU?LG
zH8_h#ki-DeQju~#RT6Jgp0m~ra^tVy`RM$kb1bpdlc-w-QQr>87UsZYqY)~N1?o4P
z?tMHI9EyRFVAa`M(rDZK!(o@G7uQ<}y1#m1H<j&6+r6jO33BOK+67-z%q@V|X9~Ar
zbMed{hC&~nW|o9~o4+UTktv_5ohw;KFea)H^dCmNp}qb9T}lcSA_!rVqNK>x;m<WM
zH}S7*5W5~eX_8z$5~|~*QkU~qteST4tov*omj!PAotwj8*f6u@hc^=o71HeHDZh4Z
z{PawO6O@-oW^t&ZE-TIkv?I!2y2I3sK7+aNPo(sQEh&~{4Qwd8wpkJ{<Qi+u4i8qs
z>IMRw`FiF&Z&TJ&>Z4245@}CqX5My)6awS#xKWnWi=s`5U!UjSqU%{cVObPdw7f6Y
zM#wr1N)>A_b)ovoYD)_;>+LDoig%7Fb!fpZQ9kQl&9YSu#ob#++xm^=JnpwQb+1>h
zhq9n;?zU`mkfm6L#0}(I^hkuVyE{H=sFMhH3tMH~$u_?{)U`80DS4M#_S^^O*%XPr
zR)F-yS+PqIr8pNeu8rM~`Gk*`Msk$R+pK@u?}QNQx>tg;59ezNL<k4WyTB~`=6Xba
z0%M{pNS{1nHoo%QhD}HJ_uw~BY*EIQ0~cl!rq}}a>k`B5?Nw5bzXz^|^**Y0(T*B1
z?~0D%eio!FCi@6i8I`&Jb|^>rIT%)6R9LBfr+XzD?>}$599&9?k$zvk9^#@iKI=)n
zdIYFkyEmg=c0KZNh<YI<>IZ1U!9loKGDH)|nSk@5%&r{2TVUA<_99JVFid&%0tK50
zk8@Zm>$EQlpd2T;+TgkA@2stx&&+Yo*%}|Jtu0hGY69DlzTh3Tt~Dg0UwCbiWL8eR
zjc@5VX~!fWAQ&uqlF4JwX?SipKh&&mP695C+{Bih8@@1{MeT}OpVjMZE3#96Jc$c<
z=l)#ec=S`+6>(H$LN&vRJqpg+xbd52e3o;^_I83XK7QX&yjy8UGwM-NB)Vd|VgOy{
zOs%HB=zccsh-q@NNbC1pO?aYzgp7^$o#Uxx`D{y7B}_;CBr!r`Z@x-+U}q%_7I)bu
z!T@=fYy3JhJlvt>xlgX>*Ys@iL&x|#-|evD)1)PjBAml7gMgx7D%HV<Oh<DajW`b4
z1+jUnFbP3Odz6c-Npy@#fVk;AcO=QmA_L=d&z`_EcfUV1n3qwaq!ds^o6YF@J88_W
zkO+f&r>IZ~e6T`$elPh~HVPMx&>0fKvSj$jyXM0Z1+7<V-g$jy#&Ok%mFtput@5b4
zRKnEACJ3!dx#IEV2Wo_It{jpOsB}%zlRQuLnO2InT1HdOt1y2hT`*=vA{>5FYY%_H
z>}4HOa1poSW$9RgQ8jUl=Fb;iHTDA!9ZWkJUoRDBIkzE1NuQ3A-`Co!QZMKLYidb8
zx^>Hc(q0`yPf*R6AnSsTVwtU1b1gKXSm=K`1uVLIhn$pbusu72KzqFD%EDcZBmvMC
z><!(m(>6odMwwr;GYMVsdGyH$KMT$4=(U)#lCj2OUpaLdxfzAi;mMYEj+*zj^)jay
zd<0FL=u9$539JO92f(}<lKZ#M;*<32`lZ}IEyT8axei&cd!=gXUfivDXALFHOhn8&
ze5oAaxytSpi8myBADUg3Dn0mi%k{1PMD!dEKuEz95reGHi*v{Q_O&++7r$Dp1+PqL
zd{LJ+G|Ll@oM#Y$pu@)X=*?HQ|6-l(IB7Zce%y*h$D;RJ@Wo3)&xDV0?E;hUJzlcy
z?ihW)<aj1w|1nZB)OZeUEUDt~p1<pp%u>sm%>7}Pn=W*#aq*5)S+wFBXINN7VAXD=
zv1XoMecie+SpT|i<b1^^hqQqbaw#&ih{(bjqwEzuZnJFZgSXcz0f{(6fNsvEFY(wc
zhS&MFhMY`W^pPfZ^07q#!Dj3O6WjON2n!(Dpp=A!cOSxs@>MysZpaKJz10h{c}zU0
z74_13U4!@GPq~UWwMmQM^%)z~VQlbVL-C}JAxcUUi<0Ln0O+b~#uFE+&fDG0JA-Sj
zN*$BYkyDN5z~lFndqGwlvdJLyM(7(Iqc1u}drz=wE;5S3!aGMjEy8-SS%{wrew}Fl
z9Xs&ZXKeFwT=4XFei+5HJSZNi*E`>c5qO+*dhwxg(F;w`CAOS9cwcO-;-_&KqaKz=
zsTKPolixX}EbEQ=9dH1=6)P&Gs2B|~;*AwLf4=6m^`a{YTo^0z6X8r7DaxG@<98_W
z%S9^~7!>}aZ{)nNWPR~<TlVo>=?R{<R8Dw48%11NQ2gjm^;1%by}yK-VKtN_JwK6v
z{P}PUL|WjN6V!52!-R+09Q(@Q$4s+FRaC+)BZl{z{<vE{3~&GJ03_uyA3k%WsRuMc
z-IWIQ=%+pRdR`olcg)@0N{;8W2#Tt~F%i04*QawzuPJO@=}Wwx-E>NJD4%e0qehO;
zqNrC3{XptL3ma{%%Ea^q+*WrujgF4Cc5gp1`W3L+OhnpZnzW!Mh|`!9GPO$hb219$
zy}iJsDwU!yt_VROF;~&o&sIz8-wto=@<nb6q$la|Uy_JE?z+^@WEsqg=3T3vnqK)6
zyhgW8;Yzn>30WK`e4n!K5&dB}BZwuCa4X$cO(~~CS^|@01RZ0oS6&$YLiwTF2WE`n
zyL|4>LD{>p9`K^%N=-z#wGE@tQE6jpEO*wHaQJ~7AJ2Ty8yS8(5n$-ZF;w3W)%h*@
z;wI(LJFoa1QUKuHt?J9}Dywi&N2O+idh<_ipkJjzAD&K)*d#;NN^)~cWI_kM`oEaD
z&iX7^E(|s79pW{L;;^qo^H{it6DpiE)Mdx!t$S^aI<%Sz@;Js?hG5%G9VO77Ui_{J
zAn20vM&$B}J@|t=d8eJ~QO=o<&H@AEYuI<E-GS%TLK<Juu9iSWfb2Ro_w=6XQ4w;l
z%?il1hfq9YV*l06%6MeM3+fX0#VHRYH0-pRW-mD@ODhksJBZ$_W6jaA%5ZPckQEZ^
zyc)w}aB7Hf78fkl*|TX}V?skipLOx1SGJ@kYS-0KE~|;)NO;o(DY?FyXiiVhrkV&~
z#k-`yD&ShO6Y*54p)2^B=vw=y$%HTPPtDj_E^NRok$H2!o*DeygBFcE)7;|iVgCwO
zA7(I@8ub~ioTjUU|FoR3OrF=wH{tvOFZ1!XIB&R7jJ0hcSN21`32IyjOP%*8gbVn;
zXnTFc@YAbcZ|?_D#-!KBWYyCeAq{(5!G^6wp4V%BtKc4tZZDF$q$<fR5ppNu8iUd)
zy+G%z6aJ{auz$r{W^dTXV{INg2SJW6P0jXt*C#(SxTMGI`)cP>6^1uLW&y7(=TSDr
zR}qz<W`#LSp3gDqo!>Ynv<J4_bL9sbAt1f48yY#jsY>l4Q*}l+HU5RDZtq5h|1q0J
z8GREzcCQ9c%B$PouNzDG#OASmZxDOQNP<JeP;g7Hu55`&&Y1T+T!N4=<~O$|7ovS^
zSA>qIzl-5zY$p@aXHcE5%=bjo4GJ6Q5(M4+Z|_a!P1)<^+H)>yNP2@a$$PGKqYT-X
zMF1NwU-NXB2bNFW;7-;`$5hCovR2gPD>$mzKdyca&|1hn{r$}+z+0?}b8R`6DiJY4
zcCZpUhnJQya>gcIO2!h795PyT6ev|6bszR*kD(dZlH)iPfJ*!S*Z{T$>0L8PnM$7I
z8>m4=-d7t$a&B1yp5P~PFPcwmX9b{#8D*F*HaK8<fEP`=n@8`Y>)wEgPC=dL-w+W|
z^|@yluI=Fmna~_mz^?113ycE?=eNGWB-!9D?=I)$XkK|4O-QvCP5s9Xj@hcGigk%u
z`O#KELs10?A0n3{wD5uJ@%$DZ>Zt5T2nQ(f-Yf?bUoEMl(wdur!N99^r&gWrrSCrx
z3(@$A^y-(qP8saRQLn*Kdh+b&rEg?#OfwtY7u7nR#0Smr0eq0+37T5T7j6+W*zjHQ
zdZb?tTEVh7J!Twe9xMv9$>vZE>;$We3yypmxdU`oZgp{lD0a1XT=}@dom$$~vhqG$
z*9{*WpnFYVPkkAN<z({>^)J>_>6OO|QTsJ<@CTY%o9!>}F|cm9!%*Frd;GYgPL&aE
zRwhFzxYXb8acp61!~E`QmA7J&??`SO+%pFRkBM}jRc^^QeoUI5LnrWO)Uy!|E2K*t
z9sOiiJ_pwkg1RQT5{m-JEa}~wt*W8m%D3Vm36!2rDooz9>;4X%y3fUR*7*-xqK`BM
zQ&#geBdI$|+hmo?oPu$>h$%q$Sn!6#YcD2lMiyA<I2kkZ8CYvOgWsAXoBj+EeRy&P
zqbwr5vsnGL9@3R43WRb#k6HmQ>VNH75MO+EA`a4k2b{T%`sEJ+)Iu69DA(C8Q&5Jq
zx?<jzzd-mFn1*m0GYodwn?ISQfk=P{Tb6-?0PAblq)1EWN?FY7e25KkiR%NeWsA!I
zM(2IC^H;}K$jMKm?UBCsuHFEI@pqbglzieTBIh0tgngU-vLP;sY4jauLI3tQ&0-X$
zSD%74v2HB6IX)ji1SekO*|e|%SF#-?Gc)k8#xOrs;Z*8blqp;DpTyZJs*x0qF+}ZC
z%7_;qmW;EBx2$+Gjupz)SBDGcT^f<6$T_&GPaT<$HtG(VDN)|KJVT)m-C4_;f&8{$
z%0@#lRRfHLqvK<lyjQOaR+5vGIU3Y|bB=+Ddt(DosY@nI$=*VK(_{u=I_~>w@8+6u
ziXg1mq#$&`7R%8~C<9JsGGN{3s49v}(Ai}Idz^;JTHOq>2M|T-Xv}EAe3VrQHx)A8
z7?FiXc<I^74c!{?Gn;6;SW0tzB0}(!_3@mtxP^7t>iPi-y{<<}ytdLHc~Febzd4Nm
zwZV_D2a>1}!3WP+musuPZhJsj*}T2JJBdil`0OCYaEh8nH<Puo#gk-WC4O%MWyyDR
z@05@78Z_xpt<Ban^h)LEMn$FIOI#nqxe$&Kwk+A%IiAJ8)xPFK@PCu71p41xIu8m%
z0QEB*p|5#9lvNjn925gLlNubxA~X!|L+*?_FcQN{C)pRN3ZjPk=m8>>C!H7LlCXL{
z%B1w6qv>LKojPi74{lu}1TgZ`%>t$&BBc;6K`imJdz!R=uB&0w;=isd-6<t30I(7*
z2-{eud1&VC&(*=FVz=%{swTe?bdoXO$B)jf_a`0B3kIGC#RCUpyz8^4^$bKe3D+LX
zAzL09v51*Z^HNe#S^c(`V=eZzpGBOChEKLuStM@_S_++@P&*|}TxU>J`GJlZzB}Tl
ztn$Mcp+5Yv1rL|3SeTByUqt`8un-Z<++OBzEC!ta=tcpSlsExFa1b^H@`BFac7Hv~
zn5>~X1OBEiUt;L<PQx+WE(xib$wvRk9u^35?78)04#IhgX)eMgm=zuU*OB_|zr4qv
z{<rt|pUsq!fz#cc=u<@%TKw*Cxis6Z#P``8Tk^8)Bb^9B!vC@^XZd6hVwL2uVtcLw
zcu(4oSi9Wr|0e>S6qESM(u1H_cd5gDXq@rHb0L$eU4|55OGM)8>Rpu|Dr@k=W(P@3
zDZOzI@QmSHrF^%q+WWX{QawU43U|e2qJ<MQ5h{db2D8c+s*t62yqu}4EI9{p3afIt
z!lsI+iXx^>RrV%F7n8W5hk!eiG9Nt|`@|M;Dj2Rt19{fdL%^=Mn&!?vJF_+by}Wxr
z?E5p#TNFLPZ=jYJgWjqg2klZ*F9UQclBR)XLPeTBnJc;5ch*c>;*t?oQ?*aBb>4X_
z8*L)c@bJMEqGsP*YO<9gmyn>Ie5Ca&5tt&xq9#`R2z=Bcu+Z_dDpx@cth0aK{hjbV
zee`a7$YU?@;Y0MGntL%$U9W#^SlqM8dRHvA#<F(WR`x<da}QEvQvgC8Ew1bo3qMw9
zw7&u^^5lKNc5R}XqzL(DINPjriQs}FZqB$U{ibNFxSnv#rG8Iirr*&pa*F^VR9H+C
zE2%F(c*sN08>;i9RV*0*(NN%mP;B3Ecml#rUJ#`lG>$MzIo`|rJs^%DAT%QbqpPc{
z>Z6^j-@!Pq5eIGJnUDfj5v!jqoh0!LDb!DI3b*HtHqkB6jq%O$tfarWrdngL3>^1!
zw;aJ6%|es68U}``@Kn6$IjS2sq#^FsMw2E=D`{oMkT^3bxyojI01xrK&MXhX?QF$w
z##e_bACqthNH6K<lpgq^yJu+@9YQrjojeJ3iOSv@q|p@B&_z7nfMHY!lkxyPVqG!o
zaB*=}*GN-%_b;---ItXll04)6vBpY~m?i_Oh(kQFaR12(J>Ntzn`q+5Afw;I`h{)H
zzR-3QER@jc5`%z#Bz;E~91T+0Qx*gvrQQ2Y7kwbgt_&**NPdBY##vU-=$<ItyK8`U
zWSsMynpzIQW$5!a^Jt`lQvQG>4dlqo=XaX4Y8y3ijY>-<2Jvfq&dfIE*3;q9n+Xp~
zYOwN1qSVSLkY(^C$gkuVPwtY|@h^(D$V-Zkxy+7c3AC;CmOh*o%_I|xt=Gw>3sxI{
z=HiP5j`8c)uP>L(>emdF3?(EyHcp6emq8}jM3{Gzp0qFkqf-17$LzxWG}dtfDfG&z
zx-QXcs?}Q*l_W=t^8Nh|?=Ima^*-S7m4!yGxR2gv;><rZh1E20EB#}F>{B<R&kR@n
zPYg!`Ys(7J461ooN_mvA5AtnJ0LhQU%e%sn5=lQmi&nj_7VPX0HO>##*?l?=?_EY8
zrP!n5W!XEzAN^Al+Z}?Orr+Er#*gWtM-Rg_58s?|l$vQ5BP6J^Na9L=?0E7tw<YS%
z3p8VUk0YEo4bD6~1(LQ1)J8G5(YI^sj3Uqi8b*Wsieb?yA+pqMK}8(PVK>qfk~ben
zuN%6Qlt>btvjSA3kt@<QN5v&`%XZSzBn;JZQV%1PQbgm7EPyP&pR0k-RT_4wW3I6Z
zo9!uIFJ$Q9gDCadGMWbOoIoPr1dXX*=w$u}ovI>C!AXrGCWxv4%=MbMH=?gxSZ|Q2
zP1sWSj(A*O(zLJ*_$#81o%eVkXlX<D*xS-WYqMAS;cx=h;pI8d5uPOy3(8*?umk1G
zVRZ%>t+9{Pgl7%jl9@`pZAcucv>8cZ=|dbULLA^=c8X*{gi=uE>F9X<($dnY-&rr3
zk0xhZo^H3Fw^E-(c-HpE7+!~!ALW`Aml<LnqCAc@(yQ~wi`}b!$wt29L~A??HElQA
z`;U*_D=Ki`Bk++I%-!3dFW6`~G+}}5w|!TS>PgM|A0tjJrysHKhWX+{u}!CCQheH$
zY|_vjWt1_9$p0yhzDQ(?Lz*zVeXn+R^UIAs;hUhkiRIS3C8l-5&`9YH2<*bb1nP6i
z(MdG8kwf|W%64b5%a*HJRv79ycwLX)>HpCu{!I_g_DDRahs$9jS9<-YULoaXB2MLx
z4#%#lm=%-Nr;AaH<I%$@daX?l{u*mn*i!J@lr~}cgzR`Gx?)jK_x7gDE8qn6)O1s4
zJ>h8&T*RUCimNL$93xs^uhO8Rhd{~H#pUH&UZD`dlXf)9D2r<+XKaKlrhCrbEb-Fp
zB~h6D0me`Q8DE}Zg060G{mnj$fx}<NZ3KGLu$N;p=*!aUJd0HDTTp%z<J-h55B#*W
z%HHZOz03McjjK{qFGbG>gb%o~d7@`KLoy>WnRyYxf=E1f+gkP1MCw#y+Zj9#%1`eU
zxhhjWc#X(>r8>@s)`%MCFCvc)+z*NRG?JkG!5o1ObNcuM@Kl0E4GHGGWVMw|<gQev
zG}!)}*=QJgXKi3rwQImFF%Z&=J>}OSV6xUzU(92D-F!)F+d!CUGqe6n^q(%%AmveZ
zC|haNLKB!V6v>{T_OhsWl+b)4eaP9u$HgSq>4V`pu4)aUGDC1VEH4n*cQ+C1MFq$l
z+q5E?38kJRW(GKc6n#GmGvMOo915h!@!+mxkmrlth;OoKd1|#x6{Jw^^G}QMH==Rc
zy|GS>Kt10c?C@%-RG64;ehE!2V+S9%p$h(_=)Z(QkD7+ey1KGD5r?zNrEImokxakN
ziE)(oZ~kuY!QGTkI~hZ9TeBu75s7bUT8OHy-%v;JRG3tcaAHdqo<*MST!n={Z)e9j
z=XTXW?6sA;8-iM|Z@b2R>0pNB_`nG@mJY22+|A_jgckD)-|ZLPk)L@6Kt1mazJN#e
zz_<k6Z4-m^;tLPNUge}4B;J$~ur}PK_P#XLUIoVIS8B^eX1>oqmZmOQoRohdha=@A
z)bGBg9!AbZj613s+1~MtQfw~J`t2lMz299UBtt&W)Y-zea$)`Pc>VSAPLIQKgjGc1
zhrwUdrN6)TBP4~lqWI$L2#w+FCB+Zi*=8Hv=Rb_tmfiAbey&=m6cI&OIU_s<jb_;h
z1%_+l@ST=JZxjM(suI0pJ*pzYBd9yn5?V+kc1e+VlD*3)5d0A(m<kKBfUK%&im)b-
zbhsZ8`u&5H%a8Rkx%B{pcDEs~6MQ^^vOm(XEPJ8hd@WbUA|v(rdLX5{Ebr<~ZBzbm
zD^5v!6Ukp+5h_BdPqdfH0QUQOgkwB81?8jm`FecoTlHLzMo{JQY^x%U-RYpd{uP-#
z8rM^NRg;n99P)IlH{m|sg6~7}eJBgE!zM|sC47~+oUlu^kD{pTv(e^!m>9wLUnhBf
z19Krc<OTehr~kwGa{C^NjuF1^kvU-;hC@L2=PXV^!GE15`fo7zKe1pzRM*A0V7LS|
zNe@C_Q-#ElfZ8W*GJ^y@+8;rdQmQnLw<8;(-Ry@UO*F=%P1&~a-M!W)$HIeL$?X~g
zYwAH0%FB&6e<6tM+2-{qX$=t~xfguKlk(K#{Tb<ybBy%hZn}SD*VnuDyac&~cA?tf
z&lulAe`2!b6@|nu(G-ZOBK#er;J{=mnYgIHHj%&TUczy$z5KoHgyEXsn=&)H$|wnU
z+tg3+<#J)~oLC%1axEjX9z>;4acodk$|^f&R01-WkGccfzqg$H-nR0|Uhr4wwO7}n
z(|b#PTV0r^7O781b)Nu3LHiZ|CGn9v4^!Tf-1~w90r{eFiaE5ccNT6A+xiT1j&a@e
zcVb^-8|v_ORtdqvPDp5WHHb*`J;|(x2aHH`!u%sc=Z07C$S@RvgE0|h`@xT(SfGF9
z_}2IUm}e${=hli>J-vD79m7cEk!4`%nZ%@T>5E=tl`aJIvr|p&`u@Qe7eP?EE+dVG
zeY5!|4My;ERVmd#soghFtxNC$J7ZpAs3-{35Ow`plYMIXm3Zkr+ho-pyP44Jdn>cI
z3V$mkk6NO566t`<m#}R6>pJcfnUuk`!6B@r*@{h#KvfRodD7Qn02S01K9L<<)%L`D
z5~%O4U8z4xkBoD;mzx2~?GgmA%Uq=n?ZjJD*%Mt&b8IbP=iY;&ltx@(odoEJQvlw)
z5nR$ZTW2O$0vum53@*H>eEyw+f^Wv@=9$)IGh7|=3s=vNK_Rp)x6_~bon7l&{hx(n
zXyq9M%s5(LFh^sqA`Z+TY%WKU@Uy^notCt|l0O&}aWtUWHHT<N>`<*&O{E^2oLS{8
z|8sC9&emd?ix7zB;~YoRw&Y#@^2_VT@*jQR8nnGS%>i{1YrZ9gf+ta??Ja}evNLGf
z^ZfDMpot-K2~&icl>O_nv=q13;j|%<_P8zn?kMqyS7aige{ZV+F{LqoV!D866dr7z
z7Lf(hQGMq>6WP=fM&DOr0R_NT@@8*d>f%`P>+U_Itn2nn?jR`1S?f<Ng^D!`K_Eg+
z)`ldFEa6G-^C1QfuEg`2ZnQnf^OmjV`6JV4=-f)csiC`&z2L0wXh?%%i-=CW{fvEP
zRg9Nly+b?<3zvn?#d(Enpka^~mcTT5bTK~qAx$?dZ(ITi0R^{u>QvtrCWJQh_%v0Z
z3O4Jfr{`?Dezvd_C^Q<#rF+3O@<D1(YA%3%U#;ijVydDn53%7gq>nsMRJizq(7QU#
zPgyJZT{SELf9xdsNF%%#3>qqC7UZK?Kt3g?4oNtE>r$(ML125b{H|e-q`{li7f1Fq
zI<~V+&Bnf4npx~ia=BD-Z=?pfMgpo*g(pERjz)d}n_bin_l;w6y*A1gvWmmT!wc0c
zUHn>u*_wfjh%LSq*H77!48EBlquITs?*KiH2P|BI;zdT*p_(d0P=rJp4Iv@I;>VI_
zv(5eNJRq&=X3ca^P!ViJ$Nk{k89A-6MC`*-zA;bp<5Jjsn~QLBn_O1v;k?Bx@R<qy
zkI{>l6W@yLW}N-Wsk;zXn^{YX0u9_m2;e<QPG-?vb}j?Ki$7~LwKZ=|o3Pmc$?>E8
z7%eOI5vIn_UFB-XQh%})=TJ2<(ayQz<Le~v<Vbn#p7sy^ibjL4Nf;`W2%;3{jZ=k}
z_~0+GOGvidFZZX4;27v`oR)^QnM4;LY^Fq0R2z?>TTs|wldY=Ociu9etvzExM28J$
z_tq>v>mmQ0S5A~FRx514`P02i8=9w12%LV%-n|`fAE6Mmbp60I3I;oYCZct<5ljbT
z8Wcv>m!8fZb9JlHNkepru+s25ZnrpJ@*-sTi^VMaB5T(a;?D&4(HGNGD3|01n$nE3
z&W~qghfy2G2TN{Q>s~1X8H{;P6-^l+n_$w=PIEVhN?E-B!`fShMftY-!Ul+hASf*$
ztsq?jGN2$K-O}9+f`kJq0@Bh9-5t`>0@5YYEiEyGFw`*cUIYKNp7pG~*WUZX%NOPF
zIPeDU>pIW#SLYT&7^1iytQC)=+nplfWuB9pi!d%{)hsbYhg^8<=b#xRZdbFX|KX=;
zm-ffO<aDaU%I!2G`vr;iE5`Le@~@SfB<e2TVsae09jy}G+sm)TAHW6YX_`I4zp*?i
z2s&h!WV?R0pC^AZ!<F>lhf*$XNTyOq?oM;JO=H&^8f5vnmx)xrO{27Wjmu=2UBo$f
z@tLy2D-Er!aZF0R6-#L|UZ`qo2gxV$uV;_2>o<IM4c~4pCobedb#OI~O<x(P6GWGu
zLeKEVfc*8cA(}9S_BUmd@I{d>!0vt%GBW>^l~hKT{ABa(6)1@iKv`{1qE$BKy?>T{
zP3deqg_zCt_MU{UoeW4NVjl2_NeGsg-wM<;heg&pJH&~XTjqlz#GBfoxO5ETo5*%h
z5WR?;@hTg9kWguJXW&7N|2G(E{$ApM*=OZ`_6l9LFY(LYl?Pht&()SGy+wF8t)HH=
z`3Pyeui*R;w*RePOr@AJoNo!~KqQX0LR`xFq+)d)A+t8kKF%LSJUn=fur^}-%RPaa
zURJJ{{ddj|0>Re}C0+)$ff?;dsF7`ZKSf9E;~lg$-K7&v42A=1y5-R8M$an3@201b
ze*x7fQG*K#Yfn4|M`V8Y0oq86lQ@GlY~~f&<T5E!tyAHi&AQ1rj{4lS4zP=>68~3x
zJ8@m(LQx{P1vJc^m*(TxI_pYEZYpl31s4y`ljkFCp6qfJCR*k~s%D;bKj-HBlr&ij
zWOd8A@4)vw?+yOoJ+djTUVT*&n{1~|-0ddPn^5p$s;~}GyKK>Fy8l}~gYn~~L!QkE
za4*)w74d#x)Xn&a)&1)e=O?mLAv5!es4z2|oGWBQcp`Xmuu1K?Z2NmH2g}=t=bPy;
z{Up1Dif@=xzTa_wHD3ZD*!0pkX=ZEj+H6pB{=hEuHx61EvHF2X3}u5wakGx2z8{<u
zKHVlk7Q~eghK;1%#W1-F<_c_6-`#uPOwFPc*{2$SlLEAq4>vCrle<<rOw2Q(h5~KW
zbi$WD{>n<U|FFG6GM3>}`pY9nitdBgu-u1rZNHxLP>zzLtc}Si3Ht&03C4*>{6Vrr
z;uvRnz5FMO-GF2<56b(GJ}*>SBS+W5GCJDsl~#T(i+5?5Ue=MvK|WlPDd=eHF5?2g
z?xJIWuddVmt7Q(yV?~L|KYmz_CE&_1*+*X)wE^aaT@Wp?zs{%ek1hc|;}4erpR0i)
zMx*Gn03j1g?K*z-NqQ)dh)2YSe7BrPs024aS=7&(qq`BIeH|MA=}Tw%?;biWE%J`e
z&N6S5XQMw(C<Z5ZkX-#&J8cA_yeT!}61+68XslXBM(%g$qf&sY*Dt5C@;=aS{F2Sr
zYj7vrq@MLNW7RM@4K?vBu0ea)K);UuXa}hX#9?e+PQSl@I4-p76l$cUyd+bdr}$KX
zm)lN*a=>jEAzr<se&NtKm_3N=Smd(eS)!tqXX0FKa`CL(sMG>-no=-eJDs@Gq`g|Y
z&E{26{FXMHM^C35ihY*IOs8!KSZ7Y@v<lp(PRE@1o0@~`PK{1ZTAKCPno=dks&L(s
zrvppbZ5;U*9QG%Inz%+*@2D~5F$X^Ik#aRW^<gu8FKQwov2UbhX9s@^IsSdKF@Eb5
zvH7~`T`kvkie(9)&OcBJ*c*-(sC&xi0NJRl2>ZpT!D1+-r+U)6sL78=sewf{6P>?*
z>!|G9Pi?|YkcZB?UX2*dIdnM`MPj31;BT<Sun0{yO=T|gLb|Ej^TY~nOzAe=sedbK
zAMG=E!J9Hu+!JHawn;h{`vQOSx6hfk#JMvWD@|#~@??!;TVChfwv_v>je*<2(gz70
zgGcRMlQGAy&Yo^}uEN#bj~cP|s!HJ+&>3K!E^V`&+dQ84y;$e%v=;VX-hXr5LDuoa
zhOr_{ndt$@L+Wd$KRI3sFY`oLH!d%`mHc=R_IPtp5oKF->9|HtiQ-xaudYSSFe5#l
zIOR*>Yz*3W9SY*>b=+)5@Sg3g4=N3~_M$d;YQhY@A$q5*9gz6CdPr<NpE^5|(z@Bx
zjTz0S;VADom#EkJc|N|IXW>id0?pw9A?gE=recNt>y<MO)fNZc%_J-JG_w0UyG&;(
zslJR+sp&V41ssalp7pZY?42WbmO6Aqhiw3SFI`mT2G?$ko?2dJ(6D#E{dUHc073>;
zEk!WhyU$r69z0*CZTo_Ke!{-xu%l3jl3_l+M<AD(^P^0XU_uw3-DEwk&A<ab9!a!}
z_6Xng#P~``d;Ety&56c3K%E@nU7n*cy8YtR({;kq=GdCPn$j-`eqL-Nx@d<;>ev$3
z3+^a4n(ZVU*?J|A)q{LJimi-z&<^9fE;7^Zk)o0agLNOrL~ho;GJ`;x0e>5@6g!Ts
zYd2FeR$pVnY&RB?#ChZ;GZ3#MqTj*w&WVVx$~@2&m<>IgCiY-n<8f~q+LTCZu=A@K
zO^3%P&1t+?a1joURMrA|?O(UUM%K;*LFI8Rs#D}Zh2x!5nLC$opOCX``RvQ;yRz05
zttY{E0`nenPNdWEe+UF7=c&XEA|teV)@djxYk<JS6wbsTslINvbnjcioT6NwdIys4
zk*scLyWQm6=fcyV&9kp{Vnd{rurh=RiR<<KgeHavh-YPL!h^!PYjcc8&*0)qQ<ta<
z``Y@MEV*viK>y4@3?o6R!I?hiiN>?2ed}uSi)T-?MtC6a2%~IzMi}dKv)WKDZ;J<4
z-230YDzL-XqN!+Knh;_8+1$c5UADexbDE*I;er$t4IdvUYGHTnvl)18Hal@j$1SKS
zn5rnHBSUgL52nosFr){k>P|4|otgHWbs+voh@sL4S62VpPJ%cNo46<Lrtj@3_jL^R
zb^f$*F2VdDipCL1thLg2<bLO!Ys~RHm1dsyM0+1MEIfmy#<&eo&OE8EgXNr}Iy%<l
zPe0zONp(3<cOE_78O1KW)<zrUQkAyGLmIp?|L%J5!J^??_d_o_mfPT>xz;66?g-wf
zk5nD*cqjh9PODXvNy9hF1-p;em!9&hBZ~ic;Dr~-&phNnDz3UmRczVZ*%>OmN6)wM
zQNtlMN`ht_etY6H{`~k}U%7tNb%tc-+V_cr4p7yULf|MTNSz<WcDb$G<F@r|z(fPl
zh4wgVP%RhH+9udQ!>W1aR=*&)bY{XtP-}dp7q`reZ+wa%v-<;_F7xE8pG)qEP0<?h
z!;%V<1}#_uO<sTT*_V)b83b<OPkX~6Pd%OP9g>T`TviXpUfM8!klV(cqE}k#2TxS5
z<<cD65noc@H12BnYCRJdUpMujw|Q{JXPhEQaGT#7(#TfDM^<J}@sp^nA_+dQEoB|`
zO}l#f&r*{l_;xmqlkM`#JNuE;eJ+-IyS2%=Co!kGW-fBp{kjlQa%!~-)=W2|WgRD-
zM56niV@vYoczk>VA)i*YQkQu8+!N*Tq4JJ`Zdz|CFYZwAoHC-G2oCt33kvMuMlRTR
zK201t;=RD<5!58Vz{|F>iCsJuP?UI6AH4-4h0HxYwK<sTomX%)N^}Dg1spc`Bx+e%
zS=)|}pN^Fpl#VN<1E~6SwJi)3G@v|s;p$qYPbUn!V>6!<{B*<9MaWE2ud*g)fiI<v
zvG5>*L{47b=+d7dSYY4oGRO-!f<_vg^kU%<Ue%(z$|=#YvBtwW@}7^Yf=M}yXEW=+
z+O}KEH9N_bBC4I1Bmrgm$b~z!5-mk;$W7MoF)c7&t3gC3?z;zmz+Vy1A`O`Oc>C69
z@CSV5p>J+*3LfD~N3^vl<6VyqVCd{A!B@Eaa0dL}<zN2A&;4gM&>zQ-H?)<K($b!G
zafAV~O%ntot(dn55u>B(4pi)cok@8iaR(dc%I~ClTqGvt%>mp&?VvobKG^N^`Fc;x
zE026=!1qt+H#XsJH_=-kXK&}Sp?kws&9p|WmQ$i1r$SC&-}=Iz2Cn*pR|t$ze&Nmc
zK0h+}yC-0@2XOrM`&)SsL>@%MOBxZVNSkq%uw!WPuR6*y3Am=RcPGy8ju!$v?<j9C
zQ$9OkazGc-JH!;{3J){hb$8BxT8XK0zd#*1EfuG(^VJqeZn}W@5uZj(Ha0f*Hz#-X
zAs6JtZ!na@RYsmMZ9-ZtnozFOfA4zJnR%X5QA2;rPRy6z5*IyTXd*m)n@8<QzBZrV
zn#q>P3Ek&8KCC&SL_j#59-!i~M6ju|W)#%~k$=68f6+`%M|(?OpFF1;_1~DkdGD!_
z#>b7ZwcUUMMK(49!$o(|zAA;f?Uh6CB<TZjguvWI+~5+GNpfQ`OI7oRYT$uY&D{8m
zV%UDv{OyH#^+Z&WJ-n3$x-OFR&4s}8aE5$`S((LI?|&>@FcY9j04<WNE=FU()Lpz=
zqpWD*muokTWR0gNx+C^|I^p%J?7;`v(ryc>$j55m#`xre-Sm9p??nP=YFqdQqh}PW
zMWVSi^G|9F{V(UP8Kn*6ifXcq*DJRks1{}quKP#9P?p1}JY0y~X29e{+JONZxn2H4
zj-fH~H#PZ?e(BVypHvEvF2@=n19|5rHJ=3I+pYl!4_fU9R|!{`Q$zP~Xc;Dxh-g>}
z5vP^LWLwS4P9I8dd@>Qj!zRdkC^@PV!#(9hc-c;GC_^`uo(BVd&lGh9wNP=s%4R}6
zH91s9EX{;8(){wVX-FE4O~Ufh$^Yb3G?@D_@8LUWXI~mC5S85$sgwpxJ!s*x<<WR+
z3ST)xWc$xe(mOnb#^xy>h3bvXGXd10{z0Z5NA+)e9}8nmjJ7GS`I!KJouxfDT@V^E
zl#sYj+0Iy7LIAuvc7NNW2y`g>?kl_6@NAg){t=*vD3bG_vxzL1f6R(dYbln#>caDR
zlmk(PI?X|KT!l0W8am{;Rngb_A{=PN{MX3~)pjSS9pM~9FTmH2b^v`V9LNEShI{?l
zCK4+LYPT4sj|who=5kps2dmGqWaLxoq`U!TCm&oqtMG;>$o{5ZN{6toMaB&q^mPK!
zY513d8nlzfcy|2W^Bsc0^Z~Mj*b;g5Luo*Ix&1M68-t2+@4ctCClQ93uku&Wl>11j
zVk=O246U5g8C7Rf2q1|adJ|`sOz;hc+a}4Df6}$(=UTNqiOJ6$hg-HCmKVO}*`q)+
zc~wO280Zmxm1WJDWiq;|*HzTP%7?jVDue@~@!=0E$5LywzCiCS-mSS$n<Zu{b}l9y
zJ5{AF&}utVmT5OrFGk7mqb277XhNxpQ&d4S?2vvOMN(n>)PFjYGbe@p7SVmDDNF5!
zRj&;zaCQB)zU*3dW!t{h<!i8EV+*;Z-?AC{wsURD?X18=>y-?Qe`|Ky|0V#zyjPu7
zG;-WH@E<%iY&cAKOw+D4pzT&|Mf?R}PK8AjLv}qut7d@7PT6j<+QNGD6i2QzN4YFz
zI5_t$IZE=k(j%PWW(nC)IV`rx_#dnlTlbWmfEyVM%YkcKMf*#8Nc!U;zx_uZyEYRV
ze}&i^Q2gu--gj1}dmZ;I1)6-$%S}%Fr}n&U=k&w*NH1_^=S9OQJDiE<sD#jb+VsX8
z?vmpm!R~35^VVDy`M7@b`<kd88LXlenuU?@WIJiReTJUafT4X~!Y9a9hu<H1%jZen
zt=O;<LS}qv$Xs9XC6+bX-Y7NTj9pZ@P<ZVZnyTa1Juc~VwASN@BE9Es;K0?4^2R$4
zpl%f}l;zZ`dq8vcmo%OeCu_=F%dg+y4Ce+xA$P&dsc^=zpRytGm}sR&TurmU5%=cY
zEt*&pxbK+v+r$<7*>JJ%J9&dsog0I98a&!hTpM)^w%=A}Dj5AXlB!o(B`h*PJyt&w
z`Fy@eJ(9nouB<a}2i1ly$;Zpf`V=`IuINl06R(xYTt7N5ojQB@?j>S9JwRirBT>^(
zwBXL2`n@g|<azZWKd<3iyTAeq^&q$5WK~+k>RN@PD9KTIw|QI{O}+9?2M~lk^PWp`
zE&5@7A<mxq;bl*Oi(A0-o(D=U5lJS>d>#;rsNwg<49|Cq4DUs`t3n5Y`xiY26u7>9
zI$!E^nmOc79irb{sTDPUoYC$-2sqY<I@JP;8@nD$sFMZ4krDGKD%g*9qtZR|sHgi0
zTBQYK^sjxny~dd7fe7&C$W|oY0ED-|;E9=8x%a;*|9-*EtVcc7<iZ!rPv`%<xnpfN
z9Aj@e;r}Z_vrqJUrgNd~ivl}r)o;7y2&}UwIX2d#+4@WjlujgEawf~fhyYQ@K;C`6
zqp$=-a%lR9M(P2UMRu|#r%D}mqJ>^SEuwvLATb3VtM7BO)1c|MGhxCE^L({GZ|5Ix
z+ilc*8U$%or9Cz{Fd(OwD!JZxDkh+o@rGh=YsUW-O-|{wS0YM~Z)FqwIAae|6TM))
zs4<JYO?Vtdqt9FxzQI;etvr0wTh2|tGj78|`y#1<JL9|s;@_jJF4>rRsLq6-A9fL!
zsEh`9Zx5vxXS#m9Y5Ld$l4{GmwDmtm4<NQpeeR&&^TJ>HBk_<cgbj;wq(w12Ax<++
zYP8+c?5rFwrpZd8*ddD}ydYRy7WC?oMiY%XjSRv{IGa<?1U44myf(n0u+v7!_^5ra
zlArRx<IARoFVB!pmklhA=GwX=d~n8dp%Y_Yz9m&B))9poNIT>`d3j*0mO)jda#64O
z5;6y^?yb6*^d_<IjO<=pRbS=ymwHtu4~@;HZwtKEg5Zf2vPJbv2kkGOxMU5UjJP7~
zDI|-m8fuQ{k%KTmSk{7O$rtFHCV>Yo;@+Ov3w>ru>o4lgox?zX$fqiJiF11pniENv
zb8GlZMnL}5RKU!NJ(D^VX*yvt$y`0BDOAYzI8VDMzaKR}U6@Gy5=)kdQEcBV#G*+z
z77vK6fK<fbV4BU+z<FWJhbMTq2O+<)@6=5uulM|oHhcW&+G~pTm|ko0BjXs;&5`;L
z<7AJB{<5r-8N6*Xh6=_-@*=<EkhK{}{8XNmoH}AX_~~Q*!y|y@IFV5*Q`_Yiw|u5<
zHJ8CN6AoV>M4Db7Sb1|v-bQdujo(fZ^rl#SU*nX7U&vo%tHQ=<Ttqs+uQs`4k){!E
z7L`*Sy8^Xrpct@Qt-cczm@abas*!>;)V1rb>CX<7!Obc<QIM(XH#)6jDb8Zyu?RbN
zhs8B9OzBm5+<P~y@x|!yal{?zQS*&+MLqYM^oMneIgT$Q1;cG$SgCFAe_2sc8=J!=
z>#Y&zzxw@{-|Qnavbc`?`FwovX_Q;}m;FIy{x!*MxY2KM30YF+M`@U<TOeEo`kaaW
zCvI#F#}9|Uaq!aSbD@C*9_**FW<)n_BCi`6@Xs53a~ykg;i)3{a*A`TaNG}92Jv+I
zM`(@X7>kX(q~VAIyp-Vkn1gWXJT|2@>Jd2#nT7XVt=syTb*1C5hKtJs3$k*wWK;{Q
zGo>gyX296VoycJ&Qe}J%pEsWiNmgT;#lSSiVJxKSun@JG#VBzI3XiMUS^E<{EkBn6
zb*kQXBZ2oIz4ls)UoGVvV2yjfkN7H-Dk(UctFxhN&*R{zIJ+7xby1u+NdquT(ay~a
zUg38h7b(cS-J3R!h~iX=)XXPHn|FIF%jf1U3TBg$;e)O4*WAZ5&w7fi-SLQr1RNEh
z`r|w9w?io%7W#3=MIa{XogDVR&&4up`{T)emoLR{VQoDls9ve5K*0tOGhN<Ci>F2V
zPDtWD49uOR&R$fUc{6iHLp*5NkCUjhIb~M_h1)|eyKV3}9nm`whJ^l5j=f4MP<CZa
z*&HHRvL)Dko+R<|BQTkQe|_ocl*jfNkcfa&A1VyY+XWZGzxdt1%;#Su_7N{@Iw#hW
z`@|40r$N3{uR{53LXd!-7Dw%NoZ=y5A{-r4`UD`uk2o~!&gtAJ2U*Kfs`ha*h{KJJ
zGQ1LyW(PDoiq9T5Kf1rf1^&-|DnQTU=1inkRNQyJs&a)tMt5zFbB|3V`z$^bUD%S_
zx2InJds}1HN%Y3`eHd5wAY%mlZ^+%v6UKquk43Gk9Nw580#<72#+r@_p}>B<@*0^|
zbaR{FnXOKB&$Ew+LecDvCafWY8DF7wsgc92NS#1PanoLocS*>0sq#S6J6y_UV~1fO
z|2L>q=viR(r|I)mNMMs<UWIj;=-c*<L^yO{4Q6R{zYhpXE%p14T-?COl~JoxMNOPN
z{B66zKBeyCpGtz5y=8^R*4tEkJfapRkBalv<K}YiteR|vhWwOXXNsdWMi+<}KA~VM
z6N7Hcq?dTZWF9L|^_zBcOeQy!9=|GW{;<Sh;OOzy*g5sxVeX%L=W465_@;~2dbS;u
zDq^-*cYp`&lr%&q8}w0Q<X<y-O;BC;tl);f%8ZS!t%F!L!N#J&HUfRWj(G+gi#(6i
z+IzHQO`$x9=dYPs9$|FhB6O|>J>u@%mjfXd44_XRnvvJjj2mYs9ndGI(KOHb(Kquz
zs(Js`ee5^<dY!BtZrw#s_^nP;$8?VdM_yEktGz}O^Db_6+J(v=uT6==H!eciHlU;<
z)}6@d=T-CcaE|4u_uO{F9`>f9uK1)yg*8hvO0?)__HZO`qZjKpIixi#{CW~WVQBi)
zmvSxF5n6Yjcyl<5Jf}2Kyp~_B)uN~?K%%~o-{GT!P{B?n7xF&AZ<T78(Zz6OjQ2(D
zUu&uDr3G92%4p2rrIg|Z7L@phlAOLE31D{P;_=&!2i5s5T>&IRb{${>{%gF^+UstX
zb$@zMRZ-MG=nrc((p&}B>L(ClDYLWbyuj90_HMcl9`n`AjopM-qrj~yr_PN%mnU@H
zi-v0hDra0FP~>Hzmdf4(<vVo;kMaEC&f}>b%Zpm=JRrIV1nKg59DC_NBL|mcX@zCq
zEmw%~jjrGp^MopPb>a9;_3M7A^6~N_eW6#ptAOFLlNe3Q6+6pKLS6|^`11vogo;AF
z(c3%B)?J*5@6<&Hg(i7W_d%1_I&A5O9BNMeiZpwR;WDn;UTEzqwMpYZC8k>Kahdka
zsa19AQ_0z|Mm>uQ^JH0;TZ|yu9k9A7W5L}ey0src)ZOB0e<FHz?&;~_{0~}A&GJ~-
zh@HW!9DCfrgPgqGN8%+rjnBRR3erch*8a4UJeU;!6DrN}f<0u^dF^@C7D9h#a_;8E
zchx`mn(2sI)c1XjS}=emOXhS1A2l8F7n!Z=n5c+G9qy<gX}T-z)Fm;onp6Y1KOEjo
z$n?~@5d>5)1PD5Adb4|WOi|TmWSr%O8lrY6w}UFdQ(I>gmO84#n?;HI5-uUHl6Sqs
zL8e8UFFtw^%_h!(JjJ@JW){U*W5GTht~@0(+dP@-7oB;c@qeZIz#Y~Tis!@n9ICW^
zv@WLVM?k#y#tP3Dm0uF83QxrDJa4j{B01zPDDj+jcE2VLTupi9<<$5@j%1T0Jc+90
zgR$;h0oVftqD=-s#I2S_?=V{J!c(A-3Ge;fv2pj^RIC;D+j<NkeQrSl<C0WNHghyJ
zM)FBctG@_ec~6;iBiRmw@&m)+remA#A+gJ>D3*pshb7M^+D1?BOYKJTP-(%#9|@es
zO*8&3GPqZCm$CxGzEW869rZmgIqtQp(xMtOk{jM5n>F1;$U!}_o8l1lIE5<dM36CL
z;Eb;`Y@Er0r~C}LnzbRy40RnzmHG8D@Bk7Haa9Pxi^R|ooK@vPHjK3^p6NoQw70H?
zbh96LI79*qQa_QGG_rJ4AcS5YS%6>;P@)+T=tV9>h{$X?;6F~(S*4$$dQl`ZPJEEQ
z^LeJ!#Fpzu%yH-ipr#>zehIAA%8+b(8@Zu869sBZCBrT~E>_#=P6w)`^6^mp!F9H|
zR7~PJoADASfIdA1=+o}r+Z%){y^9HH??2m<ULhK4Urk9kljVPM9QC!m`^rsUlWCXH
z{s9JRTHn@v$R+B7R-$A46MHP76^Yg+p{p06@=z^+udY5>Nu4Pi_8Y4tnCbg8<3;aU
zJ8Ks;=*Ask<Apn`NO$j&>!YJ%xkAJ&19^Cu;c&g%u2rpaY0^wD28~I4K4%XoR91WS
z*_+RImX2#hZt@&CRTiF)Pi6P!#f>CqEvz3`AHE+?vbKl2m&M5U)ODSzbw2KEVp0fY
zVeL#ipXMpl6C8NB5#f#>J}S95ksWf-GBs>Axna|woN;jVl=-+$1_!sN@Dm7z@hY)C
zDBW!_WIlb@Uo9r4_f-=wjV-U*&tGY7<f9~1gxb=F2nc$r!l(GJxjLnOQ8V!1N%?H>
zV|pqkK!-Y-`)_2xyXrjIce2j)t}VF>Bs))$$(9!Uk12N?9{J~>h~B(z2p_)x{K60q
z;aw3h8Uy)p3puJSVDzTO?~+0FeM;sdl;^Sad}%^;|NPl!l`AwPi~R={lH+;1;Hzui
z#QE`x(>r2Og8@NzI&Qtx`$~hGxYBy_slbxBS&YPW>(n|f^?)W@&1wI>w?UarLCdE^
zaF$3~E^ab&rYvr6We#|Xlhru8dUJACQKj8xsRJuTxh2Oh(a-Uvzq+LPZ2hz}zfs!F
zo}Oiy*@$M_h6O(&zv5)I`ks7(nPI=sYaWcKfW$e9UFzvVxg)W=U*3W*%VyE|DqUAe
zdycwz$Q`8P9J@2<8;f&Ez)Hycld0MtaeXrPS()N@2g;7vyg@G|7zrg`z#B$5hv@~2
z$pzXuZ!d>Q8kh7zjvs{&Ty7c~Q^97GU(pbHs{ySQ)vQB}mm9ZHO0#>1BqEnxUxqyu
zE8;4)T{-f$XZXQ&c`8q7E#Y7DM5Tuw=W50@AoLU_0Tt1J+7G?QV=N@7+u|_(tiC01
zxMRuEl26Y;aYVxCvi>$GkA8;j2y?w0ZT8M;e%tYwn?fAg$l<$SY3>*U(tKnPsDL#k
z(yc(63y`CN_;x^&@#Yl>-s8DUg^$v!b;bl5j357U^BBE*_W(Gk$8GX{?xGKvEaaRi
z8uII7e*WW-##50-e-dq18&aUS&fxKtx%GMG{|-rmmM$nxZsEz~mmfBVyuWHWb5pi0
zUnr2%X85)C0mCoIq@wX*zN_2>=roCsu&XHgj0cx++`r_3k4kS?61aLiTQS&9kFaxT
zwlO~^Rxt>i`L{0f^XJ$~ko|4v&&`@>^rTDj(^PS8opeV>!f0R09_P_N;o24VgsM?f
zC}{!W1i3ZaY9kRv$)kLA#LMwvYM=LEf~*NukP~wL^3*vJpPv?gg<N7#WNa$zpHGQA
z_`_Vi`@9*#RN0u#z80AwJ)A0ER=x+ZF6d?f{O8rZLu5V0Qb$;4k7&fttWei|M2v@e
zSCNP4LI>{f+y2HAwHMe7lI|zJgQ=hYT=C$MLEgFM>e*O-O&b89GLwb^t)9gr^J-l0
z`7`0PBbcdU1bCroM`_V9anBekUyd3^x@`{n^+D^}zF2&@HI<5?Z>ee~JhWz0jme^L
zc^-N1{nONhpj4@HRaJCW@~1$U!lm58QYQF-fL3EoDieqL#<??I@`GqgtkDghm?mJm
zSSg2G^JzrrV*~5qi3YEl)=-#jeb)SR?Use)9cpkC3Z)!1m?SW%ItSvf2Pg*+#Ar-M
z!nnAFS-vT^NM{qO#lt&}xbj?G8S@AZ^UA3#|DG8Ba9^;eC+i7;zgBUsR8OC#(-s3^
z@HCevQ+tsPMHVEpo5ubVD*i`wIQ+Sqp}6bK>VmiAdedv6u>AE9{=$bXKzH&HL#SW*
z%|_qA7kzkt-$*<x?ICxVlXLkOJHpzln+8DHC~=;Nx@PjG7H{1I<z8RNu@1|%D%%br
zAYeLKY@0UyrZXFl^NBrMZun7TzS9;d&FLx|IzoczeS3hn43&BZRA98&K;B-M-}+E_
zRL`O4u15VTgh@+t`*rSRkVHkOdxyCOlHHDwjq^&Nv5d}E*xt|owh+m+#fm<8&_->A
zEZ5dqXGOUHLDMIH+Q3nzi)0^*kn4|te4iR5NE+6e>6Sm|X1J_ye?kRlK(vvl=SX!}
zPNc;2!gV|#^mJwB7LKG<LCsDYZ2_o0ZA`=mhi9y=5=Kw_JDIgcUg>w%hOpqL)3lM5
zU)~yage$3XN=pBa0*gDBCvADj;l(;VTYN%7>qO!FuuV`*pY>SC9}q~i8^vEo$MPsU
zJA0ziDoXzqe6c<F_0b>pCpu*m!wwIIZ5qJ_fr!gPn&D@W7^~GBnH$QK@ebXgOGs4y
zHnq0c?|^PH4hz>um1BWunV#$aUM_+3{c5>HM#eqMxBxBoSfrt;e---^3C$buhKqnM
zAc6$tn3&wd^CEsvOm+up7!)D2?dkEwq5$dhIhI60L>|{)Rgv_noWq*)bIoEa9&RAS
zjr?EyUH0xS;-w_`kbiV1W8aX2?$BABw$e2qbZwIXUOI*~db%;j{)YD?q}boxqf}@s
z3v`(r?SN{^dwVlwTNx#oi*(7Oxzl`vm%!4eAWP2knhQw<4^GeTE^3((HLg^hJ$;a3
zRUj59^i|36nzxSds#CA94h`*xFMQA{t+$IwAsOx3AR_>tROEi^`Q(sLwV1Hy+072G
zjCTv@;0j<(jDq#PAWMh<u4ZTp$GhE^;SVh_gf>)~MQ%6z^f&x^sjSVI!sERGS7aJP
zCWNM2M9lemcJQi~Vvq>s$*|ZI(!(~w%M9q2jBiPp`%Gnt@&Hv+q-P($u{;~g{jy`V
zyID8zCP^q>)J~0A^4=2zTH4Wut>I#A8T(El`}NEnwcI&T|72vUSVm&^8bi~J6$E2c
zbT@hrqP;e5M?_40^=@MT`I5sOc;te<7-)Pq*Ogj6q0LjLb&)?jQ>*4oF{Ej+pM+#D
zm+uL2GoosvyD%`PLcQ!>NV<VMontlu7I(oM9!U@<pQt=t!0`85h-DFeOYS|RA=_2Q
zCLlTW0apwe5*H~*=qbouFxP&!u}CBT$OMpM%rl_xC4TVFW58fEo8$tsMyy+oCF6za
zoJ0~`v5$%LT}@^D1NfwdtVZZ3VRG@4X#;;W)!&blv{KMHw_RPvWZgk%$vaMWW`!xV
zwhW?m&0M9EdYz$X)$Eg|?Z|^yB)gqE_1zMeG>nOi>BlW}RQhISLA|~0T~yra-RLTw
zqKwunfmLigx=b6HTVQ#Hq?^ERlMTJszBqeq(kPhK*B9TlTjhypPAgMrtkYK3i+q%*
z8$e0?2JhtOh>-%eNMSr4M<H&4D>78@2KU2z1k&|XmO;s%#+Pl-uB(buvV(<@2vVay
zMX^c=M}Ck-l@wb1Pj`FP5285yJ^`sW`b=QJ2DHlA0!eAMW!`vQ6}}!^*!g5q(Ra_i
zg%pVzw6Goh@lR{|pJxr6XzqK7e8|KZ<`KUi#m~!==GV3{rdC?=sd>8F1(DC+Aoc3q
zLN8CAvJrM>eKF<sAZHBHe}uo0_wDuL&5n?O+#ZxvQdI&@_rG*{MAIQw@axfO6vcxu
z7_P-(MqQO`X^q9JB&65=%)C1!4C<pb?l(5(rU&sL5y)pg(Sp>yt2)z6xgPEAA3iBM
znG;sX`pIo`LG-Vf($a}o#|sr2JZrBrXi`bD#Kz8$D-2PG7%l;N__#F!nfV8BqW-Hr
zIF+Vk1h=VhU=`V}0bKM1L?R<O7K*sE)fJebLJuvif@n>P6ir{5`c$bDZ%UwhUCvA_
zQhlT-cEdxs;1P&oY=5s^+7saa+s0a%?{-BB>C_t$nfw?Yw2SdJ*MX~$g?Dh852wG7
zPbQ%f=9w!Q<yI$Sm5&O|yZ*=iDKfWYMn&lnHR;oqy2+)!zeqju_lb9MlQ;GU%Cw*g
zLT?{WGxiVwe-Y?j7#ToKt#cGzC0l0HBA{O~H0NR|WO#-?4%97Kc%QZiMhb(^l=8$e
znIUSnKNHROCYnnm;2bc9wexCkKP<ItnWsh=H|tVzRV^ZBBu=pi_ti5BvM6F!OaLF6
z^-)-g=3N~DD6+@BpG`j$T|UP_?ZA*lXKlq4V}iw1*<X(o%M}c=2z~O&l<UAVxdlYv
z76!W@IeB@4jm`N#3QaFCjh<^TJsv$LDNHF{9E|k;WcKh^X_y5o1qJ2TD$~2D$T6;`
z$TUrh7dNO}n}kB4jD^b`eX;%975g*mqZ0d{fRGTl(~0QFv1qFKpQ;d+DVw;Hf@xFm
zW1#d7;Xyu>NQ=bfLe3;?5*b&BDl8xT1x8C%W%cj~*B&*DOp}$oUCnErw-Xx)WOR2X
z_tFO9xC|ANOFd2e>X#v2NnRNq|Fl@QyCb`xOjN6!Ph6c0fVHN!E=@3`AJkRG(U^uN
zSQA=x$mtNEjHFq=IdWd%(De52#05IL7S?@Eq9X!C$;Llm*f^j`hdh5?zWZHpWE6RD
zmp|f<ui*Xu6xW{jcx8nI3CM!|m6XYdz&lA$g{1nVDaIb<|5>$MUd|m79&Um<Mf{t#
z0K{!_^6~kVX*TDM-&Ib3%*NK9BcFJnVol1S|D#Uot<hxAXuS7Qy#A)$Qb%at<rum$
z&|}P?uRqLnZ>aUEvx(+`r3g9=H#S7(zGupqz8V_9UGU#`J+*g>Jk_ICJc@%26>0q_
za$e6-je-`Pnx?+t`Q}k2FHw6{p`#<NkS-U-qoX`ja)s2rp@z#$S_#<~X|oX31bUu(
zmQvx*-gfHVpqSD#*R0^?D0jGvVEp?ok=mrbHq~~#qP!N8##7r5Bn!5K(-Bbh<gX$;
z%!yb~q6pTjOPfJAtmAj#gdsZy=!0(pH!JyvSKkc+%Kn(SBw{=uzPY+(olbk4psf~f
z%uJqe*WcV2xNmsO4Wdlt(@-*Em`|=ISu6ic%uAOt8BeWDwN$xefr4~$(opClgUbPU
zDDv()jYQF$0|xu`W&&|$EXJwl>N0#R>dQPpczav>;q^`~k=Ja`(r(<PVHuv20=nB0
z3<QfIwx7_?<^7hR!WlhDUX6g?!_~Hts^2JEwr8;V2??)SQx?#ghRFQRxN&d(;pt%B
z3Jk|K&-(iqQPn%E5`p1(E%Hqd;ryj&5U^I2&U31M2IC5mFJ;PTV7Xj0c5qOsFXy(>
zLkyN25eYcVjo5s4*3{7O2g@Fd44U;z(_gs2r}!FxWB+xHeKHWWMpK@6eKl^!nE`Sd
zPx-@t1Jm@uxOM2D?r<yow~_;fdhuX-wlQAQA1)J*j&G$o=p^vg2Qo}Yzw%ZTwA>m5
zdZ<)(7^TrlmO;bKpA})WmidQ-<@4UZJ+#IxSqu5QMTF0<o4?J=i}^omiEaUD5J;BA
zV*O1^mk?ZgONcJcu=DoAj|eiH^}b*^xwP0pzp0UOr!{&1mawfUUqdLiF*MmcO>H&^
zM0g#W3gG3tnXdAe8cJdEcQ9b7@P6VSCC@}0ekr&onT#c+L$;+f1m5tMzUZQ}qN)J?
zU}M>*+S*O|UrHDtu-M4(O<3_8EC3|CP(2Ig#NeKH_$E>FTzG(TN5?*Cq|rB%f+V~}
zpwF){<L9T-)&*q6zw3rRwBRc*EMZ`x`!ETB{SZFByd6J3>vnN|al5-vBrUdZXo~oS
zml*XI`o!s>;n5&#lOe6x&-TpZOud&)MVEM*$n8%+Lxmo>ByC(VP`+Fsz>s!N-qlR7
z;}+7%O0oyC{>WzRxkL@YRWa5C<@3X7nyC%?txGq)iGFGOK%`)#HSb8A;nxcy^DJAv
z?xJ#ue@c2rb~<41s*TJ&A8J#8TJ);A<DF~3Xo0k-zj<{=df9ay*;_*#R#d*ST6A^A
z;K#V9Rddr0YwD{>vOd3U%UqW0fEn{-lP0Pe0Z~UYD*~d`TO#joV&SLt1H||kjH#c2
zLvTZkA&-ubRbtPLd?+3WRg#v5=>E_oJojt9@l$-FuY85wEbxyTP(Qx302`)sscM7d
zt6T!P|3l79av6LBtXG+92j8?)a+h?f$PH#tFKzX+<Miyrd@W#V(=!vjUhqxbR69yo
zPc_x#T-y1(XR2)K>gMa2tPO`8RF`XWyNP(4Jy;G(X}~LFC(68TsyY@Kz8@o79}TSa
z5s<X}w!T|_Q%3T_cgd;5^%@lkjCjV<j!sldz{4Gad+Vk7zbihvjkjLh8Ov}=HRbmn
zEweQfn)>?IffBzGu7s>LHM2gVfDwAYLvtmPR*K9l5;d-CIgB|yR0g@=N^pwJ*>bkJ
z0jfDT^Qm2NMNPyEsf&SL?$mQ`h{i>TxAX_L0ydos?ka02W{$~l-fIIf&C;5FG$EyV
zVSrYH>>J%=f&N3vaAwC=2r}1fp6$6L@_6w-nz&<Qnjk0lJ|22IaZwq(QK@ECRaNsR
zAo<|HxE$auCSYMKIuik%snQ))z7jZDsL{XVw<{z{-7NZ%M(=5OBv!M(9b@TI>$JmC
z>*lypQzIT}xZ4tPjYBxrA&+VY$gvTxUG_?UqEP$ajGllEROuD&oBp-M+l`#~M`zbc
z4Olz3^%9-n2wZpJ{G>PEwa*C^P!p5>Kkh1KJOK`GQL>hDj<Z|T-<}}<i<w(FSGDdC
zj&if1ujR<~wi>lMM1~5KEVPu`iFa=@PB5YV2!__|%!h!r4q$hdv%~)=Hqrb4U2O7_
z-5Ne~>fD@3<?4TvKzJ&KJKPYpp_pH{^ZbDHC{2N_G-&G7esg$((xKH>`_v?+f@8k5
zqx5OGJkGZxpV3v0Mb-jE0+C7zfw_hoNM)Jo#R&C7lpWm8^85A_k@{f4eRz&=?u(87
zL5l_NC);NC4xDBepken?L(jH^Hlvml59Vhy$MXk9MO*`2EDs!(*raHP%$Vm=XX8$U
z4JxMPAp_IQfE$U`99u*k&3A^@c;}2Sv%Eh{*)jBy#nnF899j`~KRFZjtWTB`K}lIo
zd)~}F2b<J7ilvj}UW(MurG6Wet>o=?Z3liCgo<@kRMhL*1=<;>agk%g1Np`=%G{Kk
zj0!U^`V#y^---c(@U$HM#H}B|V%B??LjWyPp+0c+M(b3{-T9eSxufy&CK<Kjpq6SE
zUweB@Q5Z~2HeXrIm>AWOhu&UQ5j`FaZsvE~s3!dQEcAH-s*};dRXxsMrV9{x@zm{R
zh~}Ynijk>~e%mYgisRX_(*qj6y7#iuRcuB$r1~1u*?oHz@g;!0bcB6zs2ZfZg{;}j
z_}{8my3M-2=oloy8`dZ7*AW7aXDhfeE&h*d6`SnV{i$nd61^@2@=}8@#VhBrJ{zaJ
zuXaYU>e7j_hd*1a@vEJ3LTBfuw+8bc8>IRn%d#$JBnn)T&L;axIBG9YVNve2^QT%r
zQ7$C$X6XZQss*Vn*-t{Y`B~{rngHc@z@H1M_bV9Cpk~!?N{!kS4i^ZZ8ed36a{#UN
z=LwF3QK0S~DX0n#^qB7hX%f95%pFd3Yn)*U7;4S?TvqRODDy)Vb@|S{Tw7TuWF35k
zPKGmAG3Qp4U1_z*n=yF&&w;9?7N}ZqpZ=q2VLOuTs+rCHTGH>5$^I|^(VjPyqn>&o
zg{eE8mE5VMx-q0M04<~1e4-ES@z=Zn+~!n(-JR~Z;n;juWjQ2EXz=QtnC#E`A+IWZ
z)i->O3c5P$2i<B9MW-({0cSHRheO^;urZ6bfGW+N$nj=+CFQ^LJif+H$Up(+odR4j
zpav3$vsLAh3lcVW#f=9>P?*Nd>{aqZ7Fz14u8+v+e}c(H6os&P(LsMYSn%|E$|rGN
z<_UP3g)~gPeKqS}&o)ty_PbzwmBrH0ny)Zv{;5)GS8k~PY|RgY6s>Amntpdu?FGpX
z?$*qr+UMKEJ;j8}vd^44m}lzOHpxIC?BtpGte+Kn+sjTL$Yy?X)?!=IFN(BH_I!&h
z39S%}<xSNYD=$^#Hl-81SN-KL6dwdJ0nCtvLdV*MGb7-u7LoWQSpM|`qV?WIFj+>I
zZQ9N><dE-%MOdmoxeZt{_qxi+EXw)=p-H1-b$SoA=*_CuCyBgORZoD<e3Ub!`<MBi
z^?Y~X9S0q?tSc3xb9}s*Kjg&NVu@7iuMp*ai`;gXz~29(w&k1++QYAU<g?LANme#a
zEa1l)+2>(;?^UKVLCBN1jPgVM@2{Jv$^~QbL<I(2wxX?|Zj^>$bi%k<R3D$xIIr^n
zS|0Qzm4>TcA3xS`beUp!w){QxJC;8zM<K=yI<;Jwu6LHp85_!TKimRvGA`)=#fpI<
zORh9!hbN-Wkv5;&BJtZE$$+-mQWT*yYV5osm-#Exz4)hdzB{PbJst?vecLvu=z8X8
zGo?emNi<|)ATfD-=hK}k@92<o=r6ye|Bd9u>3=7AasPM8%jUOkVf}%o)J#!!fqkzd
zphTP2s$|{SX~(KzSvV36`CkPu(*FovD98U(@Pfp-KzVI<wh<JyjMjKtzY8nhD&1?3
zi$W&$3&xnqLLj&`Cf&bXcs34&ItR`@N7tUjy>80g=2DZG|1OBAHE3R<<+XpKpkz2d
zUY~N7TB-)0(+{@!c!RD^5B&p;6!ALjlT%F0f1CT??56*9a5IzS7QHU_0KV6C`sBg6
zLRu^1^IuH5J}YKFb`ZJKEdPz-=Aki_ta`Yy0#~}-vfXP5-w<o>=6@4lF|z7*z$>-4
zm98&go@CbFom;3=|8s~za1tFDMO#l8k^g^ouQ`)Z4lObhTx&#qz$YA1xo=5ugXKN&
zx&K?Yshm;WyYB|NP1^8j>`GD4ZjQW<%>h=#P4Yi?*?7@2SS3c6+CbliQuU49@tcU2
zyD!r5c~5}Z@Y=r+ggXdEfFOJ#f2^a)U08Is_0j}!yBaHmBGA(45?Z?ILus)kM`ST+
zB4IKd{!IfvT%1E9tk4-qwlBp^ZdS+QWf=Stx)oP`TKfzn9F5uw-+=MGlJNKkGea*i
z*btN0&Xp0(kSphg*xGS+WKK%_6y^2B@xe?B_zE-Y)$2(>FSTK=P}AU=qScnZYRPq9
z{`9)EDOWs?gq2l?gr%3v<pz8uw?Pxlapl}rAE>8Dgab+G8>|8>X+iAIe*w*87y3F@
z(V)?@3RmgD)*MYD<*`*Sets~~7=nogvNMnEsXZTIH8K((-jGD?fyqJn*0&T0fgt_~
zDkfESjkN^E?*}!li<;ecOeUD>dvCs43ipX~p6<i4ni@lkRG*ovQM64ip?<e52IBNC
z;<(+g+`-P6<8OU31~Sqb2^&o{?c_vem!ps__~`<h(w&XP;stCSa+UYFCekxn40Ct0
z@!izKj4|mcDbh&vKHhz-8K`X1SgV+iA*wmH6dXQkc)I0uplGK7PSVT99e@AXya(!=
z9I`(TZtwc{<(ZWRe8y2uw*WdRQM5vf<?b*U`B-}Ait-PoAg^MqOxfKEuNqGo|Bh;X
z_`R6iK1Dsvog61UB1nf<Vc#va(`)nmlbYq?W2cXGQxA=Fe7Q<l0lql&<e%h=eYqRS
z^5c6wdrM&FdJ#IA1}8&50@@!Z7-R>EJS0rB#6jh`k}uBXR_RC(7y<>qHp}aB2AT_j
z<>|i~j+jg$TOPk`KXqq$)IH)Sz?o64qm_2+7DU4I3)0xWlgG|<wTiv6ZV-}OC02hT
zm&UGcWTfz#E!8)PK%qvy1`81Mycb}rg+roXNU=)Jy{?Y?><wHuMxNyav}m=2VDNid
zP9MC45T|~AfL;J4`7LednBcpC10+k0>DBLLOo_>;K76!HunimMA9k^C2Lm%w*;4XA
z3&vJV2v0XRyq#BiM9!0%T=Ylmt3EL$PI|xlw>)+q7XKWk$%ly_l@fWoCoqicBd#r{
z6=;@fA{UYhrb*krmQq(q!qh5iCy&S_a=BcqiiUYA^C6h^MmB?Uam&toO*);-2r4zi
zBr<W4ED9Ol5dQ4VXrl<stsa+3J~Ef)g|sVJ5hB$kns!t+aj4!0@Ul~(Ad;#Fu1Sjf
zE>W?O(~2djL72>sKnOZr!aa1{+HJQ4g4+lJjL@SYAyEoM`?qMT0x~fjB|F?Z>5zE$
z_m*HPO|5%PKryZM^=mV6V1$<WtQ}VUUaBvxD^+S&hkL~#SL)C`paO7Dmmi%Egc$H>
z7q<PW9yQZjVvb>T=(xA1@MnqV2318f3yu?;g{Y)~s_ZYWF<CL%={LUHaLk{-?yHW<
zqF8=%y{e1YN)YlV7xd?!K9SzGVW}7lo)e44yhMJ~mVrw{Gj5C!_L$p0Pwq{|TzEe2
z4#>i}t3<j2Xv4Pl)|)Ipm8L_2ZCswh%9_8}0kzCmxB$RwW;jd^p=u~sMwV|I&mS=i
z?(C(vB38wvYH_>-buL2AU&KTqp<vg8YY4P+D?M1#3!VE0BHa9BUVRe|E(&fe%{TSb
z{}1KC8y(mr0exYH{+yF<MUv)c#+5$q{NC)PG5vowfE7Muh(IOKz*0!*9ImdM-)$gk
z-ej!eG6$dkHqUj!j_+S=hfVTsc)Ltz>)yQ0+#MZFX_p)O$YLdWMn+J_hi9=`apUl6
zB^MXBxbt9`$Z!-_#VjEClc($4O<>d<%GThEKk`{5AmB4FnAw7u9l$HoTjpw}1@)>b
zQ7_|jKM$MVoAu`U!E%URU=4g0r(q1+kFhWFVBgE#q{2DvvnweJBPZi?jURq#0k)~G
zDT0vgl6fAT$Vbdj-kw^?>jg7}`*T_DP^(PL?y-rmq1(C*Q&E9<rnP7+)YJGn$Hu!P
zR!zP2y{9w<p;690(IdI~-X?Rm`m>>penEp^2Xx-NM{iaL<v@odu0M!fYEo;yht^+G
z7s5KgHOHBP3{;;udkLdBeG-<acta0^A#dW-W@$si?VLh=IVi2R`@S%xPIXend$5=~
zVse6og~f5F@o0l@yTqV5%#t?&VQbrKZDZ5C--1Q+N4-1i7f3N%dmuwNiQW!=l~NYG
zGwt0Ia<ubFed4(GmF}Hpe;-eS(pF@Ae8bI6Q5}CB2mO|4C#Q>ll$@f}o_}bIn(2cK
z<X#JR9d`cK+@#Tl-gMA+lDt-NWPtV;wD;L<YWlo_`w(O_$14>JZ|Y>n)?Dd3t4d3F
zPH|^cYbe8uxRLZ9rZxHJoDXQ#k*$*{wvL-|W@x(u$)zE}U34h?7@0H(;*YxiSHoCq
zX1##X>1dqOIaQ<e0K?6{R9g;K&x5^1>fYTJ?KZe6@$z{I>+<~G#%Q6k%3_ND8E`*`
zib<W<JGY5{TPpF|ZTXYvSt#H!fFDpsI5bnN9Uk<{O82e)TScJyo&rSLagoZ%jBwCW
zXZX_bB-typH=y21yp8{Nk+#nnaR}Hl*jAqud30n~L4aa;`Og@|^3}O;hx;@<^&gRF
zQg==-%7V-8z~ZJgqxecf=wJK!`ipK<PoM4}$my2Kk%_fvT;?gHAC_Wf!u~=^ga2xI
z8!WJO-z=^P;ZTPg<n?%IF;8d7u>;_B=vf8UbC#cEW6yt>!ERLFKcXPrq*Pk>#i3sI
zP5?uUb@AK3QwDPM6obyD+NrZ<c;V5;)7y5BsL02}_mZ5~n;Q*a37Z~hmg)&npY-8s
z>iK$VNI*c3>|Af1?oFx|0JN>zZ`9R2dt1AE*mL}in}=PJU%YYEJ5livA+IN}V~{ie
z7A>A^H^=!|1KGu;(m3PUm!jKB`|;4%lPtF0S+{okA}8b*PTxFc8OxPbW#}oIYQSz<
z&x5Cs*UN2IOkZ>PG@<p-$~`Gr6Iojshg<5l451!am8|6LGR1-QeT@y9Q3XsHgH`!6
z1D+I_R5&30(Trp?sVb>{2Wtl>r;D`(xw$$a6qCb(cXR?&CnE`2@WSFAS;@^KKP#_t
z1!m6e))6obpAs$WleruxP!Ej#t`5*dPS(UFqMw_DqqaGZQc#q6Bx=SaYhzSaqWz<)
z;_yd66#MNQo-2IWYKJEkoVe8}s_Cx2-LUFr0K~T4C9$3Mj7N%_^!Z5dYWm%e9ZSb{
zD;v<y2-ii^cAnc~aT7har<=ayp7xsF0^x?+<Z5TTkKf2H6M|$+5JT=+z0y&Xncpfm
zEREz2{4lA{lL6)8<y+SntrqXVz%ozmw<@R9JDpEIEp_``BU~RU-blIoCVV4x03Qao
z=bYvZlOKB}tU)elZli5~)I^So4G2EP`k6B&|HJsuGjh813*rQ@;Fi;4lE2h`|1xJ<
zi^7SJ6G;xW%}p^!r@(#=`f|DbCG@v=Nt^HcIz#-+_O|*?K6h`G>mfP8*MqA>-NK_n
zS=*?sO;ytMjv{MX*NEn3;!#Gz1A=y?H3#05U7Fo-BipZ{@;VAvu^v_3;vzbWcCVTf
zSZ=*Z6n~^SP2u|eiyTevM#VE}kagd~jF=zlP{@}m7pEn*k-lp(K(uE1U_W1>a@}MO
zsB&EUJTo&LnzFow*Q?Ew>==C@`505FeY@|7`qA7I&L=r4sBi^KO+A#ZM*-+R;|`D@
zIO?b3#+9n=m`tf+M$YuU$p%!-o?C6lWW%`O*SEY_Xm&^w0|9|yR}JwUb;i#Jg^n$k
z=&xFA`1+wr)yfO*7qpLAVYr3z=^uSfgnZM1=Owc`pWk8_%5%Ck=F>hW8K^1ZHpW%B
zPZ#{lyVj#GXSpfgvD21y#?DlaNGn;*c8!;DG_EePZ;(0S<`sW&qp$BHY~eN?2YotV
zG7^-Zi(Pf=z{n3vHPRXTS;POB85ZmD+m^mU+B5<dFc=n#_fHAG61|DDFQvAUk(I+K
zcQYa8nEZqxVKJGl2G{Wp+d^E+ZCUxPx0w+MHh%}lB=zdD!diq@Sxi2sl+DMB#P2^m
z+N#9rgO(eoRJeCA<)@YxKkFO}`+P|+6E^}PJ^rZjQ^<nuq<q<f?O3GMK@(cOcF_9G
zLBIM=62N&mxRzNHt4-Zsg9vovRe|mCK~X76kVL|oX0>rUy?2F)Y$^V&TRbw~1me2f
ze#~W|SmjzWQ^B^Bl>Fd@-q+4&7BVQc=@ikJeG91{=$KJQ{_57wd29ggfJ#M4NQ?tY
z9pC`eewuEWcE4iKk6h^T{zgh@7JT`PLk*EwZcO%H<KpC6lJ@gB>3YciM`E4DIb4ZU
zml?uJA-h0kRq~%&Fz}ua|0|i3>%ZHP|7)_x|7b{#y*B0bUwp<Kshz@-OuvP#Ycbgf
z<bJzfWG_1-o5Q5y2o@SSP_#`I^ZJq#hjt$Kdjs@4PTm#_ozBoK%I+k;*HRbuJlAs#
zs&0^`(LE*pyFHGrGhZ0zb8G(m(0jC$<Qb=vF5>0koeb*iJddK6aLV?C(u=t*?{kUM
zb*7;ssnH$e;5+1I9`$LUkbZ^8pbLd4M;-opVp%FwtGX9rkBW5`bKP_~79Ta2?Y$ZQ
zbSPZ**SyGEp@H-fBhe1pv*k03NaRtJ;v(f9e=+nyZ}q-?ifSFzavdGzzcM+S^2gl^
zi;7II?udx14N-@58L>Cu&&Bi}Vu4M4`+U>>qOg@IAtYx-#m(~%xp%=aLwLIi+D1a5
z(BxG)>vXb&!<vjbhL7jzmwCtce_i*X0+aIa|5w_XM??L-eOx8^N{y5dk)nkL&4>(*
zvSi6_D2=6zrLynBjF5;SitI}p*+U3f%bI=PRhD5aW1F!K&pr5lf4}oQ=Q+>soag?}
zoX?r_88i3wx$f(FU$6I<t7y<#{N*R!f>Smg^N!Igf9H%7t081iz*O^%6-&VRdGaf{
zar0yq3us1$>yK>lP<`9nWYUFx2IGttqnMg;8H%WDS}8rT=7}BpgzC#t&(Y-ybWo|<
z&Z$txp5V^}C+B9&7xRLS#E;7&O(@qI3)A?OMRRGbrWX}KY&*XnLD?(JHRYM$paOB$
zg0_5}+Lgn)zZRA_&RHGh&by<5x#IlW;E_Sm&ob>>!lZ~@5VEGOk5YN@Am#7ge{m_w
zS~4})Ss=~orD8cM_Lea#_0(%zYJnQjWV@GhDRWt9m|#l5iFZau)utB;+(vdQks$WM
zsYy$5#c`4Ncc-UZdp%=2NxKqsM5r5s7EL}|Y<16kyZwh`AenP&$ta8njL`O&Omy(W
z_f3y?0ued^wG&d<SA&oA-h%~fxfS!r7JSGs<yh<$xzK_W7N><{Ig91=)jUn9{Yx=c
z_6aN1?&=S-cDlA&VXyJt5H$R@)U{_<L`?@Ieko!bnK;gJoEB09y{7=kk)O%XOX#cy
zJpmY}ewa%d-nA>U$-La@oj^2mQLO!PNAP<R@$R%V&|VqgDNUn+7Prm2UiY?Sj_k0J
ziE#K`hZgmct4X3<c^jJ9Bj-clJxl6-fR{>>&=l=NpR#ANuy2jUiu~~3b1Wv^JK=|a
z?ytWfwBXYs?kN~sfa)V?aIP?s$67_|)j@jBHR~i+ITM*P%q$;+kez&-DK0#D?mZ?1
zS8TsLv?J^Ln!t_;N+b9azi|L&CUJpSsCw!Q;q49x&7^_L)|?ju%Y#hV$>u@i+=HCs
zlnL=#8g2h+$N2kB^jceu)m&FP3|vV?Da4iKn2+-Nea+<)uRj}havc?d{p^FI{pV-i
zE=!Qm4t*D{N3*GsOO}#|g+>au?>%~yii?c?cbZwv9?gt)&NO!L&W1Cuk0%62L0}3l
z5Jb$5J0Rj=4(wt*^@>WNOLdO`Ne&eiMdO4vs{bA((VuOgQTml=x?S1|Kd|!z0bw<K
zSD_AdcSuxYzeku=-gYn!>&#|n_gh1n-veNXUCF)HA6n59(Cc^KEOISA=>}|nQ_Xin
zBGz|O`eKWHSffI#=jSn6mCeqf$ekCon6K$CF#C`N3Sd<Q*$ZRXXmNdWNe>1#8P5jK
z^)l(rT%dEgKCpNet7#_i<n2#}ez}JsE`RRZ{)jrA`QC&>j{LHkH}Dcwy0c`T#)Z=u
znNz@bY3z1*7`3$SOZ#axHsTPAY^BX7J>A6EV>IQTGH+^|Iz7AwZ_|>LTGjZOpO{eE
z5{j7n@w*u*{($>+o7PYP!j*5EuD_G=<A-elmMyR8$Sse>3ht#S#WoXFjI~-hbfY(A
z^v#ypx@7BY72uzOl{?`p;!c0_+^S||>Fmu<LYDM<@y(JJ-<teY*AFGgYL>q2+UWY2
zt4txM2F>2roaNPKr);3L3|WD{8ng4(EezAt)AFMjU+Sa&7%1St&&#5<^_L#RL(`}`
zdSd78gT(+F+oY7#Wln#}T=Tw64Xx=ByO>K^c}E<QOfJ4?CeR8rgE!#!yN?0MVA}gO
zMsd`T|A&`0&KF2JysFYk@TuO0%%!B4kMss;0%HN*yi042YSj;AzPES>?h4LmagAc!
zPC78(BPXL~oXfi-WpXNtuDe*%xiM*$uTuIlHHfH!wV%t5gsrzDfLZJaP#8y?X_t8x
zmCdRv(DmsuZ^!J%$3K-LGKI9vJh;uiU+X65RQl5E*J{(#Q!prgITPt~in*M6+d~F4
z*~a}6IJdTU^_8I*L^GJCIqDq8P;XGw9sjK*)Cx|q=SKTETeZ7j9R`3lYWh_j@q@|6
zW$oPlmNCa9lRYUBT|G-(;pT*p$hnxEh~};FPm)xWpoTV|sL~gQoq}(1aW#!q8HLd#
zRO;^&Lh;Kgm5rS=6WKGZSyet_8GP>6(Vf-=7b|lH!O;SODG$<7@Y+sM;ZvQmIL*+t
z2#=vDjtXomUam*6^~#GP^g=)dRJ0cY@2=kqcbsy+S@(-7R{7C!o=omZW&;xjF3P;Y
zY^e&s7e|BKC3V2`JyATwR&VG9Cey~cAf7850~g4Ldf)S?$TxUAQ50ffg&HCLiMTs!
z;b4bq+>5qByVk1v9HZ{Ia2{OZIaO-g>R)!QRCLZO()s{F^9~6PP#x*Hk8Vd`x5DkS
zLnY-KFIx_u<Nw~XY$tw>Me}A)k%O)^1WfE%9Abby%RoLXn39<Lt#Q+4ERup~Jt6ht
z#1co8sS?_-b!If97(<&<=%0P)GduW|H@2-HCr){wzE(Q+@#q)}5&zb~e582_s<%;u
zn?Oll;{w8tW?;R!D&-xpXodsaXFopgpvLFt^E#$<<@NvUx=I{uYB1+F%Ib^$mIu3b
zcu2VIPvw6;H!xWc>hZX^_1>%td+;D(^s4XOVybDZkpXHE_{$)N{p5%DVin?n)1i{C
z?c;3*yC9IW7;|L*KnV-+v0t=O=;fyg5g9`b;BYk+-LQXlJsP?I0+6jVoCXGVZ{=y#
z_XAR2?Scr|?;XW9d64s|-xCgomECh*50m~FQ+hog`T{F6T^XON-Zj)e*Pa#YG;TfH
z((t8sz;!A%-}syDqFp<IwPhkKV*Ty=def0J#NT<>J?dsGHXTL6U?Gl^Pt+Zse7eN8
ze>X{gwxb+&`^>(`$niw;LT9zTXfLSh<<0u^T<+=avyi6ikeNT>Lj>N6*}{Hm6LLtY
zuCm7<XsB(B%Od{Hjuaeds;tT_G3z2N_Gz{Q58*@}pX^kD;VeUtEUl_L$BZ*PMU)!x
zlQpc<d#3$n{Mq{(%ff*TgxeXD0!yCPt|fmBQ=JkLftpy8P}~1zkTg~%ka!`_b_WAv
z_=Y^hIPDK88qwJ-&sp}y5|-r*$%IRZC4{o`BuBYwnvKQoUg4+)z(nP8NJVy5?sQjm
z&cYZjamTO0(B?cW@Cq5}uAiw5j#cl9+8MP?jW4}VjN#;|2nB;cX(}vJcOv`CR8SG9
z_qm>`g^_7c38D!VBto)=#E?SE6k-N^y09TW$hfX#xdr$n-~`e{US(=yQ<ac&Wf=F+
zIExY&BWm2xR*}Qf=2x;*s%;iw3id7sL7!M)cCTuP(Pg?U`J;>m@cis5dTX-R-=M3f
zQ!1$NH1nK|Q=z$Q606E~<vCvU#Xl1K3mnd4!)E-tB9|XjRM{t7m_pNdJFT2l!L7zq
zHR84>mx|tc(x6GZTQ%pk6-bP@w3CIU|1C4J`a3h?nDOVFZu|%p(Y7c`%WG(K`GoAO
z_N7zwXqQ=v|I=%0)QFUE#&oYm4}mY?2{2Hj86A?}YQyA#9g=C4)wzTm{dq^Zpj|z_
zpaaO#rVhj)?hnh8u71obv2$g-VmXoo!78$@_&z(-3>q#LT!^cM1%s)GL>aR|9n-<D
zq(flu=Jo3gu*y|)Z#3y7|9FA}To|py#6GGzF?LBh`dC<k*e?2&mhm*+5V~^H`!(45
zp*(_w_O1PKT*cJ?-}F%cliL50$H2yOnuRALJ<k7e5emn#nuYxD<A0L7nn-{t+mls7
z_rs2(fz`~DNS5(E`PNxM6;3tH&sKe~(&ralR|Xv+7cO43ivvT4AYfg%7|MJzZ$UK1
zedG)RLOE;FD0WheS5WeV>}RPsgREhH;8U-zCk@1LFEa6;XDy|jx6inr`==_iRKMZ9
z(=W`hK-)A@-lv#6eB7R&j^v&R{^Xjrl?8fs_^z6DxyMwzWug=+QI{_pnNGHTTq>QD
zOzUrTpuAa``A*E->b;n<-WoaiJ+!|iqei+WnF-$UYSPzEs)l(W-2d77A#Q>~$nDwm
z*9dboDCV>it_7Z)O1Izo7(VAg;LE=Z?IV89*9eML)dY0atjKT9t^kJC<l^Hac}S{V
zGTlA};NX9*no(Y8c<$f9bKVYW16AXP1{Lb6s=q*?(A|1Mo63Ec)?K3&$wZcTXXt-R
znH@a(Sj~fRYhO`7<QWqgJ9*)#<Ksuk62Ddw9#!=oww^58q%TGY+O;z>G-6}l7Yi3@
z-npqpcx&|QFXv;%3v$vQh10kOJW$aV!LT`N&LO*2b^>A9uc-6%v!k*zAL4iqXrz+i
zHdsAtL!0<6f*Wsw4%W?Rzt1i7b@QfML##=6_uamQ6`h8hl??s)Rjuc~q7s*&+Y@m~
zH)YR|_B*8e7m|<%wx7}`>K0Hq=PtVdcY)OXJR4Uhe41<Cr0K9uO3zmu__{Le!8v(?
zZVf+{_o_t|Sz=(y8UgG+p?I28&D07|_q|R0AkqgYRpOIs#d{T?<=lH8hiiYyndMtW
zf&x&8Uey7PMQa5)-M`LK<pS0OwRE+E8y2q&8Ko5r{%Ccb!AE<C7LU#fvYy~*DG9Uk
zyO-TBX4Y<j<`v99?xZ`vI`-A(Ievg3=Iy5BS~8GPU~=OnA2!zhw@u`Y+90Z<szSc;
zop=2t`!5=PRnxbZoQ#uGUOSrC;vP(QzX%Lu8vPT^)Iy%_ITn12tZm*-m1YEUcO&_h
zJ@ddz$YiM4+5N~dEt@e?Wgwf7-3WGN>T2I@2|V<YTxj^Q&%HmD8LB8qBc!hQO$(M?
zFV`@+(g3B2>U^jKg>srYm;_hq{(LPPcZw8GRUJCyc(;$kNHkZXIkz4w`g}sacHA9@
z7mQf8cKIZ3VS%5SvA!F9x;EF+IG#|=csljQwZy#Fb1@D#VN%haz9MoxpG2F;d6?%Z
zZuJT;4C3k(n2bFas(TEK9FI8Vp6fdZMCNy=0<HduleB@2F&~6aTaE*2Rp@CYjw5}d
z^NpMpDnIFy`1C8CE06fse-)s?s7G8N&9QvBusFX@8Yy&N3o9BTlnSw_jVfzG<_|s8
zf$7Z_sA|+SivQu{TD!cAc0?CFE^o-k3Ucc`h4<h?1g0B92K+M67UI_ZA4atJirp68
zfn${_PIwQbC!O~m_47JZjhJiHYtvk4Av8m>Fk|squj-FUs<<mEJm}$rj0+s$&;AN3
zv3(js0A@7M&wZ*&v$RFP_d#i4!@&B?j9ly>{M>B4otVB^A}UEgkmEQHKW}2`w^E3n
zapu-kF(4!?C7kZ-#Hg}7NK862<rt0)?&CONk%-!8x!ytVh&-5%ea{ayX>L?U9ERQW
zUaERislE_x`FWHArxn-(7VD*Y-!?{9hV%fl^EL62N_F+`y)b2=`WYis)Wmw9+2Ybo
zAR};6y1^$gcfrUobMAX-z{PThgkb2<L1;=c)WC6VhGP<(<0SpsPBWi<=uwYq2*Nyz
zSPs@dEoihv(bTdePD#y0b<A{ssX%V6V!n~P(fTr$iqCUC9(KBh2lii!Q*#>D)rOYo
z3vDH&$*c0H8B@lA%zDP*?dl|>QK$%nO$`j&L%AKXpB|p4JtMWs^npzj^hh)V!ekg!
zRCYPZ@?SLD8KgX)o*92lk2t(xa1b14&)!P|uT?R*1xy42B?VZ}aJ<jnXsPVE%A+YN
zU^?Sp)1{zV_m2_TKcK_iIW^iv=kioi;)0t9OPmlNS__AK3cNZqWM6yQ4fMHKf~xUm
zTUdZmEOOYgwpWoNFZ)7}0V^Y3#sH0YY}^KDJ9k<sE1Mg#^73o<w+H@&yAU7YMnMg7
z4F-q5A6XzB1{eBMZG*UIMlZDW_cQ5#O8t*%X#rjCKNqoGl<^s%3YT$tQH5iArqvQm
zd9xiJ5AdP~#;`0~tQg-Q6#3e!uRbLVd`gw}5pU8TSN1W;&68d!0fF2=R&^h<y1?ss
zd}K4(ow~-svmKAxry|b4vaZK?Ak_k<YKw*AR=CDrAaP48_KShT;HIlJ_Q%`OdD(0p
z5j8Gvk)fAAOyhj|d-H8JGOEvTp89Q|M?5}~dywjG_-YK>EwP;?ob7YTF`{1Y<%)ze
zCZK4`@U{4|1UBusIsVPJ<`3QVg^o=|)<v`6Qx%T5i+L%O%`-i?k*%ybuqCtZ>e@~s
z&)^8P+b)y2n^HH#xWG*_O~;n|v;^0(+>Q;tR2zwvLvStYc+PQ!(3zi<alt)N^%An!
z_BHEXf*Q6Ii;&{tb&DNXx5>5RtIyXDjBRd=Lbk+_D|s>!E07~MilNi<>?7K<oBMDE
zTWsj3Zw4(q(8C)n$J(s(%Xplx`SbONe9QVZwte2~&KQ}%;W4-+!N2B;E81-CK}&DD
zY!-EXFFzn}1Jv02bi7z_wVUG8uKZ`#M%2?}c&G5cYg3%+V50P73;MEfFAfylRf?qN
zch1a7cYJR{onWfFVDJ&;thi0=C?q=2ZGLFP`gvbCFB$Uk0!5;(n3c_wnuACfsf_%o
zi$#{!w-MygsTA;QQ)uG-!OO)NZTrhnfKtw9<dvdLoegzgb$wcQg!Z)-c)0LSzgnG5
zRJ>!ixKjQ?CIG8I<x`G4xCnb1>N)yc1Y^;_G*i2z_RRdHhh5lDq`bTsDeH%*o{_(M
zp-3lx>zWGlcHim{m9RP$w}o3E(P;?+ZDgI&`CDauxiwF^Mt^_!Z8rX?!|MtDtu4k#
zj`@|L<eKpUCRM`h<V78G-b`H7VE4z@v^V}D%3w#Vt%%&tjOb#=iJ?auYfLyIwwu?b
z#s!SMq`+J!gA~dX{EJ_D1^NfSH5{pSo%T+gf+k<VuWe=K%(|8_Z?2Xn(>yp=*Q8b#
zdtc_ps;QY{;FNsIwj(t-7T@*eN`E=V=5T{r^5dbzZ4S6`_cW~G?07B&Z2l9R4V#Au
z#CfTO@`L06swR~$jISQz^_{y$e3}%_PAWhBYh>S9jekR+q@}0ZPj^F0!8Qvop*hEg
zDgAJ3DHj2MLMY`>b%5pGEmea}_1}mP{~Egkp(7mDTQqvK2JHKAUP}3;-3SmmM^dhz
z8!E9F_8?uS+2OhC`m_*soOhz5pFFvD4&3sw#o9^0U*X{5g1=c?@dL9B4QqwfbHEW>
zURRe*#bs_Vb*sDa7r@H41LJtwV(Otiy8+I0Gz22E$pX9(I?{I(I)KBE=Lrq7bX6i+
zfLO#WqqY+~4r=g-t=DVdSYLI5DQ+Ddom&;VQ3X}k4IFIIg*Kckey675z(?g+nHh9!
zx!yRxTezzX!-rhm7sBr(FP%$6qYYzM3`fm*>KE&<(#)PaH}f#(m3|LDjt15E{NOtS
zW(_Eyd(hsm6nU{?kA^ia&4XmJYL#SC9GUX%n?d>Q*?8CCHj*kVvmi7hV!R`9OAJuq
z$*drLemrX&z*H2aB+%gy6wj@AzE+dDwxlye_k$DzkL82txHz%r8TGAK>nHeS+UZue
Y4<H!%nh<C6xaq)BR#2DElD+TqUv3n-ZvX%Q

literal 34379
zcma%j2Q-}D*KUxIh$s;)YDfrzAlhIM1QES=qDJqdi-;C2h~9#T-g|Fh)X@z_i#8a2
zj5dZl$?x~w`~TK=*IoBr%d%$H>wWh*XP<qZ{p@FpP*s+DK=_#O)~#C)6y#;pZ{5NZ
zy>$zx^DaL2n~)991?(>zH+8w!x5^=O+t?4ct)-NtZr!Siy?<qP2mAS+v%H?$ty{!B
ze|~VlPK6fOzgtm|k<#=s-ouc%YeF;GE(1bdvVKpYehGLeU!N%X@*+=tFfN<JapFb8
zWWUe%sIt_0Haou2@<Gd`<|!qsR_#{f9^E+Dj_;z|<RpzphsQ?Yijq$q9QAnaUS;^!
zJFxf9wcI>iHTD717XbQ}bB$+uD<7keOioS@GW?5`=`%UB65qbox(sNIDXJOGZW|?g
z4KG**`sxS>3M%*f4yASMl#{qrTku+o-c&a-Dr+DmBO4jvYFPMWIh3?rcYFvDJxB>G
zH*A`?nzTwLCrf<m;81q`4VJH%e8Q$!A6Venyv>R!a#d1MS(~r3+dS?fU`#<M({w@7
z1nh>>uPUymJG#LV*Dh{)4UU;hZ)N^mwO;ZopwnGFw~M3LKzsavgN~c_rJcK;g7&i?
z=|w%69uelWw=XTo|Gin0_~*}`&Rb(ot}dY+%9bs~&{91l*T9zFwxUV*TC9Ylrx^?L
zpNoU7M7yjT4m=a#A3|OtD$<Q$NduyQ2@fu6qMgO?zt`Yoa>tdW-#QDUl$I7nk^-yT
z(zqE^;Ge$-A)pmt@w0{CjiF@o)Tl;QJTmNTU@xstO6h{Bd4bvv%kBP`zRT#P(!6q`
zfCK5P#U`PnKn&l9pP#MV%u#$N*UN(44UUQ2PyRkJEs*c6fr<)A(tsGC<_@648!0ZM
zZ1QV+=wK&)t_}TLAj20S-uC97IeBSuOAwh!-<CBw)xx-nu}dXC@$<ykik%NUXf!WN
zY|>LRvMdL^DhqCdE3Q@i4s7={uJ~&m8COPbLDhA4pTK!&2M&otot2M6dw!qcO#_U`
z&4})1gOgefhve_AYTP63l&#KJjmGKQ=Mq=JO)5{m5PSYYGaC26ZOgp9fhNA><x198
zfmX=5(SVr@DA-szLpZ0w;*2Wrh-!1y(%G5x=6d<Y_g#tSRoKlT;~~#=Z^ugs-vJMX
zza!Sy_4mKIlcU<tzY-@2kCS8IJ!Ais@hLN~{e)PX+a$Cvb}4+6ma+G|w*i%Oh1t>R
z=uUTPk6^@X$!-4nnSTrqyoR4&pLJwIO$q-_i@U$WP1~~c(}$^KhqFPDAUuL$e?r~@
zQ+UtzhbZON2>J&?J-ThUYaK1c4Ufvp${qwB5(IwL@eKRB+#Io@E2)a#SvDW-hG(-a
z|LSPZqs&Wi%IP$=&)V79;cL#jch>Ce8H8Nj{mBZ3q2EFU+0bIg1v<$>_u6;OEg91@
zVBX3ir_(wny-Grh-#C&zd`<MKr#HkxyBPk=D3>MVqcwL>%yYnOoLRm}`?;X<Q|{j<
z2j!~=CcbzTMgasj$Zm=@IkTrs7b8vq!7#@brDTgU#+$XkU%z|8M)sWokJ$qGSU$QW
zq(4OuG8@6{AxOVf^6bu<QD8~KkG;7Xw(048tkdS}u?7v@=V|@wqP)$`CKVO6&1LBt
zb=yYJ+K4Zr#7M`@jlZw2PaPhA`FG?t``CpgzOf>_*@nAhcq5H=F-O8#5=i_k5rLpA
z@`~KA4HiIT>Szj0bQoiRFvYv!H@I}7&oBFg+Jic7&>cb&)+~!_8G1D7NHJK06L_x1
zdSq1jY{4yd?hV^L_jc@Pb_60b<Em<2xkl9(L7LmodwJ446gJ@v9T*3WHI~Ry7|q{Z
zkemOex%^JB6cG_oiXOd!p}ZdN=0dbX`EF^%i{56;DGbHtG%9|Uk*XDE`o8|fS6JZn
z=*^scIvs-IrHF#5`^E9b6l&c~X~Of2_rjv#pLLDqAG=sR-LpEYYq~9VK_Ch(|J~3*
zhZk_c{1Y6I2K^MN;O}fE=(rFL&ki)Mz!?=oMqOLP-LF^B;l0Oa#e(zs_QM*>pz10-
zs)1&CtIg5t-O*u>bfU_`HO8C9?;ywB?|mg`x<4yCuD(j_Ztr%_>zL3pDsg(Y$&n@i
zU1CyPa4n=hqyqzn)Q5UBqU#NuM>hdtr-3)P+J;(EL2aYxgKhptZ*U2`D|+`IdLqgi
zcDN|-Iqo`|JT#R*eMSYpb&G(6VJiQ^#gjLI_65!t_sj%|Jy+k4pE}Sj9X*gtQH>1<
z$g^6+ee0{YF}&&Tu#+BoCtWXJH&l$?b+`BItN}UcCa)LRf@A0>CwlD!E0l~S4{yZo
z`Vv)bOb;FI-M~BgW}Q~ghxZ<w!)}&G59QIGSAj7YyxbdP?b7}8hO+=1lePw>f5XVg
zQydj`c)#DtxLjnQHCPwTd$rPQvJx#+vBFlB?6Nm6aMeMAp=LCyQ$LXUyE(sQtK$Re
zTZ1#x?X=DI<a7`ME4v7)qlEE<^J^73XW`5HMA?_tzpl3ht`<iF^Us+6#)#&C<NdyW
zf}SS#=2Ud_KMu=lUMc<esT2`i#D8X<OzSDW=-+QN<EVH4Mq)MD_y6-Ix2(*a9ox2l
zjuy@9w6wI8xqm!w@R#Yoao}Mv{oi*N%M*G2eO)0l@9aM}ebM}6T0mpseXJn1t=m3P
zDrBjO#tcARDsm(wE+|le=o%xS4g_FtZ0UHh`;UbiKV(ufp-0^&``~NL%(0Mpvv3LT
z)yQ>++6~)3fu9k%5Us?=3RpuXs^Dog3nz}mN!&c!@8mjPU1B>z-BBo$&-6@hRaXTJ
zxgF?O4QT!y@c4V}TvITicIisze%8<K&<b}m%uz=zAFu<ze&_hrz~L3BwUl3a`GQfw
z2uKB~@6Y{Ir1|xk!)0=3U^3B^$!Z9yBRe0F1^|be80=ji@T|oIrna;GHHm`+ITk&#
zpEVPu;*{AvV6uJ7Y8NUj;NYKOl4`Vbs`xUoSf_5AxNt@G)AzRXRjvk8>9VD7QkiSu
z=7db!vmxEs2Y%UqXS1+$*iERuw{Yw%@}H@s8!@ls4;m;ksNCZRJe#=sVDI71)&kT_
zHwM+Rmz)6m+B#xIjV11hO3D6R&J8n$rMW7C$MUOzS9|wWX-kh)@Cr&ZjrtA|$yBx<
zadpz^4yY`B=rw4s`xmSasDh}jPXh~CBL2LsFhg^1w#vM@xmmv=z7>j0l(_JJcRdYK
zjX!$$*BYBH0RaK7UeG_wY{PD9^{)#M^Z)BiRsSz%`v38`A9`#QZAYh+3zg++6=W0#
znENiRXqehR2l=Z&3-$4gt{D0)!*)NtWKxQQpXrY8JO4V){r5Ab1)C6M{;^cA-!w+A
zHCuoBGQ36=3wR;&rJFzhvEL>@zOv_E<Nwn~bt}p5nln9=`eo=dp6Isl=~g#hwMwG#
zs7^b$2&3*$m1I2q{k0uu)|AOG>K|Wv-7hiwVYfRWmRfj*{Pjy}%^@IBAF3X~8j-{B
zA+l~)<3ZYt!Jiqec4)cbUFcA%u%C@lwGkEEnjUO;a3(?7eL8ig1)6CA!|dEdsujVw
zz+$0bI>nuX{@gf3nxf^Co#!NXJk1qXuV^ZqyW=eH5xA$OTiCarx-g)frr=C|TKMxV
z1f}nyEfS`#LpD_CJS;6tO6}hXFGR{aQ9aH?*qRjakTS^EjRT6wjM`3{O8rZbg`VBx
z%5ElDm(_pHrjpsWSvHff8(L=Y@kk@(74-R}g4o%V+s@6#&sk5C&WK=@-$eyet}+<<
zxjJ1uas9i~4a))Oh9oXzjJNibQ*X;bdn9KChOp87;Z5y(q4uLK9cRQ88BzAQD0|Rh
zgKFTbaQ{Gxo-dHF%DwC?@POijM!Pf0R@5iIB>!f$o1Tgy|2On#UGP$J6jS3tg|pXr
zGBr>v!~g^}KZ$T!;ZZ51f4twle|bAbnDbQ;666Rzzyz=XM9X>|lc!Kkv*hP}H%Cz6
zS19(Yu&~FZzSmE=x6Px*oz@V6-puA0+EK&a7}L8#3be5cA7>=yKY?P1)}rPS>&P&d
z^U4<*=Tmv2l~;!~UfT0>Me}ocFol}trfq&*&z`rfplb@F*D^A%2r6`PJVCb_GJuh&
zAeGhb$eWMQ@_wgU#;*OAgT6)3a?s9XhpJ_D%{Nf7e@&UF2t*ByZ|v7Z2$S|bT4{5I
zw7AHjK3sK+$!F(X3W}YtI6?&r7CfA08M>DU4z$3~)o3b{K17juhC}6Bu4)G=L34`7
z`nv#~-!Uz;ho_>(4g&?i^d+c^Qk_%l-4Y)=7=2xK&pyx8$_bBgPvVQc;e#|sHN-x`
zc}di|#kzh7ZM^(`F)XDWdJJ0MN2Tz=Dxbii<E`b3XK5P;=Vz;Ni@k;#<^CbN2Oc9a
zNQ<ks5zRDov-^S{awNpkb2S)EM)>BV9KO4i%<Yvk9H16MgnQoNOVx&fg_ZB8AIjCy
z@-x4hV(HR<jpY<JB^TH*zV;t~u{g=sQiYPW<SDYl&EweNjg5#gEv>&(R&*8_Z<}6o
zlUWC(mx#TG5^>R{NX>pQCA8(I#8k>Jsx4TM<yQI-3-oZ=jwZ=FDN$b=Hr_u1vrU^X
zV_GUte@S5sFp)MeBQL0+2zYZ+uGCG8%{xSaj&UsYQ$ftid)VU6(L_D5141Rg`YwX6
ze#4x0-?1f}WwU8gkLW`%ho&Wg%X^2;X?g`d203Sa>zDZJ-AWg=y)EtUQsD!`QKdce
zMLk}&D~+kLNJr~-=(jyUHT#t@c6mBC?`x#+L0tpsM-YI*>(_PSQDp^Fz#U}Bhye;1
z;+N^VXntUqgdDy;^K9R@v*fI#O%KoInF`L?&fI#3dgDew-z*%wYu<5?;E*jVkDD2D
z+h^EQj&!mY8>HPaN?DHy1fBYNHIBC$9vBFjbe^+goI%Hrlq+DL%I?UD&WI>qy+V>{
ziL32^B-e#D?W%wt%HVc&lfHVtLV~0F=~bL-y$?SGH<uczFZb9OG!P@82qlq?Ny>`L
z1=mclOJGfX%{S=!w}Uoqsqvl}G=QWc_9rgCModMXw^4#dV<AvQ!QCRD{)~M+?YIf7
zJhR+1ce4b6`j^?u-WGMVj+1|EqfnqM)(@<+&BlkeaCy@i9EysnMMa715T1{V@qUT2
zP|k^mn=zC_Hu&#{7seYkyWczV5<8GRWy?kUx^M=VtmBBh3<(CXIO|g-hbB4*3sb0)
zlt75S_*6D5i>gJYnsP+gqbP<-GVl8<IeLo6Z_g$&d^c4#0lzLUnmU{HY&)>?9+a4k
z8=qC@!GQAoS3g1^zj$XQZr6ek4rar2xsrRx6W(_RyED={Fm&OuKiShg^O2zYrKXnL
zJlAq)Vx|vJidW91H+r19>~Gv}^O}s=W;4bN$Jkm&;XNYNV!mgb#AA|m)@>SQQzaas
zQ2;fI#Bd%t7*t(!3zwRt3_11Ecc79SF3nl(I;KSIsS2j@e#WC34XrACkI&6A8drvy
zy=rql^C8?6p$;B+H3vBc`<~n<0wX^@1^2L3&dfb<!j7i9oc&DPa}agr`4bUnGNd>i
zLofQXq@)C8`!h{c)aByX@?Gm;6!#Mj<4JLn9G~gOt*D77Mz3py73$x7N}22Dk$Rm&
zx)gZh|4Q)K5}1pSHii(J?yP*gfW*{s8-4qH)d%C&Sr<aLoUrU~PYSnrm#qo2fkoCA
zGvO<`AO^TrgWKX0yT$$HlZp+?=X+r=&Dkf)YyD9miS=)>Qp(=He@PM1nPlg2?T<2`
z@^#T~=gpB;MT_1fneaG|-kMCkoqkuPROs(kmwiv`7NDE8gH==O)Xia%3msib_hL-|
zy_-MeEUkJM@e-Lv4{p3!`uS)AzXFhy_46kyzG$s8^{y%_Tw*tAQf^Ze!|maNaUTAr
zQt7tRiGx(}CgAn0<X?uSETh)hpiOV}RJiYJk&sz}52TCf9`1fy$)sn_eV=G8VJ<p0
z5WDs`*14U4nK?J)+l`p0jN317&*uqt+_#k`_A?uF-EdQo_s*Bc-S92a&!qaDnA<kl
zzPkD<hZ~GLJKa)(coS&fJYhh$6;HL^74#-xgLOngB;~3BlarH;o_mjHO7-#-GhIi{
znCSMDM@CKSM9_v0A?8WHSDRyn_svd``S9LG!Vb6?d2?Be2w>uD7E^az3?8Y9g&MMD
zL9L-~lnuaIs%wxtW&%@yq!ce8ARDQG9vw%Xo^h&qb9!ZAhcfY&gv2)Xh1;=+?>?S*
zwj{@5g8x$30+M{z?X@4{%`)yL{a2<pxU?6O#u-779uf(Ad=d4mis1`}Qcv@~D<WpB
zO*Bv+LK>rW*GwL9o=}0bSnt+m#-`2t14$u+#wzpnCJ75}mhV=l&O=Uy&k@j7T<bnI
z=3M4Sl)L>e$2M(jt50${;pj%3&jc3Pufgm?XTo*awLNrQBZA8w57j=1v{cRUEDt^n
zva3Sydh1>nag*Dcj9yS!rDu1FuzemHfQy;Xc>uf)P5ZK6<7Qsv<27Tga~+9R?X1(!
z{<Z)gY9xqfXZLCU>bL2hg0bT>5a$C8hSVXnKGxzGG%%r|U&F(nhg}8J)A(GH;epl3
zgZFz@3^&W!Bc8^;0l$!<B1=pkD2m+7rYfKW<2fD$#Z=+}pnfE*zUg(tn9O`Jh){ty
zt9`y>L)d@@br|8-dIznWQQ&P(E{_Q=zV&|YX6TSwQMp;YFAHMhnAj}fOr}|Ch{yG{
z?6R1(_{Fq{Xa&0c&?KyBIo<xPNA{*l(Bf>oaA04_P$;B&xF5UkPJh`k!mDoH_!D>Q
zY@~EpB`L_t#m3}Xs!+AA(aUA>^Ql36F#V;SEoIS0ZI_0|ZuiL4J`@HDj~J`VeT;I{
z-1ffB2lsz&AMlCjcqQ9B)DC2-;q`rOJ?kJRrHRZCY%xr()_GA4;g8#65Z%xirE6zp
zpGbV5+u_mn!(%oix^P{2wMp|$+e2L%%M00e-VbV8Nln6B+l2DtZf@O4R$k54-t7}&
zzz{lS0zUob_hEZRdQG_#i(hq6@m_cQg0vnpi4^uO!U63qeQGfNI$EtFv=ewPP&Zm=
z&WM;r$CKSY!%z^D+&t_FD{w~a`$Pec9$anQtCQ|Anl;MqB(n}-^|)5{xMm5AFtPV}
zB$~vi?U1Gihrd@@p}hf{tc^_-9BxTRhl>Y3<ili7p_|4T{EQq#Td%mUc(O~nBsT2r
zZkhO>u+lx)?=hig2yGE~B}%L+nYwQ2&X{IUO0}^^HNAXvLslQf*tgtv%E7G}h!bc*
zta_{Nz{k)Zo-o^nHm-eT*c;J-0V?lM*_Z@gJXkngVbtU4349piuup|Bk<;31YlJgk
z)UROCjlLL72o51JJ>WA>;Kh&#9=*2{TLlhbd248mtJ2w^Bo3R)vAqDW!H#NQprV7)
zDFu(J5w>gC@d=s%e$f&>S%gDq2&>Li!B?1V8*0{}0S^Vt?YqPX{@5A#b_4y@l-0C1
zxC5(fap3B^zGggWmr1oCjT(VS$r&41V(49oYU3DgN%uSD+^06|S&$?7y2@bDW7q&J
zAh@L$EitT{EG5voGX+oKRRxz78#X5cD%g=c9U{&{!Dr3wXRY(QVxwU@=p)5)<XfXu
zXxwP$bC9M^iQ8g&Gvm@;l|!fJD2|$ysIqXyhx#sEz6$7L!)FGIm-^xzS*IOR2b~=a
z>g~j?QRt=Fjpi~vg43!S;sVPVjgV#J6?#V)6w`r(1ch4NpjGK;zJCw*_I!#U`|R}o
zt~eT>Oo;!ft&tN2Z`~4AA_nl)>%9d2n!^ll%&vlMcKCb&c<vd*+pwG}FcVxn+J+LY
zy%7U+AWA2_8KBoRC;(!3X6B7M$}`Uhx2C;t>2=78n5d@Mg`Df}P5-anp4FI^tqp7h
zTmO-Zlngl6BgdIP5Fu-7x^ejGfjYEQX|z#ZXHR{P5Q0x6S|ixEeb`C5TY`G{Z<ONv
zJ-bB6e(2DjHfv=Q_5IGE=4;C;gBb3)L*Y+h^{d}F$-lP6*zb8(48a%9xL#TsC0zK=
z;p-+C`!s;l-InKK-DW=2S(lYh&I_VZfF=aQgRvEu&gSBr#p7@kK)>K&l{Hi<*DREN
zGo$a|d`+*6EC!<&LT)lgF=sitvXB~bS(8En=}FP?)SaQkU#hXKU~{ges*nHTx%aXz
zHnn$r845uja-2yz25Zy{R5B{L!Hcuu92piLo_-tv9YJ<fkJbs+&1XoCdx+c%RjFKw
z4&#<r9v7`4R~c^iHf5DS?DvLco8uh&%A@uhE(~>mu8R#P0!j?AfF%^tHa1dh3PMe4
zS--}IsGT?GT=5Y{aEI_+0W1z1JG>w4Ca8!v?Mv6&an@o&*qLWtL?dM;Bo*z-mu(0C
zLN=Wj@!+bO)*ACj5(ZgU>-$kZxK(k+`cv{C9~s-%pNEdTizzX#D-+R@s;}2y4aQKb
zgJ+P*jWYM;FJBb|+PzwS>J|4+sr`O%rg}{n*toGmgo|Rw%&wgPnv(O)Lw}i;pa6GA
zYT`n94b{jUS0<j8$@>zvK}Twtv}TnEMp>1$JR00ZsPbLRXl(hXET6&|cl&MZi;^)d
z<3Jat%%d$v-1!!_*4Bzs?@Q{RAWuY2$)5jHgNITRz!^HCPC|8cyhkbM4VEwMcnVXG
zeY7G@=~Z#Qmh;<~7Me6K-qT6Pbf)NWSJ!DZw+}SCTZ$I9bYL@cHSe#>45NaLp-`Z<
z-cG|LKmKX|vuwb9A@8e~%7)I@+N~!ZKbjy1E|}CkmjM9N+wwKnX}wOA&x`}T$pVyL
zL(iX{Z`gq}bpf^BOtS4-A?3_B%4r09OMd?72tuspat^_=XNhU8jFpPwD5IClyt)TI
zft@H|SLohd@r9oZO~1CMT1Zn*TJ9Y4u3>O7Hr|)7l%0$bUSMW9|Lz*d0@%_x!Jql}
zxM18y^8$Pzpu(z&7=B@G*dgbuo&mcrqCB8qU}pgF-O*~WA3Q+l>6s9~y+hWh`N<RV
zAw)~4;YJmacAzaqy3i0MD03hAc5Y#LEe_;Ky*u{F><@jXxg_k|zp5Hw5@skhb;a)b
z5%&*6rO&b6HSaT?jTdI9as_x4mP)Vxa`-RpH~!k}zepTyoUWL6t?YSmbBa98o3E~_
z#hdk>z!S`?_t^Fl9QXp#{fJq<dOUA1gbzF+<^JBb4-lJitB(sWPgYFkP9=}rZ0Wzo
zrZ=_ckH(^v7$Bnm1eD2{;6PH_ZD|)|@L*2|z+@C?M-6X<zyYkmCH^8C02Rt;qpdy1
zE}JEABjR~3gs{iaUX%OjN4<8xCgb!)0!BYmNQ1P@{ex(srB0YrM;SD{aH34Vj!<aX
zuf}+&taE&Jq3g3)E1LHqU66_RFBbgsD7BN_geH3n15%)f!i!I;CXe`gNGePvvqz0o
zY}-ZvR?j0&J(0URCsN|ev33$*k;g4rG9cf~-LhbIqlPuHfgFZiod>B&3hyv1=V>h?
zR+SoId0Aa4Q)T5k)vq>DxW0P`op|ZdCvyQE=0-d7pWF6N8HVgf+ch<x?$tq(=^m@Y
zZPm`W{2gLT>`LAm!B%@s!v<yByJ9T7rT+o*SSkz}M88#P+@_yQs+Qm4y76`iXEbAJ
z?!#^~NxKEE^@sr8n_NaI{xP-KO*4MkVADzh={kC^&RzW^19P3QHNPfmn+jSrxHdfY
z*UEh#rT06JB;k;I({vwV`KkNGR2+QS=3NE&f#KIrr1xlpM9zw&nXc|SGp#o+k#F69
zqj?_pOI1bn4wsw}f}?N({L``?th!fK5{Ld!xFT1ND*0NVmkfh?GOf1@GN(Ba5YtI&
zY3&EXEcS!Y{8lmvIYQF2`x$mho4$7)!r%+`dfpjq&!B?2gYO9dIu*tn-64vp-0|-0
z7IT$m(o%B^xWV)&$t7{qYr&cpqdTO4#vq??MtWuICs)8iCYdF>ZEcc6{2jrf)jn>q
z4;{#aFO=(k+Ik@0372+5%}!@|i5WRL&0A*Qfp8wpQRX=NH)HfUjSzmpGRWk22E$x`
zJwCOE2fG?lvbQ-NOZ{lLuU)s}lU_1~8uWKDbn5yc&Q=;r1ATVJ?;p4pETQQjAi;4t
ze~SOoS6D$NpE*bwsGJ3e9x<RFht!wp`r^>=D>~_RP*U}&xSXqE^9^rR(@K`qdjqD!
zNeY#G)H4ASBk#mB!30&y!;*!)JD|;Zr*=Ma7ovTV9JcYCPjPeAk{98*Dty8=a@IQ*
z5Oi(@NNN`9$=GfXZ^x25CyYmb5s;k)Il=%1Lhjo^3#tWS^^SeLM=lYb?sNF|i?~tQ
z)zb6>gSu|d#ggJOtEvUgmKg`*@3_)|ZnTXAHGE=1(bHtFt%K^9D~2*t3m?ofOu#i2
zpYzji6pjKrOQOQVw=UDdatfZoOuy&XRrT8k)0w10Vs2mAK!oEw9L+rZX=OQzzDfI4
zGD;U4HPuLdX{{mWeyZ`lt|7n9EUTJx8~q{8MPhwEtFKCi0s2P9JK?{jB~f<J@(p57
zRuwZk1Jh@&f~J`HNnsDe!I_eqA2ucP0AkUZInNvJQgIhj6>-#~EPyMSLrZ4R2%t0*
z5LF;%H3Sjfe^jZLY&{>^0^?o{-$hQj2^T4Dv|_oOZGeh7l3SEC?bi{`oK6x;<E&=`
zcf$_M?=rk@PXzH!{ikyIAo1$2`CBdH*pNTo{k!t|6$nYX`!6|QF4<hF(3kW5xg`Bf
z5AUn=#qO!20MmC)RZrteVR<d>IMSFJ5C4QNydU(7HYyCV<19G?x9)7BX5nA9g2*&|
zvw@-8nfr+7_fM@nCJ_SQbco^TP1278_%Ql+V||2(AuXAu$Kgs>ltjpFz(wjWcK*1$
ztgC00O<r&B&?KZZH_})g)T21o6+Fyfp=IejKWfC-RDPcTL{+iil}0S42H5n@Y^U35
zH!aSi=_9$sbWW`Iu6}6);@erouzfV4qxy!ne~~$MoS#aKst^9qJCN2_STB4%7o=Q-
zn}z$vJg>Kt&cEzgDBEcXlT(h*P~u%V^E}rlc~t}0oc0!YlVZ#7{CC)#oH?wLK4($V
z-S7^#2Hs2ZCl6)p#Y0$TL&^%Wst2*#>c$-B9X(yA3%{dFIaQ0&48MX-eb@+5tOdxG
zuEn^H7t7yRv9jy<GlMc^kQ)n4Zdj-sUMMy_HMOO(grjU?l6`HV*W~()m5r^+W$leo
z{9*>yxRA-&=@S08@gv3ERoB)-++$BT<n}vRZ=zy?_XjCwUC9b|Ey68SXYfg9{QyQk
zU&mspmwW=A*?J1>WVJL}veD2&U1r!+62K&DzwXGL;%}P^*^^kzc)JV^0xUBowXz5P
zc=+?cIX)4$k;9j>?07TJolhl+`FO}!=yOBf69~)R0kD>E!T|T~x<}B=8XAUq6yzHi
z%n!iV7gNH@%FSD5R)76Y#V+Zqh_x`4Tc<7tarw0A7AEdOHIZs^_?x)g<;xBXXlL39
zkGGQb-pOE*4I>6Q(Gl!C3I4#BWYT|O(cWyF(l%HVU;evVr95WyB7=<<ty_T{syD=Y
zurXP$o-%|Yqj0MKXvK{~(o!}4$xKL)gUVB=-fv^KufDJfO_SJg)lxMe?H6Xw?8fs@
z^#|M2v!qe)>Z;fgk8Atm4+iYR8<*i<)^_`nNIcD1nA7qE>}FDM-nB>Ws>nn}-@dC&
zbtpeuF=T(N>f|&eh-<eAobe$Aip!b$R6em5_kM>v-VB}B;i7>%TWC%!LZ89%5M|Yy
zfRj=o7FzR6PC9M)mOu4PtZ^!lkx5RJFemc%PMkIWwhv#q%1-5IeoRUA%%X>7IYN-)
zRW;Z66+6>xT*u0(P$HU^lNO!cji_ir(#imn0sbX0#L<Wqh9zDFos0{I=IG`N6O6Au
z>58<lJvJH?niYwFXT8@B<Iun!KvCx6Si8vz!_I3Zh3^&;puZ2N>%f8t#Ikt!PI&=S
zqr$1yJfBjsSe%zl7cxE??sVa#+KmEq_OnAcz82C-$<IHE$f<85ci=B3{;t8QFVs>#
zMEALQ>4TlJgmqgHBJ$~YyWAa?nR}1^9G_kO1V>jkxFgqsNWH?Uc1rTR9%1vn^;LiW
z)27#aN9Y#{`F{JH<F7ei)~uz7X|z{0yWM#n^3|!*J56&64#G%JgwIe)2V#qSxr5{%
zJG^o8dM>MgfLw-E2ix>7ettV$OBu~M5c$!)<kflb;k=x@xR$L%DmM$PDPziQDu-N~
zG-v*mpu_j}E_%}bD<9x(H>(J-@==>0@n_jn{KaffqDV>(dkf{H6Me3av{J$E<j|yV
zl@5WlBFTU^6_&}P{?GKidO_xjn4aI)W$j?63wm~#CWnCZCNE!WHJnboe5!(-6cQ(>
z%uLBYcJwiiH%PfQidf`&+)hTP!b2I|s-=FqF8O92`fk~0Uo@e1c^*tdG$^oRt}(}|
zwJGmkFt~2)UIaj07ugAT(<gN7p3RiB8$uDSS$@p~-&kK@hn^<N>1#%EJxPV~`35@3
zi?nvWVitx6TzoNiHX#*{AV#^>-tN$hAz=|L!_BGJuGNfwe?Gixrg(JRR3US}WXrUm
z3IRNizn3wMn6vz8pC0UMebM*eyBqvA@#l5ge3I=0a)j8X&{sh0_);oV;#P#TT%7#}
zt=PS!kIS7~hu&?hrGc8IPQ!QOMW5x<ft_D`_~|ce-WIgJRXIOd=Tv`EV;cy-lq&W}
zoxdkT=%RRX43k7rnaXEY9W%S&^}I1(goo4c11r&}oYfYBKN2j)ftab>{JJjv2j}z>
z1s3T!_1-t#6Y)!I4esLk*9ugOyWp?3(rwn{xzsdnMkeZa__Bft`}s#+?Ob`Nl1RQZ
zrym7*9-A3CahPiy`ac`o$11%fjf^ry3Okdy42ETaimCRT+Cg10KF{})G|Pt1av8Sr
zZ+<StXUYu<!aL}XM<$|Hj6pNqfY^ayj%}n2dU)kY3pusIzD$9iijZdxo}6{eOXlSh
zE7oow998u}&v~6{kut91gJ7V1wb*I<1persQTItO$ImC8io#MkQG2sc?=q3t@hO2*
zKs86I>!Lx$<)c_%^E&AX_+{3QYQIk(?3tOHmsY9${w7=o5+oSss|<D6W!QHHn^s>y
z$^=?h0=Y*NNyzv9_=Uxpr#v(PkleIvINQcDH9GbKGyMLJ5SC}j^(XjRTfu`(#3a!C
zdRJGs)BKNzmgbuCnkq(>j1EY^C!=0<kNiv`S`}WpVWk<Xd5oCnSfagL(JUZ|Z%*63
zQ=@Zia>9SmZdUr@r#rF6mLZ7IyaM3>!5B)@zXg?mwIn^5p3>ZnMGgaA<*reSeO!Vd
zw^ZD}Bd>rbvh-jl^)5v@TygY9uc)>7gDoFdlEWUgTK8L+hqDUbS<q=xS^mUln96>p
zyNjFmL*o~ZY%6NY-yc}JSS`TpQI>5&4wr68f>s%$l#-L;4X#@sIB12Iyw)-T5^70}
zy*DT@Mb3Y;ZX-g=rO=7N-_47gYd}@+{=lv6{E@4s<%d1wo1<<<^0o5)W0Uc1ao<^!
zv6%>Ygv_cBk+?%XSDQxKYxOj3AD!lQ0Tm0y8mliPz-aS(q6uGvZ!^{8zhCR2764Qh
zI6k5opfEUYRYqKnXB2bu@1@&T&qICMK_=Eehfmx9b?K~@AwSzAMXY|d9+Vxn3VDj2
zpk78RQS=3@sIVqP`jBN`t+PeyF9o0-T95i@H%06>To?Ccy^PF(kx+l8G}?>&Y>401
zGYt3c>zXC0eaDJFr!mdeSS~6q)=wsIkUQJI^&8V{g!!S(3&pn@g^X`Je22eT?W8L?
z9kJ5f7SR!!XNy^#i}$mBOFK>S>obc@l>*fZld-o=#r3h<@1J}y$xc0;mfQAktC-xh
z3FN?(?kuw%oNu|;TuiicxD~WpM-zV$=_~5=O-C*1?#bt$rS|<KG?zFWa*CrwGM5{*
zgpvTyJKc^h{IWKx7d&AOo5AfGO@<A=WcjTmGHxs^!}A9%`jJFye*T5o1LzHLlWm7C
z`7lZzYiOPQ@f=tYXK^-(K>_XA@XNhHAgu&j?|+XyWbenTH!xmO@q2gP{9*%|U2mUW
zj0PG9;s#tJvk@vET!%|4+SA4#d^aqIl}()m4HC3ekzth%b1cDR>*jubS3d6MB{JK!
zPUTeB;o+3Q+uPewy%!&OEEd~hUnKVV`zxY=q-1LPsJ({e>oUusR`V<hl)(|UApCxk
z%5x2&l<d63sLvdDt+;^RF<H9-z&`szH)<qqhT)^LzO<FQp^07xen&jy<XoRAIJH;G
z8kV|!584V8DcQVLO<Fu1-n>~WZ`q&7<{NP8gk&kHP%?pyvBfo^MfU`5_H2YFC(8f(
z@e@7y3tvv7hl{wsas2F5*!K0wdXQ{9+Y=Y82Z$@tSAALFPg)9^o9n(_i_IQBTn+cB
zxKkGAuv*i2Xa|h%mXh(}>@_qN^Ej}^Cz<;h2Lw%iGwf)u*eAGfqkBt(fWX;Loyt3D
zBn0V~FAfs%Fh`$*CH61A3(<P_$AZ@=CZo%~VdqZn)Y1Mprda&b)@!SSr?W?o<GzJg
z>pfbWrQRYXv#c_st#?{><bnxqb%#77+3kJttQRdA8G0Kqv*66fqvX@6eNV<>g-*{W
zj)6((^g#As^+E|9R=z-^z(qO(&R4eb05w1?M-}oAvOZal-A1_)Vnrfe7S{l`?^s^r
zuJ;{LlP0W4p@S?Ib0qC0Sho;XF?@-97c)?w?UwG>P751x<!OTOM?T2z0$I_Ch9NCe
z_AXtG$j8;|abVK1zpKEd&uSO1S>uV6<i%euA5<yzd-^Y63_Mb)-~llA)M5```RucR
zy0B`c>9two#s{<Y9u%uAV3(`&yQ?Mjt3G1zj+<-r9iDvuez^bl-lt#MRc}{qKMnPH
zT?wZr`5gQ*)Tfkef?1*VAg;4-o^{fKIwIh+g(New;&UCtZq*wqRBWO76#U1i)14PZ
zY7mRsI_ya&I<B3MNQ`Lq-6fmF-FgLINWfSui8Jfl+_CcH{@oOG6H0Kc$tBSkg_h3u
zNr_!6lEARXAnMec_hRrf0yp^fo7c>nEpmpJ1;`S^JZyY*3FtPf@28_EO&@{@vbr@?
z23&7b!S?Gvkt6^dG3<7*xJh03Z2jJ~k*@FR_qx4Dbnv04=-=TPXeQ;-2c2J%>woXp
zM;7Z2X7?z#jf%`yG9U_8y-;6D4Z9E;PUh3a)0;m-j?<T~`Z6ra#(FQ7-bxADr_=Pm
zz%IBY>#Yu+RFTBb<DX`x{M@Sdh$eC>mV^R~S;r(_U#F#H?_D4t4UDDG&~iqui-R(U
z#o^LpB8;ZBBu^-Uc!yc_sqa{L8Y=hk+6OpW3yD?JgBCIe?}~3;C{7KVJEB+psb8Ie
z?r6jyuabFoRxHywe3@VtMvOgFKyMnhtmw4`Hd^O&?o5RpC=I6vHzJ#}L@8F>*`&CA
zkL1VMz>2rO@ma4Cf!ec{kK_c;Dl3y&gv%OIo|eQDewumjzvC-Qf2KkIB||JfrmDfA
zXJ&-zWx(5xZ|06jW^|FHO>zd>thUS`428(|Bh<hOIFk7ju;o25l;M%t=#Ey&;VEpB
zynTBRcK_z<fq<G7a0nYW%12*<T1jfx<-bqHb&@~ftRWwI-1LjLktaM$My{EbmW-<~
zcX_U9FEaZLVk%!O)Y3Q@4F!)|S_MN^kS1ANv{T^{m)(|ERC5w6{O>ctgB+P%eLQ|X
zr==62__fC2YmAzlDu(B;uKW4NJ`uiezjY<KL)-0!07eI9`fTY3M{B5wy*#vAxxZ)Q
ztGAa2%tl+}<?UZ#fxnIahHMFj<9yZ0-9{lnk`0>y8cV4vSm5hxi<w&{5G&u&B>mA+
zMPZ9_XhZ@!l2=)I;4pFv%IZh+{&pw_kUq4{Lwv@mZoezDfy-VpVd(WD0f&xS)Gwmi
z+8q;Z{Hw!fa=d<4#3ncE-YH=vZUUpnw8Q775~1+`&R<w*7NurTDm}`SvAUXkSsP~n
zlyyyEJZ(_j@)>?DC9#klwFYmz_dq0@jC*ZY6R#b}f;P(pTUaHYcq?B|5izvd-?XW$
zT@7h3f=z(IGor10lF>Hkr(>6vP34{xjip_z$cE0<hXJR@2UGkL&oVT!N0p11ku}K2
z$4$VZp78)?TyEu}L+QDC0XtCbyZBVSFfId>knYTyA-d@ugG3ZLm3w{R7|64{^-FTh
zkT1Kfh=>SF@NbCoi`(A1Aa2l-xAjbKlSxi_>t(#hV!;$f+;TBExir8|aR;b+@#R$Z
ztNlSe{{6d;XT*GZuPMT@LKzVo4|61*dGjoB@dVzZ*<fb(JaO-DEVX1t1ic+K{7wgX
zSHywHlfa%ljqJX_?8*Dr5T-X=CXToG`1q6|h)XB0;-{Gx5zjfdKVcKq>1YSe<Kf+R
ztLMMTC1E`^bntne#NH|bE-z{as=R!f>&roymoLUg*KFE$q1re^zk+91y4@MrN<v~l
zAGP>np(*>tvmR`ajv=CC>X8ubXfGb7doD={9~;~E-}AtT)KwsA=0cRX{Qa930Kj?c
zL<77>{k*3EK3=%(HPW@;zXV#d$@1~W*!S1JsojZ964+e16`vnh?v$Mk2&O`M^?RX0
zp0`T~7*NU&oI+x3!Eh7r@g3uz$p@_yAM0s4e$~x8HB>qCSMUJVE+;%lxgM|`EokhE
zIAvHK>w)-v_eFG?kiyW*br+&_w+y$ADbw2!z#iz+CiY>e+ah=D1zPGasseT_G4a>k
zuE55j<C<&?mi*~&_GQ%j!sq>vO~ZuIfqe-pBjC6%+fkEnDta}dGWvu6IY^Sk(6r^V
z8v<|hBi`~g?jeS8cm_2R5Z6I}W^yi&<#MAsGI=Wc_|R=JWMp$OQK{~Rprh}EYQBv?
zHf4Gkfi7E$XPqmia#5b{!qOxhQ9kEFEg+F*53Z*bVIaNhBgUKY1@1r}2Og0>Z`c1^
z?72J3YlQ6!(czz7n2Q)n=2;8G%vOk0Js+9F9>-BTT6Tvsiec{e##f)#h_EFnv|enc
zH(R*GCm%~(AH}94dmp`JI2p|lN#Movz~Ux@q656dST{Jt47D@e=z}Weev<3TBH>$a
zKbH%2rDbFU4<>T*iio6Q5rC4C(uK9>Zn^zcLLg*ACD)aSWF*wg6srf1^r@Qrv!VO(
zu8XxwPH0}J8xuqKjP3XBhOLj9Nw5_Lk>kPL|In=P)<|2f_0c;0dLXp$9ZFfCW9%&(
z$dMtovW!)g`EZrdmBSo>`*?|A7el-K&u!`DPiFBRl8*bO9t;x)W9txqM8k#Ou)5L2
z4%zX)g5^R!d8Wxo=SFCTo7`s4z0U-t7odd%|N77}*SbQbq>mhHKfcRY2LDwubMfLw
z$w<5wmrhxldvMbaCDqI(9|@?<&!xuO^I(~w6N#ht>#8J72rpcCi4`RuGaZ!6+hTlp
zCX@<hH?SpzF&*jJU#~oW58!aJu;`_v##7VBm;(YB$amaUOF8%?XbYVx^D>`?63>wb
z#W1nLEKa}JWQ#~WC*Wq|Ao*ju;coJYCG{qvEnFqwI6;=nsRJX3$Dp6K8a&HLsINyu
zkwQ8?f#v_h`+JGqE!tBNZFf`UHiJokhlYN@Z0n{M4U3-XG>4>Wyx0(_PaY@a>Cu@?
z*IP-X-HDBdgM?Udb*?N#WUa%k2?-G$**h+PdNQX)K8?qs^>XLMy-w8|CgGQ~Y8Su9
zCTmTFPhKV7_txoy>>4`7PhVgGa1e>am1?rCzJUR%p!WA~Gt2-pxczkA&ilcrf@aM6
zV(kTuPg*$Tm#g88u}K*j#SDJ)HHxjf?4W(N`+pSreOS|7XG779zC^JiNn@uEd|)V6
zhx=yZudErG@KOS=z=6Zf!e`hvA^jcfB96b{UisBka5$wg!-vI?$vkEyPCc2hh9`Cz
zb^iqi-;zg*1gE^F#L_DHrI)8Lr<<8-%O&2?FPCLrXNw@0jXIO<hq<eZ3s~=KF?+To
zdh>-lr}uzz!3Bi36obL7FdCO-9Vm8RjhP=cJEO97zNFImO|sV;e6|#gRi)B`G_(77
zhVkgod+pE{f#43R*j;V(bbAn$Nx&i?vuT-Swk&4kg$k@v{Bs-0QVGN)QpmWp`#`)N
zE36}Yz_ow50I!;NRzx{?9d<2Rp>3DF$Yy?`k7f_FMhcyJzfgE#)7rx&--GRkFxv%B
zYg(Z1&;zfV&@-3qI%u4W!8_W@kq!n87PgnCDjJ2&sG7o?6@gZu8@N@zv)Xe{AG!SA
zo1oxpesS@j-@!3f!8~EjQvBlBIMc6Va4T3wGwVM=`=2e@h^-D8OTZl4FRZLQ!)*i+
zW2er|v@i_Jy^6y`)Pq{(0Uh|q<-z&KOpM5<NC!{}Y0u9yQ7_ybnOUE=*yG(~wiT=X
zs7Hfv<kn|{g{uTt#swVyNF@tB<NULF6i~}<#aWX8goSl_b+(*Q&!vVoIwqrU)96fe
zUMHN>3zfene63EWN8rBn5AK^Lax7m#6*W}ZPTRU^R0SZ@mzm<^AGKzPbMilXIDU1H
zNo*{#yswE^#vxm-f>Jh<g%9esu3l{SOkWqfXKW}_7iY6Xiz2ly&e`RX1qb3&aN;Zs
zv1p59Yz(cW{5$tjOd$Wu@aQQJR_Vd7d5akgjH>rQR0gzt6IJ@loxhdSXK>BL+N$Ew
zqmrdA6<>~Cck|-#mwHy^GtJS8@dQM>ZR|A>h#HfJZq_UWp!Y6`u(e4=a_n|W6TRn-
zt07#-FIwQ?a$S8#Q;^fm-I?P%ZmOYP>KsHP>xW{RZ}*rVCH6qmygOhhGwkibOhfZ9
zlXsgC;Xrm$9G!X*jqi>kW}+L*=R2}-qN;wThb<xg`siK$a##9YS*nNb<LRb7&nARt
zt;jCaQt(4V+ep^!=|RZnp0=V>0neh*&46OAP41Z=MXBqJ|BAWYVWsGJU~*lS%Q7FI
zRJHgbLv9FGn;8CfZS@<W!Z)lgaqdNbvW3Hp+0YD)Kh!EkEP$GgTe#+pauXzhd%05l
z;|Nus8EgJi`Jq%UjttR+HOR@M9+8!gFZd#C>U*0Q$u@XM18(<KF?{|cb(;m7kGSA-
z?mX#mye;KsK=cM%FU*i4gqV80im(byZ<^6{ViEylSU#M%1pq0pNXln&&W73S7<gFG
zYs-^@SAf{k3^q@h^nf`CHbmb7mdrl7OAr)JHyNBWPb~J85J2=N%{d)-T2#!nr%;!^
zTQHw{mcssjlA~E68<SLz^6%c|3qQ(=PO0gUvx_m$|5=~y$NxeZ!oN_)4B^jELYtwp
z`39e6Y;ltNjagf++rt87g9CEC9y2&#^p2rn2kb?lu6SgI@QVYQkpxbswLKI9CGSw;
zGUP)MN+Aje3g!=YQDLx6aD@j{ld1u64~0}r-Oq`z3hJ%9@88_l*C1Knd2;iW_>M)o
zPk)6|f4C<pW6YBeQzf^G$jZ1>;e)5=fs_#z{GWXH>?23=h+D2Db*(>@?tak%HIJ|&
zsnh3wGBaiq#xTb@QpnI0!hQ%9`KUub)c1yc=bwDICta!1V6N?2KG#k6#G&kM1K7Df
z%q9TaCzDHO!SoS_-cYz{$kGVJhy^%cL3qF%kTU_yYs%<EEV;5N7U+W*fR|QJInRnf
z_)(KMM*D>gng_f6s*|9lpRZ{*21~rQA5~7%`OL?nG<XnQgqwXdo&Eobe8O#leua^x
zYvZVYr{JQNJ*8%f>B2lYdAi>NT3noMm2aqyxt;ZrUn<^ce4{4*MHHPmm;d&o_~1l=
z9R+tR;2)s{`MUFti~Z>%(yUa-5DVbTq)!uzSmS9+V+hrsiDeW@PJT<e?RAH@y8mfz
zw|Ht{8>w15mOw3$RkRCEbhvl^TXB<6xAhlqDRUekF!P6p)!qyRqu*ojL(e2D$^oP>
z%ko6A(MZwaGfwlmxu*{GK=$epRoKD-rFSIBsk!`~lU2Of^4vg}mNkd@+MM>OQC<ib
zyFEBEI3qQGwtk|~!*)~t)^p^M`Ic?7jPn%aX|UM)2|x7GI*_E7D<A+Dn9ZvQ<@R<l
z0m0LRzgVx;_+`I6dxaGRCo@t{_F8FgZkwlQI|!Ow>cA!zXQ%3~pL{nmQJEo%7q|In
zt9bley<*j?8n^r8)*Z)UNFMK^)<{d)L{?N6X*i|ie;4(R+}ma~_IiWuPpR0>3R7*f
zeX!)S{gwNPeuiV~(VGS5o(Jc9PJtzg<&3GbC)lPq;iUjk#4u2Az)%#+Jo2$=u@uX|
zA(=fp(<Lsb9W5hQ|AFUri(I@X>qp%{GCf;c+e*tJ%C;of`MI!mxnab>fP(!(qgt{R
zbZQFQl|_k#RUB-doo;Py$Ag@g8o#NxRPznQx|CU(v;64xJjkhc<_h?q#tYoDiu#&F
zx6>6+7bl{V`wCxFllM>ijv6~x{V*{Zg=2d#JvIdXZ7cd8ePf%?KeTPx4qI1RF>_G;
zx4tjeCim@!t4Cf-e+pF_x!CR#A8zWp{tRB4ri_`kB8OBryLq>XLRp7G!q2=+fjea~
zwZeb;#a!c7EU|~3HxKq{g9>!P=uda?EhCtkYRDam!h0os7w^8V=3*wd_{r8m^f~yj
zmwCp;UyYbiNt5-D(G&^+JqB96%ZP_ufM_ExSEkI6)F-4fbF>tlnlxAp*AbgQ4RG%!
zw8&)%FIp*RSJTElL|YhWYQGo<ex^Pl<?{J6h%e47ok3!_nGTINRp7%E^Lq}<--ix#
zZW_++b-jR`8<wVeEIDa?lV;x;(P{T+I!o|CXOWFC1H&;-GTYQ}6!7o410HUTr)E;;
zQRII41Dy&bA8xH5;40Jk5vqt=a^Zp5wC4Wpvq3(qfxtH_a__uaK8s5Fw(k9FWAr2A
z2u(-L%dv@h)AlfI9TmsK^-<4e3|5doD9Arz{##U3#xm#s6Eb1_ZJj>D{)QWX)f<!@
zot(V-!?|Lsh+FCf2F~Ec2VSD5_gg(>sZyURjz<_MD>k)_iXI+dvm4!z(4_y}x^n7&
z`!A@1{smCt9#{X-gCc!-axt}S3}V!<$ux%1!5h)Un&~L{RP<vVb6*=ChE|=^njuHj
ztjgfR9w=L4G0C9VsVA6Z-!o&<b}w}A$*%vQv6e9we)-Y3T57g0`5~1`b*pe0{SJe;
z2YOOB8a-4<eF385O)nyN^YES84#kv>Z99!x5JxkKqDLLO7lZ+UNCWE2Q<K%t7jKuI
zW%vaUX8W8h8-N!9AuJI-yX7h?{f9KjS{Y5c3kG9sm%Q=NUU$g-&6aANa>Fic+wl*@
znigzYMYB8Bjnz+Wy#7SLo$GnHB6YPwATgHz66%13&y_S=cQ5#TE7zoJd`y$W9QFPn
zLY|I&BJSPMz%X+OAG|tH1^B!R=y&r2<=nn^EmsM=e1sq1{CL{r9B;vA2G|!?w-y-L
zevs{co4(tq0Hb<PI=M8uh;L_5<pF3I5Wz}eWtRCRx+9$mJJ(1Y)uhH0y|!h~1dO}v
zI<T*5e?COpxYsqBv(vjK3^eaZb;$4zxK~|T|Ehz$R|8K%6=v&lARc|mVBf<CY<xUk
zfPaXG51_~?G$pWp>39B;c!*D|6sY*!JXs?4_iuQaLy>DbQkY^TgQouaX|71>foT|4
zycq6UiAM+ep3u?c&i+Ta5H!-VzL*|1{xg8O)TBbF2pN+d&+THI;Xyf%Dme#C!q(|x
zPzeRjK8uw0Bd1xAdNc|x8$Y5KiSlk8O+a7mTm}|b=-1~%L_&(N$lC5SIR%^Pz5bJi
zrO6%zDYF~Ko;gugD*r`eHZvYFcUX}h{?e0OMIQ-Eg=cZF=|?Aa4?VvRGOalbim_mx
zF;krRCjX?=Ex-B|tp0t?bxP4AkE~xslQC}cMpS)q0_^TCZ$qBEoe^xJ@CryCSPOGm
zeGQ~}icR)GfA%+agc%|C+)KmG>%;b*6tlTp9o{R%T^!+Dw*Txw?7Ou+)s$P{arUat
zUN-5)+bRz$z{LWYVeM#@9hWj4(DBZzeY<atR_P$`+5vwaK1+!}Za%Ld!^s|-7U~d@
zm)Nd#t=eMjKUsLEqoaeEekTC(Ts__xO8LL_Bigup0k8F+9^@ut9gH+O8VfZdY@{+o
zLBu6G6@AksIvxr~SZ@Eezm_~P%JgQ1bvOE)_u;PeBb?7H*c5uV$8_OBkFoK)CI+wg
z8mj}jq_X|=-4EfuOe><ii0!TOZDdkvV>k<aoAdK0zCpeHxLs3pY^?dlU}8!}#;?9;
zT8|H&SQ6lm2(W3O-}YhWdW%==uQxIqEVlxYx3T2)Y(dskfmZmWH9kO7%!5SwKE)QP
zB{-+xLzgqQWJYytz;e&@*vKM~8C#%!Ail>+6NJUF0<%}>7MH(WfN?K+JEYCujdn~n
z-N9~L;{6M^I!23*|JB@EhDF(~ZNnm|fRqx#(4io$bV`eKqvTN1NXbwlpma(%h%^X8
z2nYx$p+gT{N;fJcAo!j$<9)C7thL_fd*0{Q$B%p4^d5(6=DN-!_G91oLw%->`FTz%
zROj>e`FnkBP+}z~NZ@$IQSpyD6rr4^z_7?ldaU%pF0}Hu`~WVilbd5k#ZJzXQSR=>
zX^!r7ch9-dYc^*!W+!uo<L~fHS^{H~+L%v`j=mlz=4f{}?M8Fzcp7exdG?F6nN%J=
z_<mF3WGx#hTH(u;*en(9B7JgAFM#Xy6_UmKj8Q!)Db3H%4(*Hd0#B|>Kd)-qEo=4{
z++pL!xgx0s^4@J1R%|j^N3lmXUMDrLnOUa`4uiL-kTi@3VRQjFBBbD1MwPoBg|OP|
zeB@^YJGAok^e&UJeHvZg6_cCbHu?h7R0Q}IL<gyfZ1|{>d;Km{Z>6QWQZ%OB-=1Mo
zV>Z^xx9Bp(yWQx-TF<WI1EEK%s6@9?Pi;RcI$ioo;%R>t#Rhp{<-;_gDzAu1AXaV+
z;I{jYk!tH+T|d{yHFLcXuiOAL7uIZ0anU9@FX(KfuXcxIkc@v<Wb!0jmD+eH)eQpz
zr~=#yVw(^AiB<;8WOd3y-7;t8K|!Nxu3g7E-6f36n#jwV$olF>p6c)&xH4-7*$izQ
zcd{MBGyh{RKE$e280t6wQIhN4=E^X)7JJrnDmrsJ1^V$}EblWMG03I;RL^@two)JY
z-%5vMfAHrdxKtKrC1vu$SB3By8n4mPV%^h>Odi9t>J3_o+cv!EZAE!8;OBn#{q@CF
zo{0F=y#7KRZf#qT_H1kRgH*E{nnJCeGBU(|r`C>op8F;6-1GbPh^WNZ(k6~|;xZM*
zA>v(CUkR;rN)-#Y7p4&TVTp^oJxjLlb*B`6Q3MZ7=$fVGYxcaB;NRm_&MAF8nD>UY
z{dX4CLstKHqlJ#nX|Z-W?*a=3uHEKCy0q;=aXGhVvB&PHQi1xgz-h-f@#d7b`O5J@
z{g&0>g~od4T8`L$ftiM~tft#eEB=s?2Q`7*#pJHp0M5#^1)Au4B`@~?7IM(;1A<Oi
z*r#NoigNfR*!O-31irZ7W62G6W4hGIJlsxDXOSh51NHQBY#K&IpU;d6kl-gj0;8}m
zURpBAnj`P~z`Hxw)A(+#{-(9$@s0Y{P-l+#(EqCDul-<@mgxGHDt?Z~@Y2;@`86$s
zcB0|Nmb`(;=QW#t=&vS3vX9gzwL!~9Tcv4Btntzejq%az`cUl2F5SIS4%+Tk8Y8Nk
z1D;tO_6{dw#s16JkvZ6c8%di)9WVAJB)lN&4k`Yxh!5lGH@zO{B$4;Upf4aEMk)**
z|7|$?2q?{DSi?|kRmB%9q?#mKo-72oqxH%}b=z5XBLj;;-&nvv49RalO@Qq5H|{#N
z7yl-+!8E5;b>F#B<1k)<{dh|^_Gdi;28beGukF5_&Z@L!pA;UQQzqZ`WnFt?-KMTe
z*IA(Q^Ors$?Itm+(hI$klp7~^$v(sZMl0#5HaysPoc?x|WW$yjN&XC~HY6h}!T&z=
zRZ!C{hWx3S0_T|H>8zbF5z<LO_{K)inI>|ISL|8!BkTiWa@=BQItNm8AKE-c375KA
zxi@N^&1+J{OhYahY+-$OLx<!*d-qZ-EbDRIwAx`(6J-02@u0Dc|M#z2tkEz*meHw;
zn-4)nd9r_&mQ-+_dAX4%|32oaw0ToQs-Mh8aPUh?X=l$T1e<)#gLM$P!;%(fxum60
z^5F&l<!g+%#-qQL;tgiBYqbL<?MlqimJBby-Xd4Q=3c+8M8A|ewa<^$RzUmU#BWkO
z=~3^VeoAH3Vkq6bIsN>ECqp`iuB%%Yr044J&J9J&82`dnt30eo4{L0|T}c=l+CGHY
zaxjdYsaiYg`ljn}++5j|wL%le<zF(zw1b|f<$?E2Lg=Bv!YIE6gDS(~3l_mdsrje=
zQdM>`O$o=(=({o4<6`r48A@EaH=BQ-e!HK{Q~q?Rg|WqD5CD=}yZvuJ4sd+kqw(=j
zf<G%m_e|T;baL*ljGkvuSmdhbI=4K$WU3n4?cwQJXWFOhZp*=A)*2N~l|95J|Iwjo
zl}WeCIJm)7?3F4wKoQ<MGopYjeI0O%N7-rzuQ$VnW(6X$CGcn%e`xFI1am*AU#pwx
z>h7)vSlNAbb<4%B=%(AvK!OMmGw{QiLiF|4WZb@hJN3Gyp`3<yLqTyADVqFFNrW;l
z(7gvzVUjfF)!-MR>JIcj#JF4JCtPNvTkjM2-1bh6WqRd&4DpMrsGi*CUwk#V9|e7T
z3Jnnu&#<WMQIzjEEayq6u2#C^ZX;0+?f7ac4{PQV%v%)U+3I$b%j<RR*M}VX2{fsh
zlyaX)d_{u6c(I+A&kCK;<IK6_^ff^^g7dLyf!ZNqhXI@W;>1z6z0!%;C`=LWv#IwS
zm4S&oVH5@he`HIcf}GMh!v9sAC1YQI{&fC@)k67!C|w9YGT59i%$zkm%a>lJ=|u__
z%TR1?x1S(Qcl3q6rkMv9vbI&^t>(=c@|$$~=S_v5#Tj`M^|iOaItE4Xj(S@`JD-=e
zK}1<HE=*Y+vmSYOg^@Uf0qaT#vQ?5=K#VRZ;=xt_JOaxR6{3TXH!gh6^f{YivjQ8X
zeR@<wzc7!Ms<EHQb1OK56Xz3xpAKZ=Vw^))u8#&DD3TX+{xD>CI&T}OpU*;F<|OM7
z4B76f7d(L{cDv~#<31X(CP?AfTHVzhbXyC#=9;?7r|B}zokk-FFL*|KEee?-8>;8B
zL7m9yQ2C5kB=>MzvDxB%)c1UU8@`te-E~V#rDf{l3bpUiVPI&Ol0os-&GulJjIbrO
z6n~T!(n1HyWsEF(m%Xjp^$EGpDyAD}?hXAci&kuV*l@g#gu?~y=(FDldk4+Tzhz}2
zKZkiMa;k1u$Lrj_V&+j-77?|^40pclmSZEEu5HTmlM8CkPQPk?uorSUq<`uD$c=;&
zH%Q9HNwNuwZ%zKRuqmKd^g80m`Fiut=W=nMIr{>!hJjn8UM*w%lsC&flWu13ZY_0|
zvLscfX|*Z+<1YJr-=iqLLv&3zlfT&?eZY>9FtG}X?L=?OrV1XYEOz%vj)Gskp_0Iz
zGr6b!nE=^%@UB<&e3-3*cDuKL`o3O{e2p^+9<qMtu+(FAi0p%3JF;;k4bn?ma=5c4
z6kCmVL(^J=p|jRR$YDhp_X)Hv2J7++@;IjJ3*o0mi4ERjp8R92I%s#yI?5L&y#zRJ
z051+23SNl<)v$<hj{&)2(>l<pc_^oVz<X^MkcJIgV0S>aDOKf6in1RI`ap52_f62j
zLqS*nzeh4qxshzB!=31Jc?!a!AiVhMKT_uKaPJnW9?$>nxR#0py}57GXgC)fPc{at
zCRMu>a(qq_k3tujnM?Tue1C_C<}J7GPxPriZF0`JzeMxUa$M~t1ph`ZZYLPtfq~RJ
z{2Osv{m;Iwt5{f)r8Sxfa6wjB`J|v%QOY^*9jZu1B-NeO@m>+rBz!#|r~z-&G_iZx
z&APyPcM+9YdxjPivU1+8HX)unCHQ(89!Omg_(NoBvt04Bl>QsbI&uD&^1jWUc$+`p
z8fies6Q8_mxuUnx!Q4*v6LMfU&YeT&6oPa2@Z0EE<H*sHgxI!cj>VXJ?T#DHvdrn!
zMGK;zN{9jZ!Vc8chK2p0R4}{oY@$|T;>A988=pDr3E6FI$U!l~m5cay3GjURbOFis
zdW8%NX#lH<vq!4Q05E$%!Zf)z-jN%w<+4M~x<v&_4pX}e1$p#ktm-&ex6@*vu5Fp!
zr7V+kC3nd(@}4nXGw(qqa{C7vMrs$b#5r^i9^cO?WrNe7HWfw#T-o1`T>MDlsfVE8
zu8Mt2cRJ3f^p87x?)j5do2;DD=qzY=N!ik4VrPnNw&jAE=G^AGetSqzlUmceMotsw
ziDgPbnFwWbi%RRA3^AqFSCY2FX}K~Je&g(xHnv2_BGX2#_RmaN{1Gwcj>b+7aXpK-
z$a`&Yj$U`>r<L#cmB5yMPEppTcN4BklEEYcO#SaM1J8+)0g7RIQTD0s@+(OYv<FQs
zj!_x|R|az$srZ&_%BJPDC>%03s|fje_p8cHFFZk3&Q_`sJbqInD;a*O`}C^51u>b=
zpHLQMr2qzXLX2?l<d@^=%V`(iB#8AZbF{dqz@D%TJTU3Kc#iZHJ`Mw{KPFG^_4{!;
zS6QGjLZ$A)8c~24OZTjXualD#1#$sHn(%Pwn?QmQ@n(K=F9;!vxgvJyuXU(R<7gq`
zQ>yaOotzV1yX2C>2Eu5)b$`KuuL`&je(depvA97&uf!eeKH1Hg0Qab;5<Ty+wOxd#
z5|!eezSW`7&ut+*V!F*h%9Wou@~SvM9e~?81Uh{1SSvwU@*j7g{s8LIXGE*FCX@F&
zdL_dvdC^~uJR4J|^n>7Q6NDT`tWB+$@`>!<yrHy=;^QZ_hUS+f^Gsiv5holB_cv1z
zeEv{kq?n-U)(~vxhN)b1_4C&V588dN==iuOJB>KFQvn)vN2Y|{ob*ERsIK#$V7frf
z&rK(D?fTHctE5I(TV9agJsSme7Nn$_%eyo77DZxHYD_&mLl4f=3f}hm2(11XIu-tu
zBY>|7yTVZBU!!JX;DTe}`-35k6q(7;^RU-0Sj9=hUwvq`Dq)Xg&E07Az`jTaoHF`7
z5|!zP2jqQ%m<Pcsl_I2zdCcySzt;WF^7*H7u>D#z{pvOLv;IR?W*Z+d9p>(`yLw~j
zxrVs{34IOZH-W3nhC4&m#fT;{y~@Mb59YPrrGf;T68LvdBxp*KfWS(DRE}IuawmR%
zftp?|e{$XiPZujtkX`YGn<6A<2(N%eX<V?Ev1Cu<^Re8TAeX_BLr$#%rDvP=wuiRU
zoG5=mAI%YuZHs(iC%O(v4!iJ6>flR2&uFh|4ZTfQ`zK4Ju<{dE%J5et?NLM_bR<8K
zasjNv70)QJJu~)S)6~$-KP-$%xu0<QM5#HSh4ZP_HeWE7e|AeFT-kJ?vq1U!fnBk^
zy#F?i;){XeFa4u<at%yVws?U)@wejqQJ0Y*B-}i;)#UBfBER>i$S^@wtlvV?LgQ{d
z=NYGo%9eit6Y=(vgV)^9w_z!ULrfn-Tx=7-f8Yb|46PYMY_~|hTX;%x+c`NXsE*!v
z&Q<|^+#pM}Dt8g$*#<*E*~*qaeoF3hgrCl>Tju*<`kiEgUJ+`$N1lbu39EfOCIml+
zwl1?{B&x6Ax5mC7chL#PR_S#MU(GJ0LCp^~By7fRnz?1>6f0!4T^Tf)$aL!Ya@?;@
zxe<^CSwWutNW+~In9f|DqxkEt%PS|#&k3&AH(8XtI4xZx=t>XP7Z#G{dwry<@#Dn$
z1l8Ylz#xi{d1;*DMcY=t-Q?w;MX?qzTd8h<a;Bli2RrvQud?v3UcgPuXMx%s(lilf
zC^xikM64jhmSvkJj-QQHZv^<*dRducduNOsRTjg-BXs|li4%|)kVvHY=VWfc<oy2K
zt^8pld17MX#9Oxlp1#VGl5lkIn7=S-6t$n=Bw_<F8BEU+!QLrYWY(0z=1yS8+?4%)
zJ<SpCf=4o}y#i@y`sfu9b1wB?kxSI4evc83EN`vLGQuL-(U0K`UafuHQ{?YRw%w!R
z#n}QSilKLZ!s1=VExMb1Nokh=roXpi=pf@T0rj{ezQ^2+_q8nH*a;7@J?2(p68mXI
zRMyreE80XuY-KtgIx6}#Rj?>7Tq?W=lbnso``HutHiV40u%zudo&umiQ1jBy4E}f#
z2dBiR1<oI?n{bl{56zWyT;=E;lqbzlw=CwcifLu<O_%veCWCvc-JIlkRE$wm0q$U<
z`$c?2{0!?fixG>bdXK1RKCM;>y1UM2W0I1H0F+BS9;~*Yi6O0UuR+bxFxa)@s4F@A
z!IaAH-ITrcBV&p$d;lQH?hwuwm&#`vxVPe!g{O$Iy&f)aV-k;8jf(S-6wYbH?rkM`
zOh_*YBZ1z&85DW>ev}qbj^^fw=LB*vBAK%;z^0OS#L$Sww>4|V?H-tK$gQc&yx2{j
zo$%l%OS+0KO^lfrsFSVwv#(GCrHWw17_{!2_ZZen(_96pAxjigH_LD45`Awka=Vpx
z@eN+A-HY8V(moo@KNVP5P2?lO?%f;n6#{jl-Qh8^X*QJG44C$eis9V|gMM3wYU0Ao
zv3<if9If75oLzQWxRD*Ly1kLf-+cjB{<f{2xYt%{Wo6}9S(^RM)(7C!%KyDXuqmYY
ziQ17w$lr7%AiDbwJQQC5ka7`>sDQWHCx9dp|0~TXJepQ`V|eTT*)s57d<FB%FA`+z
ztrUOE`~nBFB(e}}82O+KHFk@M-ED)}Q}Uq$)R+ax!6Jd6NFL0LeEF<Aa?AK*z7Dab
zpE<?-eEmoGBglO!wJ<d<hEHblrxtl+w{^FQWiQ`dP!wf%)tXB;67AI~Gt171dN{OV
zpO-4uo|N*5`QeS!xVVo-`G>EaV1PGOIX}|VX9+%9s%E;lH;$Dpi<KA(C_Pi<#lzGZ
za_cItaqAUOC)dXGLd}?)Dlx~-M+~jeFKd=Irt7SJggoB707flS4P&U+{5hIF5vY2=
zZnwUvRiWd}3rJW_jtqPNgfs*>k(56Ic(*kLVBXDoaqEO~D|l8=4Ub)B7%=jBYk2?u
zVBv&}5{#3n`@<QYH|{vBt?wLiqKbj<nY`yB&-1-9y$^%P!ishOoqz^i2(|UNr1d?0
z$A@6FZ0t)#%9V9;07Wfi{Sz>K2{^Q*r(buRtWl_17Lt;RN#ZiFeEgW4R@fO?I0+mA
z0V51OG)(&cHk*8z1eLFQgUEzNcTrwh;~xce?Y>vu&_mB%heul*qXpHW77U8=gcz=u
z7G;ntX;{xYQB>nOI7;39&5j&syW9yLrMcKzdQc0@sx$ryb1>T@T65GWwUj(k@6Rg@
zFGgaDjN!qFP*bH9>qA!63jqwEo#DrTKo|d!4$G=87j)Y4ai0nq^i5ESfcy0#mt_Qq
z&tG7=Y~t^-TY`eO?AIepFR(FyhIb8$%)gRohhM!;SzBM1Uub`|GhvM1XDbr4&bUK~
zYv#g2`I}EM7#T<JCy>_eoEC_F;HS$_#H6Zne+S9Kx)1oL{IB};=HJ`Buw%k_Xa2a_
zZT_2daLx%xRS{7w%P5`A^PLWxWOHzg=})JEDN#Jps{>uf!&ipxmi{l16hffQQjwSg
znwC@i_Mf4}Pr%)qsIiVT{p{rDN5^GQ`C(~^6<EC%tHK@Z?Jdzx0m)6kA2GpSg|}r)
z)1JOOuLuJKO)_7E>^4m_M%xAO!Q}{_qf!!Q;bz(-Q~vN@K9R))n6wo3$9*yXGRrQ2
zjzyiUmg-Ec{AY_~f?ONhMp(@78yWmq!YdijMVhV!s)l4T9xHf-`{l?e@#PL})T$^J
zCt0K0(~HJ@bh%Ff;Cl1)0&arVn#@A@8Ff?x6YvnXd^%vuD2fa&@SG($K{{6x-1XPG
zro46*%QiH}Lu;i&YM;nXlfhWdP5yLCXLWRWLnNxiomM4Nz;D8Sr{GZgKsinzaW7SC
zKUK~^HBGFIRYo`CnZGM?)lqdNprn3!oMUymsDIVbCB^~a2wmZqh2O0@v6|R6^=P2g
z4hyq)yiKb3K{`LSS~Nzlyh*5W3Pzu0FZs18XKY-}{!_X1-Y?yoA~IO09ygO3H9a^q
zqzE}tdbYAE50H`*i-(7gs%T|z6xS<Qe#0H12*c};rQWcRv~$*J@5ttP<!fWKdS!dF
zGw`w^(%nytHZjXT>W-2ITIBz#e?FM00NW&5YhSeAT6)oT3#GBtjvgEb(;R(Yy{ik2
zIeXWm5BsAW_Elt<raeOE4sZu2vvrG7_R3_sXGS8e#*ugKf4&n!cf<m(Xhgi@g<)%9
zq0f<4sH&xhp`>y5K$(ULYkw*8fzMsZC*#5sK~G^fq&+$|cqk!SLC>dbq#iz)?L{nx
zItm&OZiqO0{EYH^IG5R7yeDi>^2HvEEKsS`GXp`)Q+c+Lc`7<(TTf*#?K5w?63|%b
zwiYMo(W^g?#(z4!QeVlRUhZiUnNC-2Jqo=cjA>QIlakK(;GFio^ulkCK2uuu28>BH
z9%V!u_yZ|EVLnQVALnuC5U}KH7FL5n>Ts~RD~MN$ZKF+&+EeI4lb(iIva(NmFqA%>
zpYnP=aiK#^fUVAEwz2RC?tX91N?OTxZ^85a&IzXeOig3*vF%P<@6FHy+P{JwC->4C
zzp9kKu1A^Kr~w~4o}g*Ej1QR;P{cY#C0o-%D?sGIYG*ht0flh!+3(grkL=f=3kDd=
zzPkT;`DDU=z_6mb^uP_7?QxfujF)2b<wMV`9O%aF@OUOS5`&1WT2Rmp%sj{uc}88P
zr$*EBSXvjNw0w3$G{^YY%3I=er85|z7L&+zT5jqXl=*MrOaI&TcN>+kSOA0UPp21?
zg{8u~EG~LO>lhs4zcA0j&!{Oy2O4PsX`Kv{TmEkMbcL+=Lj4pCGos(=AS3q~AJs^i
zv1F@cWO<Tt(_!v`HLz&WWQfS-xXtA`mn&9f%2Ik2oJdL{{2PqS`P!ePWP+^7#SkhF
z{JL(y4tq026B-FRI5MDQIDP9sA*aVgtS?}$C{)8=FUCJ)(a>H0w?B21aQ<d*x7JZ-
zRh|ZOEJ*f{OA_&QJiKF~06)1Mjcgmpe5)9<D`SZ=@-QizsyB1W7;~zB-s`+)7uaCm
zCdR0@ix4{`aqgJI8kNd|)NIUJjXpBXczI9qQ0j5t;hUK`C&6j%#K;pRQtgA+Q2tdP
zfz7*!^OH=aBBO?an5ew>h5ddz97!y|w+f^(T|SH%$IrOcZ;ZM0sln~^L^O~X9=)-E
zylf`-i>esnaiUZk>_dG|^>dgq3Et>;vV*v`BG9?J5p^fn9X6zOs^I_XOQnWn7xFZK
z{P3cD56@bApkFs@xbm=x%)}OrtX!cMSl`rjN)DGlW3m4ob=bTyadS0(OH=;ib@C55
zo==l{->pC;3DzCv8dtGA`(OoSKrq%k>tQmo(<IO))riv(yW}GsZiA^)uH6U+bB_~u
zknr~JpJDRdaK?VX$oIWe%^V6_z4((%U6RFv6}dV(uG2N89~dqiZ7C^({?}*d3J5u_
zzIO6>bXiv5?uvv&LgSmwtDGVtuLP+}`>P+-sf~&zI%iDUR2_2li<Q=7b@#T~c$!)1
zZB*4&P9{tWUE4AAR5(SHtBRE+MlNQryqX$*nDqOM_3@v!;c1f58v#1mm#;W<{iv%S
zUBjuxWKr9#?q3p{HO;M|R?@w-2yAc2u>x}>Lc(v`t`~zWT-!m<L@GY+2S!-3u80VI
zdBOV#U+AwkkQ(y*+U8Y5gCFlaGc(6IZ%Qgb`rvGy_Ydy~r<&{|7TGh~A5#A4R~Ipd
z=#Xw^7YYc`Y`=7>QwZ1&!-Tnyk<d5uup%}~uT@URuw^hG)F_B0zD~Wt5OO^C&XJZz
z4nCmlea!iaXPthGuC^)lxbNsdbwIB>m8Tv%{cwi>CTaSNzskq9!85aI1$s8{y0X!=
zw6c1t+%xTH%ML*7Sex0_wK`6|Cx%02;>_UW5<V}e2B+|*H3Oi*f5HVw4L~b79RxgT
ztk{Mltwb*G?kLEIV(#qiDyxqEeZs?<9#VwD(PftWcYk|s|7!sq!Msaw(Bb|C9#MU@
zGX7o=x*P#ig;yKEPUq~w=VYI539gNX1>k4<F=;%Y5a77p?jyDsrQ$Cxly`FR6PMOw
zcKve0ARyV4Ntw7vK=Mm`#&c70Vx*C>dR1c~A??!7WaC}=)e0RE2|srCHc7K~6E4dq
ztJyA#4}3FE3A(GZye$;Ad@|o5!zwx2qJ8H?FK+5u5dCWI0^Y?ePT%YdSbdvgM5gB6
zF6cbjACfFJ$$IO#@y0%qjy8k@#Vg3#n7|neSk|zq-{Tlo=UuO#FWlKK0ycQpq0(C8
z4x=dt*{^pZrC!wbN%S}JOfOScd3_F$0hrIv`cgQ2PyarIri<p$E*Sam<YjjHMDzbz
zS}GElK1z)JT2>;q4Sl#7bLu>+(?tIt=+~D~n>b9;XMrdffew~>%ou-x;IOhfw2{FQ
zX5?9LnpkI6Y>R^QzA_wNf41R1ylN2JNhvx;y-}^Gjj|{B=a3+${8vb*OuP71=_z(z
z`F28mPe{5~GdW7d&{ZxpXeyjPeGLq(DV#s`xS*$;u~8?7?nJTd+S`uhRd=R+*gtE!
z_B(7Fe3gguG$7s;3GPJJE#7)J#eH#YMl{d)#Z0r5Jp78mYOA8JmH1iR%fmhaWY+PW
znq6Nfe0sYjnJ-BZ=x0JNmsL@xt%BtJZZNDkS=6~{$e9{NWL-ady|~JsC&huv_M#>9
znVWqa-lF=4@!h^`V$V{6tnWGJhZm!Z_5UScygqaShQU{?9;K9yII1?8Pz>|vH7H1K
zF^F0Czw|1c%Iux&*EdV@Y=J#^jc|x2IVXkEh&Sz)bo=*mO~rdDRm9S4OGV1p(6qM%
z?bFGlhpMgcnkiw`%z_Cs7XSIp$Ntg9Gw8=YpY8ppi>Z@1bxUWzGF4HL<lyQ2SVVHE
z7E#eKTPTw4^xpHlknP8xr}{s#|IK`5vA|imGr7>Z8+njD_z?3(mpN##vAK^6ArJGZ
z!$o6=0c~{(OO9@p!(MB(3R~Nx^KyymVTInQ&?`Y2+<4e^ghsRpM8DZ1pDod&F~h5F
zB(iLK!#D#jbnCM}|7JraR}y!cTlT)2>2?fS2j2O~yjNV@qFK&@$)>)&NcwdZeBxAn
zIRtY9-iqLzR(P8+ldYTDw6P@Q*qPy|oKEBh<(=<~GY!S_-##T$Ix4xlp?wOvK|ce#
z+%PW{FHm)KmlrjIt3W*FB7L+QliN@><d++pljDlM9F+OZ_XQs_1owu7wC>TzE%p`9
zY{%_nS?nb#58$hNBfIZ-p%3AJu&Qg{P`9gNdfhNFp5``BbD&%PKV&nZBE&y4R%>1=
zn-8KUJ^Uim(?27k9v?nYCDPc+Ia~IBz~7BfS5(m1-kB_#s))2xDJv;y2et|O#?Fh2
zi-!N?CX;TWqeFo)mfusQ|K|BzmUnJ4?3hu`iX^wW<uVv`jmk!5$@V(NHhLSll-}B-
z&j0ZNafO>2H5Dp;ne1irqF4a*BIsUJ7Y9?X$p5wPfE)HBTMhV}IlT__sZ#E*GN1}Q
zZnZJK{C5eoZ~+(SX;1}vlJ+6iWmc9!3-z4^LB%1s#)?}!LSZo7P=HeQ4R3m5&VbD0
zVtl1ddZj^w<q0K`m^-#}DHe&=FX8AK#t6Rqc_{^5!c;oGBDObEF<tY={z@Q5E;%7g
zEv%%pSt%Zxx_hLPXn9Zk2vxL1InXIO06af>U+S@+kU+TyFef{?D#tp3uUBU8j!!P9
zQrob}b!RgiIz>0M?N&Q(M3cPVXiHC_GoIBtlQzzda1fv^-PAwgSzwS=cG4jEwIZTl
zy)k1o#zC=SIPOQEwZb=c_-*=el)H%YBePaB{3cUOE27no;_c(~eUXzqd>*W+F^0iY
zM4B9oPD5ekD(q)0W^$VT>L<T8v?iImuWwk0Q|opsA%oAdd2Z`}<fl_bf!$Y_Am4<c
zmL5-%n`|zlhs6Sib?lp4x(E26%aDJyTQx)##VEubq~AkyyFB;3Pc$gl6UD5nV+Rzo
zyjMf)^S8KyV)`_(`ocV8z{F{T&dKIYUVn?()SBlG0_xYkkCR0+uJ169@2@7f;T4(B
z`_iW`8ByiHV{_&c04aX_=PbYcu=b7SO!Pt<2~5bpH{d@8v(n9j&c=BTQ2cEEqxeA)
z{|oX;$qwo$npz)vHkSAUGqG0eO8)|p+g8P2WS^DGiC(<8dWSQCiGQ^x-tqZt059O^
z3b9aoy^!O4Bl5~YXIvDRljT*8u%>YhxPx1h=(NIL=}-o*QrkGR9)oNP!g<!q)p=s7
z6x6-Wj{P9T34bD)i~!D$2LTQ@RbpTN<g*;%{PqX~o)1jKZiXVQt$Ainy9PM=q!U;7
zeBKza4z4Tbc1vi;!(hwi*7h)R2q!5)*&B08FRB(zsa3BZO+sAQN#3*W0wiYcoZ{&I
zySPI|s2#XP@}H&tBgh4*{T1XCUs!w;L&eOoQh!>YF?)n%DEXE7sR!XmA^aZTV|l62
z_C1?HcSKHo*;tP?SB0uvx*A8urzS?fz7?LV>`TyUz_I`ObTy#S=twN7TFc2nJ?lfI
zbWUW!Jq%dK`H(L7OispExZK$^)cR_<x7~iVEVkTPFyDM&iW3@7xA7JzD~@YIwrVg4
z&R?r(3Nt!2-X%~ux-*;AM}(t0ct^iXUHs`>Wmj5IkO$KqZiU#{iuf<lp2%O?X6Q*6
zlny)6<B`J^W2a2F9kg5y);tZaZ*JUX%&Br!$9v_@z^e_B>vHf(y?*=Y)H%y>v#s$=
zPW*qGmes_9s!Z-86%DbPV$q0#Jnn*>BPyI&_x0Pnq8iw`-#bZ@8CscQ_Z>hSe>GMA
zJ&|Pd?p(>bf<eLfgWEr{HR{Pe0B_g&^-+aFq!WCgyCLp|I3`d<s$cbQmpTY!PA5eF
zg|0<8LJ4D#P%i(>3TwaE%0k?1VL~HTmy%#p^no_2#wtO`1Cl?Tj7Tp0au6Th<FO>U
zO;dm8GGa>67lMS$PIUw8N-J^p{U^wJqW;CLaPh+XS<PHqT2(2Nhu%nOmXU?>`2wdy
zx03qarB@oSS6AZiO0L_niwY4i5OvSU>5J=_9dS-}dy>HCMl9Ly6h6k#WH{qctdcLS
zvOQP%1hhDioo;{_$yCt!{k_9B)dr0K$NT+QKVsPf(e=GDC5y;Ay|%Gp`Va<{eE(Pp
z<?cU0LyGmUT8M{t!=l9*hiPwypL#p11eOI#BXhdV>O)$rbkD{fyPT<&k>$HFok4M<
z$!M{Wd^xPb;ghM0@u64K?m)jJN%1Mv<+G!=&9uO7;%Gfe!Boty>cfx^`!SZrx_3>M
z=nq+?lEZV<Oyju8R&p%iY)+F6)0O<AYdUzjtwYkif;f8)hSadcIhVhcq1ri#8+na$
zMA}P+lS%{WG!R*Yovef0wS~?Nt!ZHBq{p)1z~SNFxbY*OevBmR4Lx#s27D5vXhy}}
z^l5Y<{gULAt-totTh39+Uj34Kq_yeMAk(Z0k3)<4<di7<yxMs4{7Id7fm8O;`k!Hg
z05@vZ;PJq=uq_+L-Td(AIp-w|_J5HTn{o1@L+|ONXbLK5Y_zvxFlZ^LwB>-Di9%w%
z@?nSb=Pir(9d7d+j~@Izewdn_Sn0ED71rhaD>T%<2ce-KsXz%-`*htX#s2nt_Lx12
zy5hZYtb)!rmRXI+r07hzeipp_lUK3O?V@KF4E%?sHWL@boJ|q$r28li&(bD$5cSq=
z8t7StMXsrU{NI!oqi?=)kyscehN~OVAqm#@>>Jbk0ijp$hJUJeP8t8yJL4sdqswYp
zd+X2@afOx0Q&c&Vrj;|5yu-O7=A13SwsYzZcxe8CHud1!+BvmSkcSOEb*|N*`v?~`
zdslt20!=@QK}mM{3(j%h3VWRC{k`YLrW6QFQh3d}J`fJ90nzE5**(%ygNpVCypUlw
zaMC}Dd+*TcSD8iwTJ{DxGpF$X03o#t=#A?ZYtE(Gz5n4rpJ$u(6N8|5tvPCQQoc4o
zUy6VIg^>SSRWiiP$WncfUl#9jNo)NdL{O~DcI~bxD_73KE$pkx&vQF7qq=OP@@?lC
z7gm&^vJTq4hB)o5b}Io=*ucG%uELj2)+`Ci@Kt0i(=(6(Z!vle_QMT%_RV1oaS8&1
z82J-s2NTos6AA!LxQyExIDtyUAP0Hu+dSl)`qAb%Ku>CWa>aSnrcS3`sO(1^X9|r2
zO5(V<?OA-6C?2rIfP#@&Ze8dD(rxTfxr1XBT!4FBh@i>=0as6BMM^I;@jf=$Fw8<$
zqx?~6%)0m1Ue>1{nH>&0?M_yW6|#4W(jAN}bYbW#mu=oF@3Yw9F>LUQ(1pN;718kn
z+oUA?wBihiyH{`$&*Q6@ilsRG0}j?4<DtX{-ylS#i!7WsCPqTLN=2SSRc@b7Bl6O)
z&u#8UT^Z0$p_0R;U?E6bjcK>rMILnVzt!kxQpM@b0xZ;^_Xwdfe~GC~dpXbm@ijlk
zj0*2+gJpAl_Q9V10+)&;$x7`z&*N-qmwriIdTf<(#rSgB2sc{3_~;V5oXvY%T+TGJ
z?uQ^W<#IkA)lh|Co@f~rFhK-HyWdW8ZHH4F!~av<U~2voH>B;Alt=+QI;9!<)0If2
zfSy<{y0|K9@L;+0b0q97KvQ9FQrwF+^jNVi`@LBvFY8rq)Gm$KDA8_g31uoUPey&2
zd+M-5_bB*^oWv9#Ujgx$qzVL@-qQcl&Md|;C1Y<hHL|p=@!qKPm(rYMF?1rS#Zm5(
zsUaLoID&iee7E@UTJOsUrd7(R7FSEk<w0wh_y?G1NKCSYy=j+l^k2W`aARntt%eJW
zPMGW=%I`}#^_bYQ=7_DzZ!`#Md7afF|LUG5aRI_AdYWiW_E8z(=J=k(Z1{@ff{3(M
zq*x$?PmG9bEKSvf2e4Mhx%F(_WhHBdoxX|PlKOc&hAqkiSUnyJd3hR++aA&AIPq0+
z6%d<_i}+^A**6;%;XM9o*+E|xquZs}N_kRHSD`;T|HVj}+vHE+`iR*L(z!vYZ}^-E
zK(E76LcpagkaXqrTaA+yQJ+-jhQ3WQqN4KZy7~&C@#?pX-8Cx4S-djBbo*c$tRBK&
zHFMF2;RPpbf$@MP7i(nTEndEvXgT`4dL`F0CQ7JyZ`XZ>LeRChp#K$IotN_sU721H
zwTw%O!5}CkICro19+wM!+^2M(9_dDSrwVKq6~+_*>&LICqCxi_@Z&7_HOZ1b$&yLN
zeG84$%Il7?<_=C0v^=rp2`fhagWvYwQ^Gl;qArX@^7Q9w)GndF_<yj)Im4_xpMBG#
zfwd+N6qE@+L((M+<XMB2P}^G?DaPY0uR;acZQP=AS5hy)tIG^_t5)5#R%tb-)8v?q
zGcm{)Zg@WLRiJtZ&&wt~BtHK`wthd1Rs=h$rC+*6IvUM*m57--JWuqk@EtO1Mmikk
zQVCSb$2JkzYrFhZY&sEm1)Y+PQbdvuq1=zbfR@wP@5xp0j7M*@jZvC=Ok_*y;L5*H
ze;;K8sGk`^n)Bwb9ljjN4j|_-L)b}>_EZ?2_1{;oCCO_o_PoMu?18yJ>qrvlRc<@t
z+S1>#%-1%TSkst#zZgbF*uMNTc6;x=?d&LDTm0vtr0V{5Lvyt%u{LI>gB?ZQN;OLF
zsyrQ($h(*)m{1T;6yqp(TG>YmeE+IL`Y(RZg5)biV;b_*8;V`_2N!Vl-;+z{gbdh<
zG`#_PDm;DpNW=g1pb9fvv6QG;9rDs}Fj?y9G-@)3YO3qJ*z*<2(F+7eM@M0Ibo#Qg
z-ufL2{6}dhi0pHX?yGNL2lfwJV0tN590kRm4X6O0+mCWihbT)_GXxVEhgJShMz2Zb
zLv*mFW(f6012zPhfB(6!aJ*{-ct;j|EW`0krG-&Oko-U8IJi0gvc%6WJZ=aHvmhR1
z$G*Ch&eh$>OP0j-Cwu_>!awXs5(Fb~3=2zU?A=mc>AJUl+e`9Me*?6?1T4zUV)Wx1
zoP$)aY+MQ<yYv9QO{#T_0d7?vqPT;ujI0IqD)k%@t>!rVto%rd53LA`nXuxhKl}`U
z?xL7|cyR~UvQZKgt(Lp;%NPj>w;RT38H6MUFDO{4q<e^I+Hd};Hd@<RrqD`B%>0?#
zO~5dSNPQ4>wx0;`$ki(Fle-fEVBfmre|dLEwHizQ2dIU-ZW`vo{vN2v%m15@mW@hA
zWSH>ElA?$IzZ~VBOot+>udckzWDd?*GKMR2TB==E`3co3DbpjdLSB;LSa6B*LsvWE
z2dAY9{p<WDH_7@~FwFxy3Y`R_iQE?2^LR!y3aNq1hnk)j{{Z|Ll;)x!gcr+WC-Z$!
z+{+^-`|VP+ow#+W1d3b}E~F?fPly2pxru>4`$5mAS8V(!BE<K-4IT1ucxlfs$J{x;
zBVg@C@(p*HZk98SAIOhBp}o0XT@=-oR4muxuK4G(Xnwu2K})?&%8gk#S$q2feziu;
zt(tuW{)$M#f{Us2{#WYu6_#)PxvBHOhECqY1oK^dinMYC2Nu@mO97<fAPpqpGUtE9
z4Aiwu7pS)y=2lgR70neT1>OejOeIT1w7+c>1PjIfe?Vp7jEL$O11=br?3c4XSIfWr
z!>{}cfEpqv12-PH+)%|U<FuGW6NKO+2I5`c^J^7vaqO-1Fi%pMI6ihHJdGD^E_Qz)
zLlrub1C;q1IP0?#{m`1j&yH1FWm6M{8$;a)W5^IW$|?e!MN%{_oy`RHVm%LBa=;9e
z#au6iFa-Ur1UQs5d9#=$BVy-F*jrDQYm`DLdWB4neycrh=<DT#nnyAQF8JgcA%j$P
z_g-D8+Dl!PCawA80G^pr!ptBrs+yfcd+G#*DgQaFtYFF{Li%5JyeWSpMKL|6l;qJB
zjy)coea3)TfUyg$pfrJK<vrZ%2`1}+te@+g$Qg6UWT(VWZ+z%cu(K9G)U{2a0!j7B
zMjo?K6n@&=dK~{@kjdmltwAMQl}x0a+s`k-B>P2MzyXpFU329pXv!+ZT3MB|DMb~~
z*sF9DyYy@kryNLV^Q1wVC9XXpOR7Uv?;4ZK@K`F$0lA4{Mdg3Iw|oIh+OJp3FgzP5
z-iX~ZXflhP`busn)QiTzm;G!x!iUb!M2wF_vhN@GsE)_?O0|jek*}Z8HjB}1vvHE>
z=;(mmQR$``D)qfmA2IQ5iF8~1sg-ZTK}R4;3&U7Gffm-tIMK#A1(+jlQQ4!)1E(<=
ztm8Ieif!ME1+CqlnlCF^_9VuRmnB)?&Nnp_Bvn{94^vOQ8#;$f^M8ChKiyrd8#nC)
z`<&B;Ow>>Yvx)u@|L;6}&!O1|oWW6DV?pu*QbYnBc>=mRIt9|pw*RCHRryO73YZC6
z)|hFNZatu22$adaBu0PZfJ6TucD?>RchWYM(=ekEEeC_7hOd<-biiLI?A~)Z4T>ab
z8kiW}mCd@XlamvKG$8~A>u-;_-CsGgjars|a<KUwc$4A)C#><pTI$|cYCk&f+7xly
z48MLDNaBd9^DstH(!SYQ53yqRXxwF2CwoV4T=H;kInejpFJQ3F)xleGU^U}9PVXJB
zq&}8kMx(#ZlL3#Urg=wfbv)h(P6t<5c_ec$a>*_$w%Yut<D$eyFWBaMF8(IXA(tg0
zLh*-BZc?R#ZuZJa9Tc-(^dnFXYvYLJe=+Bn$2ama;W8`yImQ14rPRx}e91XThKny=
zSf0sA^*b9SI2$_9*9BhR^j6j$yqp^DXH)!x=$C%XT_eM>@y%W4i(7W!F%!oVLtS63
zA!7Pf{^8&VU3|s6hs|EZRV|0c?e5z>;;7Z;7)9awpZyon#I!<d<jkcW0^R+<pv!fy
zPk1w7>z+V~9Z#litslZud&m!UEc3PD;A0tI|3U2W;T^uXygIr}4ztTcT;G~`;!Egk
zI37ka-wNba5gbANr&J41jv5O7+LH=iLm>WzDV^)j^=X0y%^<pfpHI;^;&hytwZi{e
zG=SUlkIldTcpCbLCWt!U1Me}^nq$;nP2IQFpOe34dC$oTq}?7r-U|&2TlsVb|L8Q9
zSLD*XE%femrx^x*Me!3Z{qpw?RV_9FD+5%ZM8aJiplmRDk-g$F1OBh>>!P9qj&nco
zS%+QE9lv+{`)b#}FXCUy8_bpF2`npp6Q6JQ*8a>;04<n%nM9Z9Bwe@7yXEvllprvv
zv0bim@9ocET(IOMjPqXCK+x`&SgIv_SuE+IFitw)vH_*|Ih5lMG5g(Q+$tR8+m^;9
zbMpfM^E}X79VtJDPfr9%pW8b%MVtNBp_43X00(M0QD(L5{ShJuYwSnSFIkz|T(BR{
znmYWefsN||VvyjdX+iaOGWXiJHH|>*<iz)GSm3q$MhcYOJ~h8zJ6}{8$Z^nqajuqQ
zA9Ah0I@w4!?Uz?2%L5bBZc^~fHIP99Z?t`jFqcnxRpRuU_sqq+t8Fv%EF<S+GVf@4
z04pC9B$^5n6W?F_+_EC?HG=ck{Y)Smnanj?fSY;Z@(KQ|-czMGX?WbvU^wQ}nl}Ld
zsw!@4lhhCS7<i_|-C7!Op)v6MXYg;loU_rR@<kSwI2%=9Do9(JE!`Pw|9g-u*Sdbv
z$lwqPHc&K8t;q>?k?#Ep9T%lLn_pgyxHaGTp`|~EDed>l_@}mGnCe&#WIl24+v<gQ
z5SMkkkR%~4#%+BkuW?v^pK2W}LWRKh%MYoE`j8tC^}gpgSQb~4BIl#Q>`;VMEX{*7
zBR0=$n7iC_cctIRU$U>6>HSt?#m)7WU+fAdt}m)->lZ$&YSSFwQ}Zj)&l(uac<7`)
zp0r5~tjfU4e}$&SA9G4QSpG$mu)V5VnFD!De@@5v10>Q<sf$^V-lkW-ftk3w$Vrh|
zcMjWc%`?U{Zo-#+1k68Zh5asxyJx@mku+1XvT4I7`A7$*OnW;I$tmjkzWJQpRlAra
zeSbkZ?YCDTNn7T~055psPe81zN8S6O$EAKNz*NeQy};LqJN-a|9=<s(U(bV=)(<(W
z`Wc@oY)g5=OrLh!%kbSN8yy5c2oHRUu3Jj)Q_d^0MyUckCe9G-2_n3K{Xa#M)Jg)p
zNV&O*yox(AJBJv~$aDCcz5Ma#zhkuxKe$Da%6DGTxSe5kF<{@!cJsuh?dP$Y-=l@y
z%d~20icrDWy4c^@=g}GaqsdZJ^R@N3%WOJ&hb;^iC#p@is%~lXqn@g}@s)@`p|L2J
z*8!A2<9_9x$TFKGNbl*D(N0I@=uBGup2R|Zy3&8DrJ+z3)W%BG(q`Rvw9ap_zCW4y
zg~;Irf4tnE!|nXXc;KHB%zr41L80^*PyBN-KguT#9Ps;J(J>%&G9X*mX};AT2AtSn
zcM>hA-vaw<eo0AQ_#JYxA#x_^C?GbA2oJyHo+WJtG&Yqp(ho9$0eQ^x=Xkoap5rDX
z0KzLS{p6s?1%fwtZw05(QoXm!$q(La0Sd$@W{<Y~vIdL<6^cKjOi57dG`8-cs6YVw
z*I>VXHqkAGa<9Jd*$Qtnl8RU0k7T>1!Fg6pIf~_bw5VVEZorZF!^X!S?;r53VHDku
zS!f`>7wCF7!b-ck6a|~&u`YwPlfiWk<M~ZZQ&T;%gy<M+7oVUtZe{i8lIyF@bSsZ7
z8KqaxAQ|%V3}<Ufeb`pj*bLyR8wHfQdigmzPF9*-_c-dm${lpxQ??BbJfGEjx7U8B
zXLsJ}tZVr*>4^u#xyem*?)2Mr=VH_6^DTQ=%x&t$XHxPb>9Jq(#O*6~2v1VHey6^T
z`u%-MVdl;K-{cx~7AFTd$!E^wdIr4EkIO1$Go9kQ@1W<6KwZ11kzt}PuWJv;;)6NE
z!1FL?O=I%6<l~fij}f&KopT=3caS2D-S@B63V=XCH^t^;a)5p)=V|kf*i)r|L&3eh
zpynNc-yRPN&(-G7Hq90#ucgvWH(hfnds3jgG!I+PVvocTO>03u{VnZUqlN9mD5rG+
P{HQ3X%U9ktfA)U>O+?E^

diff --git a/docs/img/server/syno_packages.png b/docs/img/server/syno_packages.png
new file mode 100644
index 0000000000000000000000000000000000000000..efc61d16c69dced51e9dfded700f45378368728f
GIT binary patch
literal 175246
zcmdSARa9JC(>6*%Ai>?;-Q6`v@ZcV3+}#=p?hcIwcXzko?oK1Y-Q9ooyZ5`lZ=7+i
z{+lz-MX&B!V|Mqfnl-DQdTOpvMR`dCSX@{L2nYmeDe><R5TA4)ARzm`K)>J7XnY=h
zfBWG0T~ZXHVjTbAUHD`wA}0a?Q5_BUYykBx!`Mk_Izm7o_WbqwFko9`^nMdyuA<?j
zY-4UGXY6EPWZ-1*eh&fyND8nrw^Ot=w{dbL<<$m~x{>lS)04WtU%lx6BeAfsaQ?sF
z;Nj%>XUyN<_)FIH+TP+hf`EAAlol6Jann0a|NK)&wf(KLwzl24cBtT_06A_F#h3ld
zCnyvsaZ$w~WkpYgH`s5%_bSM<lE}!4$QjY3MIy3ah(n4JK7E9N5lA2pNEkDzHBURS
zUVgjdYaC5qT3TJwyL=%xRcJ0;<#Y6Q96!t04F5tLfGqlj<Ubbyi7;!l{|W&ygnqDC
z|4Rz`zmy8pqXXAgvHLTYF~L|eN_xB!#!BmA|NLb@Otxer1|weyZgqAJw84;xg0lc_
z8l)Mr^7^cwt@kPSv&9gs{pU&iFQjA)7(6NFhST;#OSRS8iOz%LQeq(Nc2H)zFM1|Y
zaKw<Ly$DG6<KL>h>ofQ#2Mn7e!D79G4Ew>m^CUF4-BOT9*ctBM5zut2YE3G$P?0Cf
zxjt5n9<s@Jf3(Ucam^?qs!Q2uspb~{$2R^5HaY(q19`gV`V~G&3Xb&%MBKhhkhK*2
zqaVc#7br;jY87ex2mW8Xeg61#rw%v)pBW5{!+sJIi6G#>orxB}&6SL-1H@#D{-wJB
zEY=Gkfxh3GMhDjA71=zo)EDH$QY_4dJj{=+%J!<Tsexv-iNR<Q%@c#cxbyZq+Qt)+
zj~RMz?VRiv-#8-GKeJ>tTdH*>%J96^H#3J>B*84Ep}Frq$m|P<%jUTUZl?I;v>7Iy
zSY~ck=U(iv3E4h*1nusc@Lwhwe+lg2HrT!3emoaDro%k*t|Ba*Z-eRdM8xv8CS+x0
zJ*HdDeUb^&kqb?>D-+6ZMmKNOhd4}A@;bLwbl&!NC?vV3<?6yJ3J<l6h}Sz|yg)pC
z^-0?3KI>0yU9V$ug&P8IyRv0aH~LFqZPb$gJzspcGB@jbr3P7ndt#i$%;501EjsSQ
zb1@Y7;OfW7#uE*(Xrn}i;i&YX0Xa<7EPQr*e$i}XJ@*r5&*ve`C)fz!P6@|uYX1R^
zarm@#V7R&@Y9$woqp3yeRMRPcfch+1vH*_ij8AZ?<{j}b&{@BN5${+U(nijiU;sxf
z!0y1ybtCqzel&kzX#wURpNR1$N4?F?A|}cdc=)uvvr9}zhgMtQv#e9PqHk<9&G(D<
zPTUoG3XZ8WsD^+qQmHX#fn8o<`h?=EalMEoOzaO3+7e-Admi;$`qAX&IU)O3i655x
zF6iDIettaP^9Ux;8GU9OK$t^9)dM@uCepFvR!YWj%v*e}o6}praQkY}6rQb6G8WB&
zP+Z;*Lg(vTg2Al1{f_h4{1>BqyB-&saQ0VAt#*yHj<O+Ri)`m3c>SBjXG=R7&d@IW
zSNJYc_ixX~aMaQoYJ9L+TtwZ0osGj0o4Vg;<yW^Z=%r~1wLd%{;)G4KAig=?a=Two
z?O{;ZJjBsf<q5JVv5()N4q$a|OPiMMUr85qoKbp$c2g**YhNbf{|OS%NGA8z(TM~N
zRt$Z$6HEgk-5dAIZM7$p*?j_cLWZqzTXAn~lP)*(zQPa+uP^$G?XE=AGt;sf;Q^7j
zJRkK1ublFh3<Lt-O#MzyQRn2clRwlPHQaEI0p!KRjQAVM`B3;cBYGRKycQXfzC~46
zq;)=0RS}uby@~d(brJ)jlUW|W$~a`{zH(;hbii<ML+`yV6e|5<PN9W5?T2$NLBFSX
z1$Jp1-#_tbT<!AxuBO^xUZ-rU61^(wd2D0)6MGiXg?n+fs1dwb+xgRR0(3vo2B5<s
ze_2vy8CCb?poB-YMYE_+ZlmG8N$}uD)d%%Djtnn^5UMO)9VLEmAb3MhuCa^_?~#wa
zcP}B1eYV(nyn#6+%+xP;W~z5!3T9|R<MJ5@>-65DI#0O=FmKVfQ-Sddcci`PXt(ut
z9^8*|cci`MQ%%WkQt-UgrXG1FNJ1Y8T?H9yGK23lcUz4Q;q!?$zPH-2^(!s?6LN5H
zxzW(@Ijxo>_Vm3mV(mW7M8BX*VBL)OH@5^2hrhdHy=^-<n`T|pSFBL3TKN_}wK69x
z0mmWJ8iy*Q1qj)>9zBFc^~3SNg`J%}RX{fgVPqhw)6FBAk-}mBH7@7N_K3lOdYcW$
z8P~!eOW^#UAsztpLx(@hB_D}O@Xvu%Qn%KA(>}P*G1aax4vo5z5duCzou>@7cQS=B
zOaZh4%R6I@<(e3P=q@KV$Sv##<eO4GUk=+uV1fj|?lffpVyi!A@t)$0{1#^_1=|EC
zKBYJ|i=M5PqJuuXhKnIzj@=tSZe2@`d?8vv@vZ^Kf0G55X{x>C<M7&E|EOB%W_h%#
z9+i1zhpk6Jo148*kE=L#owvk)Ltg?l1K4*jsZyL8ySp%oA77FHvo)3u=lMFMn<9_W
zs+l0yfC$Q>x;h{8?szp&U;`O<0{+i59`5<Rn^1|rFu6+j@kyunVTW<ZC)&Q*kYWi9
z*+Oi-ezmANIZgM#oy7<ISFjrU%1ePt4VIJ+2xFG<U7ubTkBi+q08sgl&77`je3Q&i
zr^+;2gCH*&=<?`8X<q51L*PoIU1+<L*#KMPAJVH8n|?F`i|K!IpV4{sZMk#5p!vMh
zXo_>2{T=3B#*I5$D>=^04AmzDawq92wl~iYb8{T;fdbdrGFk7)yrtZ3iiUe5BsHX|
zZ?WM~D2WBOr+aBp1FL(=vSBN{k^_RnTv#5v)<HW))dlYR;kpR9Mxd0i97VUpMa{&x
zfOLOkVEyGbL76+<#qSQI73`7hr@%$LL*8AJ+Dhq(sTpJUtEYTZu^&{OQA?o&J5zf#
zxw$wTt9dVvQS}uRztbtm`<EN@KPo&6coX6L*E^r{3LavUlEQPN_(u^*+Cxt>uU6pb
zMqe3P>h|FZ(+wk9IAklG9mBzDPTCu&36Gz8K-MNLZnDtN_gDK{cJlHt-@jk}ER*##
zw}2H)CJ^1t2>w&*4YdJU{lax7QDmI7h+*hLx-z>|>lfXX|K=Q_WK{O>LS)G4uX_aq
zx(wN8HkjBSdm<`$n4~2LcsV-MD(K{-O*TkVjnML(Vp|49)uPi74%xP>{o1}ukjzeS
zS{+&M(o)`INwz<3DiZA_snD_Y8lBE^Ya1y?6$sBe0?*e*(1wH!M6q)IlN#VDI-L5=
z@1q~~uJ=cLra76~o@u|0(ChY?J1U4vUuXd2-%|!!!GfN~MTz|#`l?{Q*=hx)BWtX;
zG`;p~@kx+o+DA>B2eQ1n<L>htQ-}={mJj0Hks$%NKYz3@wp79~Z|Xb%zB_-^r3J|2
zhEaI%Djvl<qC29FFYe_Oq8~`}_mwNGDFt@<2mzRqrk3#5l*6>r3ufdsVdPgshrkqC
zE`^uzdq2`i(Zjh;Q`hwoT~j9P2Y&RYoej1V`pcZ`eAUV%lJPR^#2>FckoPK|Abr(*
zJ#TV7PiuP4DWpaDdoc$mMHNP10=v1-WLP-~H}?zLcQ9J5^q<h930Aj8Qd85?E(Y~M
zDHyy|qx^)DM1-yS<3J*t-<Fk~AAG*SGCnW25rTyq-+@=HetFMj3G<=ort}9&qkFsI
zbM#TXoq+^d$tgoR-Q!qC`G@jBn%1ey0Dn;2*T~Z&Qs_;_M+q!+#@=q#CUFe%)oxXz
z8%6JbcDTb&M`9WsM3t8Iy#18O53?sQA5;xXdZ<_Ny2;Y~?=P24bZ+dw%=v!N5(Swz
zSig;bMk#??h6WX5C<9V{P~DAE{PRPi&}e^UAzJMq?$wNq%a=R6*iFdqefQRUb9=Sc
zS>$9;dq2<|T-(CxJkmwcMS45oeEsMH934hyK~m%p0otRexgph%gFL$=p>#O^LgxT@
z*7vRXFum+?-zP6uoj`AHVdZKOro#lp&s=|DkI8_}lakH+#AzLej`B$&Qha1lRC_3A
z7(_`t8z7Yj^-v3v!Kc;vFDOQ4z29%>-ig_%H!%sP)tdGa%quMF{`w*~y4H%y)!_`~
z`Km%p2dSuy!8k_raU({0-R)lF3%Us;iRIRcRFlZc7&W(7qfUNz;J*{}kG7%HF?p*+
zExijDD{RgyV(?K>Abs7-<o#F(N`f@soIsDa9xz8oL(Wx0QFKgg*Q{tauduzBjo`OT
z{G_<?FZPY;`U|k%+}uzzF%3{<diwQC%;h<ymzB}ud!Bb;bJ^fKIQjgGe*<Dfq~3@B
z*Y;mX$T4;Q{0sh(MLm%Jm)4>l*#EbZ{z1hHKW6H`>gIjE`1%Pf_pd=kJs=oqNdKM2
zfkBbozh%Ie|G!F}C|xd%GIC;U?-f%+rR}0V_~(ZE()*{uVJR_hm!K1w2*L0I5JVi%
zL3dyel68i!LP1#u8CZIxw6JIu{I{`K>juY$e-9e)Obf}^i?vAT-|WDIQY~E&bml_(
z8wpk3N`2dyCK|@f7eZ(J2K<)v>V|nTCz;5gO-IX8z>L)6z`7$tvJU&Ve*_`(8WmUA
zihea_pp2wBu9?p7?B@t@!!g^En-(0B9X1Qk1ECX`5xD{HN>lqg3fftn-yK{V)}gk@
z>hJXsLp|BE@KJwiUw%8GeVIz4BG0((2!4)2<Zro3u|rCdpC+1VS*BA?LOB@4{O3=3
zm(NbdSv?r1h#`IdXRzW1>!&~ejBz0T?af4D#4Hl{Kh>WUlGy)48u>6hZ*APP<$AXT
zPSW$Q)Vme{tlQtcEPiiUjS~5<FU3^E%~nsg-YzUvR9tjP9!*WJ_$d%M))B<v>+)be
zp17`wc}Va^aUU!4<yl4$W>~fw9vs)YInNzwJS<zNB&cJ*CEEj-_X0Gz?Qdnbd~Tb4
zHo{GR*{qyQsd>#Oo%Uy=Ni20l!Hf*N+{gP2#1&?IC7$$XH0~6_(C4|6{q?rP)+_<~
z&*H&z^Mc=QrdRC|NCdtrL~=>5PtNbnp|lJ3d`)CXOniz&&10H$sN-j76e=z*@6zpT
z$MSi;(yuZeQDf)i!pXHkn6Zo&y5M>~N%0|uNmq}~9tQQvWQvlbcQ>2*d}w^xEOfi}
z1xA#6>yt-F?mPk%_yL93#Ix4@VS8!@0R7?2SL(kjgP4ZJ3-pTSb1FB_;GK>~yoT1&
zYjHv`sI%HXjt3Mje=Y*Cw)_GWvPThd4zEkP`;;2cF%i#hBjSyw9O~L$)mr$kgN3$o
z5%A=6JG?Hq&P&s5*(FwS3l?5qx@BCBJ4BLD7+%1&QgYH=H*l4`f%<8|{z$1mM@O9i
zrEmR2`o<>B^j?>mR%<O|@+t7G=ev#*TPfIL#!&z9Dx8mH%~)_9B#>XhE6oL;^^$LI
zvILdf`}Y1c2)%yX!vK4;y0K*1Uh`R`052YY@|v_@?=g5FCt(Q%@?|dis;R~UnPK~C
zKBykpOj*Jvy(%_vUpG#FO+w)r24&K>LBCh@m=Ep`{Y6jrTT%6ZTLuOG7kn+PkK9kA
z6I(@Oh}B{Mp65yP`%5gLU`6T>s*Hz1f>eG$G!KGlx<N{_^3O=R1%pDb$p0*AjL1;L
znZZSlqv9rB@B^37&k<9*0|A^6jr9r1xBD!XqzN}jS3T~@1jgT^MEoJ(afW{1$uJLN
zq@;}R4Nk^LSWK(MlCJZ!s}4`PCI>O&CQ4A@SgW<~vvqI2YwSF=>rBX4?Aa0Wv17O$
zx@x-F6Y5GBLOYq9w^~vQqw{%oM8|~hdFgED7;4vX3L4@4lRRU$g3TwDv|Y9mSnX&6
zNY#BwKjV+)DnGFbnBqQ-$Yq|trKwL-Gw3Vu08?$t_pk88$L?)&P+;M4ozyUC!4fv|
zXOBH==SS-u)wBMm)Ru~#u?05mgYSsS`^w%Pc*f~sU#qv0e7B~JEl;H8e_USTG)S8E
zKf738%Xwe$+|P~e{b*B2QhP?1*)mC6Y1zmB6Po!a)p*AxE60DoiPiQMYP?6e$zwxn
zRL^Kkk;alKU2`}#tBnZ4)#K6(W1_sW$r(DZKOM`b^MpF<n4RL1Ur!$}SMIhpVb62w
ze5A#HM!Di)6N=-RBygb&bEo$Gw5wQKatD|h$p#pZ-df9?-D+IF9aT(?8X<ZhH1Rl7
z*y<P1&L4Bq%^SG0vp+oZ-c?J!;{#7!MZO4X-)TG>4VZ@&0)^Jowy)YJt{z@jsMYcH
z-pa?3YXw*)s{PN3o|+|R>Yh@hz^%f|8R2)WD^Sp*gp4mdwG<hzsRx@@F~GrDn*Q4y
zyzMpDI|7!1O3uRa(t2Fm3ytUo;tzd*fw13K*)9FK0s9~MxU40tPt783XtnJUOrd27
z)^up>%SLt|!@{PLE%ntMb!-H3NDB$^jwG5F#(7QZ@<PY64yfN2uR-7Q?neIRW5kji
z=o$Fd(v{BlkqSnL&-L0WlAIu(!35kB>GtQ2qe=I-%;<YBfAAkl{nh!($FpMTDE3}S
zQ!|sb_a3UQCGVWMWwKwKtdp?%2+uKnkit*+8JS-3D%!!h%-`%fExo}?tHVlamjYa`
zQN}`j=^>9JNdgF_qdE?!6S?l;&CY~XPT4Q~2x<@VFL882VK`Y^Z_Nj`>FQB@KG*0C
zt}z{@2hh0bzz)zQX$reB#ceH1=HAVesj=W$XS01|P2a<@oZi}=nU`d`rV(Y-6Tyx5
z8UHY-K@hF=q<Q@&xnZI4Tw@<HWQAYmsv2PW6z=Jwq7tGQ`9s4yiXe`^<fq-O-BL0i
zp6P)sO1oks4j!EYv-PkUn!->TD-PhuYA49?1)Hy9Y!T2_`_*uUj7xHJzH2|0cX%B+
zsY7A-A0uMn;Aa5aPB6m;hN|p854YJK=sLZ@PT<{>)1=t9!HZfeQ0+Ul5ZL~3Zgv)u
zuSvP;2#Bj!Fi2@F4ARNuT6KZ*=oD;Uzhy_-Vg?2Y^mOrOa{KTd$e73`-RqTIu7ban
zc;ev%FzNDf?!JB-e?c_?xiTZ4S+sbYekOc7QKrV@B47(c^Fcus)SvL8BvndXnmO4K
z*}V$6;yV$^*oxz*UeDal1gzXu%w$S0EbA#uZoS8|HK9HkpRtCi+{{D-B3o7$()o@X
z%-8jN^*`gl(|R$F%pSyQla(^PD^NAqaPE*R+v2#VKu*lmbe;Qs7ssV7hw0k02^?12
z=esKFrqdYGF~K)iIg9G%<vycL5gDWYm8WA!6fSt0bW9<i_ra%>1?oadyD1FQn7lK+
zwHL)1`*8t+*+&O$=()Xo++2{m9eFnb<g>cYDVNC;J<BSbIDvBNGdCP-9?P|fnC?ka
zPCE~`+oq&9SG#lNdyC_yn{@&Tn(9=`d5uW>i8zdqA_vo%GHJWNm`4^B_#fbLad9KT
zGP=3~8QzaPTN&=ZB$XFNM){uL@0FD=wrk%&d+{1Lb+21;8n>fDW71!*I<DRM>aLPC
zNuAR!K(4mvwVk2u>;oKAFS^@9PRdGCO0S{&(SOIXL0{ofRwA7H$Bd>4Hf?egOZ!6j
z1og4!=2n$%`qKS#0yFiQJ~XcTRi(AaE@#tNV3Xq6MnN)gUo$ZJ^vYoGBvoJhj^8}K
zqTtA~zt1YQRK_ER!zrWEG*mHog6lDbJhMPxn}_$Isi1VC`elN=<HTU8ouICLEqeik
zep5J|FZ9lmhSr*HR*4m)@ID((m78$N$XQ1!)wMm`w%*U3xEkDL2qbgf{1{DsHRn@3
zbDZpjN%k4X8iNt%TJhw=e7li$RB@7#39rU_yP<jB-fK)dx*C7vr&O>20#>7NBDZ#B
zp*hQII1|RwBg_FV8)L3HX%kwtV#hCvqs|wdXsvIduAK=k?-51(S~BH7Abb1wkFoZX
zPE{ttVAKRat9ovAF1~S#I6&h1Q&J6wtrNd8MT%4C@YQ!uev?SLfoZBWyQAmFn$B#i
zN1o&btT3qDl?!@Fl;Qa@IlT>l$yV>$`q2n~Elb!$*YknxpYdb?bEn&&@rbJS(0z**
z-=Hhc^c@}1;E9E+6mF+OwhPjUi)Wnom2f2k-|y{v1`(9A9PYDKgV%(!)bH#Lkn&}G
z=(O=WZpPm15*d;B?<IAfa`EhLx-<X05#IYNH56TLwZ1(t+`oA9eO*7FbDZc_@1>T>
zc;u_NKf}A2v(+^`rce+7Brpu)*>;AvCnol<8aq&JEz<DJ_t#+D9tdjeX?oYf;yFq-
zKjkMMHK$c~w=*6bI>a0s#YSB!i2Ec+{|8S(<9IB`XyyPI03jI>(}?e6UQMQ<Z|%0o
zG?xA$j|lV(i_aQ&ZETTayDW5E<4YE|2~BUhu{8aWG_9`R<vUs5GSN4|;uE}58b1)l
zw4t8lVJdx1>VVX!rxh_EFd}|RPj`C1rdzP(P+SW1F;q+J9q(tR!rkcDH#G#U;zvix
zKb%^$d<cB;1ay)S@UPqWP*x|Swb@mssUPi8uTMFKj|DaDdX%1-CAbLv6-jrb1Sy2}
zGjXKb9q66-OFo&K+jJF1^DHAuM^)g%z1;GhkqD5rgNH#Gyah*ds+E8p%hIu-ujU8l
z*!uj414KUbCKC?hVKPw}+?dNFRN4(2p@nauNb|PB*1C`qQTS2C@l+c!`p@{MKKD$E
zP3CM8(Tv>_J`NmVuy7|Te;07qOfN3<>?8tG(L``^9*Gr%aH~|XNfpx=fiem#leoeP
zbUMporVY>ASd9h?6#~hu?x^0*GtpC$RO)}Xx273YnqsmcFc|&AD`<7x=-JKt2D?R{
zH>uR|jAf<<MQOGF1^e=%fpF3xw7NDg57G7~#_P5JQ@qB}t2F&va0Xm6t2DuXh+7Q$
zyRM26L3(Nri0S%-!I+*WbjxO5Il58?ud=|kB=}F&!nk}k_iC%Yu@+!NJh^rkvp(f3
z=_(kXht8;pW8QG|JFER^O!n-_bV@IUEO;j?rv_8iIdb;?KN`f4gx)&Vcb2~BoxHgu
zzV45pp(+5^#k?gy6RtkU#_?im6`Pw$033hc-XOf#)7Q~zU)F*bQjcoQEMP+ZG(vj7
z%;g;fgO$8ewfq*fb)#GQP5Az{ZA^CHUp)yK6OR&tX^zJdCIu<}p{TQa0s?IEC--{E
z>HpOQM2^E>>G>auAul-le-RG<UrT@2|2Utl)^!6fa$&9X_m)~aamj*_YQ0`$xbger
z-!!7SpJjh}Zqn!Fkyk>_*D-ar;3jg&y`yyb0~IY%sfj5t>sKHR#+<X672=PHSC8Z3
zGBIlOhDw)+^-Mo8%BVQP=n2Ho?@CI(T<aR)NNaBp;Kn4w_h4&gX2!fwQ(MbYQuJkO
zK;buvB%$wCRAv+lpg-A?MGA_`3cPy2i-ED5W9Eif!#d4uqG6MBh~n^j3Vdm_RAcP+
zoTA#VtF7%{NXwO-TX1*1)}H)2;bVArx{A$Vfj*yM4?RxE(%pd@&Q^B0d|?A9`-$DT
z{I=LhL{+Y_0jl5Jj<=Wa?!f3Ih^o9ZFq)z^+S}fketU%79ZNISC)xgOLL33)79|O|
zrV~7n_~cIlUf^L*FQ5v5*S+Op&o<OY5WIJzayhMtb0JFbmFA{lqo;xlRv<*neRqu$
z8K(9Sy2>W}_1D|Jrn8Q>z9ZYVKrfESK|)T{+;5b4|0yeRCATba<x1U~q}H^8K#4_&
zp%H8TYvF6keQUUm(E%|X6a@s0V&zOw&d$yfFgXp6TlN@Kgt-sE)qd^;0dF*ufpQG6
zwpzMg?TA@))nMZ8uEgxZ+~PZq@csDCC&hSE2yj5%M1BC9ZaB%l@Af*g7Iq<hI5gG-
z8iw`oa^ojt_`sDe8CH|+a~<?(8gXKDg4wo*-L(5t*G_-1?Hk9tcD?(X{xPxfpF5cX
zp0AlX%Ycw)oz<v2nPqIJ1Yki<NbJa5dydG0IevB~Dt!jA5!yIbw7GnS+`BsG0YR&H
zAb9}1tX}0xbV0ww?Cfk-bq8VT-KlFLap-dWt$v%0WVK;8|6iIouh`1qtktZc@Zki8
zAHYcW3d_`9pou~w{uMtS6H$7uMt|(|+z{oKlwc+%axB(1qPE^1f7R@>Q8``?PhIA1
z+}c#^sO`?9qdk7Sq!k_fU1+uNx}QZMof{UN)9o41%{%xZHBI|Gt@X4UVL_kiGVcSK
z1Qy_}WA%Q2m7{1;DGbe2e!#EN3&VBQo6g(yPPgea)zWSTVPR_%?hP_Cg>9twVSjZ&
zF11^!j}mE2=4!UB9-hH6FQM3&szmujk`DQG#ud5kty8h~bS~MFZ<`Q?1Ty~kkhTnX
z%wi7ixp<AE7+mfg_@2>=V?CnR$TIF6Efky6C!GYIL{?UF@$w3m$v~I>_5~-)4hc&X
z8b|ECPCaqk7yg<^L#L-r*B;1>nCVgluO<2=sO|~{B!$XC0VSvpJIy*R*FF$|Yd-z9
zwN5uleW1YSPI-BC)f@~*@*-|KoB#r0@;_Vxr#qBSVxnjUN4oFrb4P_GiYqGmBe|Z@
zwHs~3lrBUTRU2>;fp^3Lbds{1&*nJP*q~^ZuVj(3L*v8ZVgR&5qd&QZ)TFHDo!cm|
zby@k<da?vT(b$13TU3CFD28NqbJB{pB{^#9s%?j`iQto+RwY%i*)yW==MG<GNfXlV
zM?H>sw6TsesIJAz-1xmo3WB%?2M7HMgTCMNPdC2n>IN2;a=I2xy5)ExtuefO8pFXE
zw6f`++Cu8)0fdioNGfeQ;{l+0@8>uT>}?h>^;Q~@&Q8`&K+Z-=v4aSu>obG{^AgNu
zKay9%k%XF0QBOBSL&k)$@9upl7i~lbiL(kiVBV=XYyCZQGYd}0uvc<q_?%{n5L%qx
z{U2s$83G}Bd0SfucvbCAbl+rTl+@IMF4K1w8*Q09X=o_NI)*J&R8;|2pz@+J^WS-!
zO4$0}BW7o}KLY|{GV-~MzX1Sbg3m^uzdsk7{G5)x2ro<KwJ%Gt&LK;-h{Y0Wxz$QY
zI_o`G0#qCK03~jXup)#_)|hjhF7~iUG(54j3J4f-K>!r~M=9|re%KBgNn&nK{zEbI
zb0|nDnGfIDSYtsMp+S#YDyPf7)o6(Q6_*ZW-X|Qt+&1xzhMmg?&Y$t$gKw;d___|)
z%M(&^RV_M$F|ew5DfoH@vk9_N*b%KDiYcc%5dZwzg=i-?TCiIZZzMwdj$d<9WiGor
zpPLD335N%p>f|~m&Y#&ap>8f@t^uPk@_!lqmYJ6hu16dZJy<lE(}6sSP!Rt>`nc$&
z^8@z7R(uoHM2c?@BHw6-=%DXkmOoEqCdpGUhxzo*rTV4w(NzI}IP>K|qAp>$LrXd(
zW(Raw$;h5#H2L4|d)_#iLN6-l(Rjg;c$`1{o#GCU4y$Z^I1bbNsA&hgNM;as--*f~
zW?nRTQ&6uhFBp{KGKpO$g?o{$1TEQl{}B1!M`yZ(3$Jp2;k{>bj3GN6UGdCAmlK|;
z&J;Opb7Z!7#TgX3z&4Uk_nWnkk5Fn1icEcj%1gg9X8)!WfgcSooyOMorC5_^v2DXE
zz7cdWqQ7D^JX=$bsD)*_+V6Q}^4!Wx#3UXB=<aSM2R+wT9ta$^6P_n9cJ-P1KxGOX
zedBMF3(DDio7ZgUoNXc8qAI@-B=ZW&lT*2yLMb603J<W`4DtNsy-&iO&5YE%@e@WJ
z0D>v5ei>pUVC`q@k!hF+&J9NBDT_k|?2%_%T{sAPZ(cY6iYAlp>Ms##Bu82xN00`Y
zl+L<iVM+2P%xqw?I*Oryw6uz94Fr6&F7J8F44>VdHtJ!PWpHFDMjoch+!E*Y;@N@T
z#~343ON-fh8U5f_z{Ts+S+>Kv;1x90m(1-2!##d>&1xy1=grZ(q#xmX16AeR+9yYt
zrFOXwQ@5#nRoxxSgmjo*9E|D7Y7c1Bz)$`q5tF`hPX)|EpU)q@s%bzLKfT=vS}oOJ
z^n~~S08<f>u=#M;T*5`><e6X6&rT%!9_J$U^oj`vP7r#NGp5+Xd%I7g+@Jgsvky+j
zljrXaIN*qkC$q;h9T%SwVT(;ovA!H0rDJxt#L)tQ4iYMzaWaz7%D3{im|u#Kn7x)-
zzeEVp7M#ut+;(&ao;05wNJX_~4v|`>$e7w)or*3)5~#W@YL8KpORyN?S?B7xD$r`R
z$n4Fs3W%|KB|xSGOh_)%5>5Di{wq-mirg8RAwpHVE-)sXt%M3QN5qmzX8*XiTfP20
zs>fqy2$O1Yo8zFKVzcU3_KSa(lO1rqPb!<?f_?eETK$nnO3k*FPCtIWLv#sh^uu`H
zZ|gO%T*F9Lk#v1Ld$4Wiqxu&)$)B+zf-9Y12sMj^7C@+dp}7m?+!VXzgFUzvWo?j!
zB@Ptd{lZV(N5k$~uUMwEB}9Kc=a)6{_HHXkF`;o5q8<Fq_hPddm8wmU!oWUjd%*-T
z=|?G1#4EPAL$W%+#ia1T)1>eerMZ0ksN7HHb<gd2aG%n&*<{Xb??iaZ{&C_I!n+f}
zEf3wT`Xi-mrTH&Ma-05h!%qeB!mA`y-Bj-88L6%ZRCvrKZgDiqBlEmwx?uwmc1P-}
zy8g~Yo)LFKD*=b8%gHTA0=K7D?Tfc71#SDbl)s`sXU@00;9|)gN0S&S#6{qrL2cs*
z8V%#ZPE@&0C2=vl-G5G<<9|Y84^`5BVVDpwmHpG~gNydO(24wb*BJ>T^u|v*(Mc@2
zNpY{|hSHIwCmL4g^>&FNrJKELoY(#gJKbm0R)dOD*%20zSV?*{w-B?#qSv`~yBx)0
zuNRKM<;_R`#G%^sFe<$E2nP3hH|AdEC3S-Rq1>T)M`SZ6dZ8Kz1c?sfSFeXZym}%E
z|JB&KhRIg^GzYxPweU$y>5EHDjQpkJ^@JxujV-FIT)PxbAs~Q|$$R((A2@4}%xVCS
zNJ|(PQ70SVFM{uMo{g=h_;W1NO4Kn63So?4vCcj1M$Md>M)%vuG1oXnlUbM5-Pj!Y
z!-luPhSdp0DmN=5dKoujJmxbllLfxNQ<zQlT7j&N9S@@u@A@=Jr^sim?y#@cqfQsQ
zK3(s5L;R|7vE_casgXN_rg-|ouCTYFuCT?&2L{Az>utDJVLQ;1B))#jt4Th*US7-f
zrk?X~g#e!H`YcntoI!&R^8fh-^93s^;3D`lk+8hp2bYsYXnhM_R)@<CG@kEl_Pl<%
z1H_eC*n6S;Jmfx~G8S?BbCCSpthBM|Tp`a+AlH`R+S=g$<0QrIfyu7tB$Va5N_6fd
z96jTF1Q<JD*%TxJyUwL&?IYBfv+Q{WrSx`*vugEF%L&Bt?ZDOkj{2rq3m*vs%X*%f
zf)ihH;0e$2ts%HpZ2FS4nC3czb@MV}xPISjwTbnR^R>x$V!ls(>F$Vy#W}ijZT$L)
ze7kAfhUFV`U&^$tQO?T3UHc9<rB+7byu(1=jkm-po9y{7Ssug;)9Y_f6K2#|wX*on
z-kk@)B54^kZCNdgRE*um?lBI&Q6_`_WM(>VD~;6cc#{>2Uv;UCcm>8%`0<(6Wi=-b
zbGE@e&JH~%%#Bfo*M#VMeDg=WUX27f>nE%auMMvZ>MNQ=yH82ScZ?#ykXVjTsb7?j
z>FRm1WVV};!$=Aq(eR2Zn&vP^#0QuR)!Qe(=+0w0@@hg4dMGU7`|GBtu41GRDH2>y
z1ZNg4FYc06UfODcUMgMwDgvjEX6F`ivx}iPoH@*_%t7NKxU98~qvqm|nB3$pGR!{@
z4{^~Was8#^DYNtPK5g|!vbCNbfj2{#pgu_RolKJDUu_J`j}ejSLVwTabIERQUSc#a
z%1#G05ivh}=ro8r;S}F$B7mWaGL3N_4&4Iq0^)Z^`^C4k0(VY2Rzc4<l3WG^Wr#z4
z;UhV=_IYd@@%*;DeBQ*Q58Ua<8~0GWBNEiQff(a@@cE^E<)Qc#(Kr4?nVoY=A!i9v
zuZ`kYRAP|nH?g}4BI3rvd?r>?U#g9XDNJ@om;k1Ij7GcLxdkoD)Z$LU%6x}rpJ2md
z5|snc!uoUTc>RI}EBaczNPSXYLIUdWEqP*C4nfTA1@^C1#q!eua#~|zS0(ZM9JUO(
z4H6^6Vto~>Za0bQD~}q^GCH;c`vSLP-YQeKE8p~-!WzI=BLxVhd<_DP6ijsjjUcQc
zRzY6J3C>-Hn&B^J0?TC@b-0C1_PuZW-_<J)hz~dWz$meM8@r~5h1|~TQ7~{ewI-!?
zG)J4UrgK5~nXTt6)z(AD2~Y1qSo-Y9)rG)nYh^($N#jAoygaYkd`pSPqh6^)w(jV3
z)T)Jhimk<%V^=W!9tYv;%B{`Q7^@Hr^9$ldsXYkBJlVfhhZ=V~=&NHbGc4i5*)#N!
zw5ZzY?IM^Mk&4Y;>p_ZN&H|5)-kyM=PS7UEOIUl|`r(zaN`JNto#&4l^YVH!9c#~%
zuJseJ(E5zF)-;}s>(|*?<4MD0YQxOF>)JOmR?+2(`7v`WwKSJWU=_G?&3^}Vn^3PF
zHXYdIiI4u)^!1dX@rm6rKXVSY^@Iwf`$$S(eOxoyU^PTjiO*_|N^P<1T`+ZDU9%`-
zxRl!DeeC1>&c_7A=uzR{W)~E|BHTop6v${v1O)`5pt~|-vkqgvpDwNQCX<LHjQkmJ
zpp7SxF2#rBjBsNzq@<<Q!qW$s7ExAg*T1y15|)x+&j-6o35vw;#RwM$0DYe802^(A
z_PlVsH?J*=+*o|J#J`BdRGTzj{Kf%$XSWoahd*}Coan#Vg*jEhJDO}5#hYQM^~%zL
zM3UHkPKtEBcZ7}of|8^^%R=*PF4LytDzEeGY1i8GLvq@_I!2P|DUm+_L9+FSpJGL1
zEG)v{8N01<Ysm)+?aM?4JKt^;wy`39XN0ll?QN5A2tfLlk+Q?%!RT9jh@!_14txBf
zx3ubad5QZ8QjjdyZ%jB#M7G_!x7=ViwRfti@)$9>E>$vYdrna?V0RRyAR^+J|G0e7
zVEFY;DAVyM*O|@PY9Q|s_yCudCD0g$m7bG+`)mO|;fZatTXrmK+s8k}Gi8x5&+)D3
z<{4fIR8PL7l&dniZ?@ld=eL4ZigFl~z`&smZ+CW0Sg;=EO*7hd`|Ni2)9kEc*?8wW
zzoB4=*(%l0j|G0$_A~Clr<Ehd0UFfeIX2ulah<^6>TQ;T>Qmf;k;n*!F6$tk11m6$
zqhh0=`(Cb^c8?0<pwCf@*VGcY4`!xjHrtyc3<Fc02%(X2gaV<C?N~1E!Db@GcA`W#
zFqo*G1379_bXp(1aNGI{NVTqS>3>|ba_;Se#;E^|GIDmuIDU4fVC$Wz9~`V#z4xDa
z{pI9<gvC2NZG%kLS~gR=Y~{En7%Pd$!^-};qY0jvRU-bHsi56Eq9#`QSp7DK@>gB&
zfx%|12aS$^aPuWV?EK+{Rq-NClfmHPh#u>Tj8cd|(1&)u!V68i0kpX_mcK|V>Lp`d
zJa`M6H}aE`jt-9I6+MEGZJb_uxxG{e8eqPtSq<E$*2e$E1sea^|L`GxyjyPCon?Za
zF^U85HHMqZVo%uHsI@*o|I+oAAf(cNm*{1xe%&F3$oMEyX+V6P&^n&ztvvQb<H91P
zxw4sR*|wkECth9W6;~Ybi_^TMiv;gzLA-Uc5?N46iUaSDB~>NgvG?OWqrdpc9H&`p
zjTGbj4$FovSBJ&y$E8rdnY#hiA$)m>EK2dJO-(7ZEd0!h;j`Rb;Zj{WwIx>GTlefy
z{d4T8m>Vh)@onrA%g6p>zo}G*r&*mrBUImm!@|-F<h8iU0XZ#vlvH%Nccx9f^?Ppa
zQvzkTWhXA+;RUeGgvFg1aK3R?zZ$f|eMbe^B_A%JJ|8jA3j^~VcyuaXs~|d0K{kMv
zW1Dr;(YuuXgnI2dOM206&2VyRD&(fr7nGyW_dt&i=BK$RT8DA8>miR@miOS2#iwk4
zAOitfeU6z~8g_80=!2S=m81Ry@VpA<_nb8hegg8;#KIU>YM3)<r*NC9`K4%thI$JP
z0OFLqduyCq%fDRwc^Pj^>`$}p=ClntE8G_-<J^(^#m43_p-ZaflCrn2YDm$YsBG^r
zs3V&Zl@a~baOqo%L?^AzY1`cgz!ws+q{l~(+HI;yRB`5_Gks4Jf2q|iVblEmg2q_p
zn2e0jw&#yVdq_R4XFefGPFF*BYm$z{hPT#Axmze0TFXi}O6;i49I7Uf&R&4{r3BYO
zYF)K86y3DSeegk{tt*%CidqYq!LQ(qSnk{CJ<b;q)xhwJuj{;gR*6y396ysIl~Ea}
z_Nx%ro&{`M1$KktdG{l^ZB3kT{G1FymI~cZ^Mk6`^|3xV9`PiBv?P}`Y-4yE;*`{v
zxx_*WE06QoZg;DVkw1${m!fAQWbc({kfrc~`e${9=&%3|mlqdn5UF_N-h;u4j@VBl
zcK~p!cD3mk?JWOOXOZ?T9ALIxz56<~f2t`}V#a0#jrkp)M;5!A-R`B-d}pgsRBvA&
z9S5GRx~_Pb6Vz9Po{GrXsF|G6>cqujt@fo{Oz8nRqZo(7#ie-WwGWq?*7*DjYny6J
zTKVDP4d~Ze2IOjOYfpy;FB)Q=YM_-?+nBn%T37qq<x(eK@lLbDU+8D!KCc|&fInF9
zEJVbKZ<d|}&`^edG6+K}@J1^*m{TikN_S&)`N_qEX0k_wwjPC!V4J9Y7IW+hCPPyT
zsW$mB+RrsMov<C^Eu<=K$R{9+yYAr<cE`7_mYUajx8@zT=AQz?g@>ifoUPgn?b@KP
z(uMASb-Zb${=Lbe1c4{PD3kipb2+=vh>qpDwA*;~^HC(pJOBEAYUInOkJAWMAf&I~
zJq?4$YDm&|a{5Vhp{2g&_HS18M0dw#@?r)P*t1JSP>Z@m!GmNKBm+ScUn)=n$tGtP
z1JFCyw+msDvIA1Sov!wdrhmir0z5nTaj(_)2tH)Db-iY<G~CMrwVHpdnQ24Pn}&Ij
z{(3%9sdk>MAIdQPgv4~~LhqDr&zh$9t+2056Lfw1xSrf75%;EZwM!%Nx}Nlm=9Kq-
zOf(U>CwNDb3ZrifRw;MmwN6Fd{vAO;8yW3nbyTQzvl$^L_<6ih<188(iklFoip#2~
zgdLmTlHf!5Ig^IpLMguO3MpPp02Lokzgex;O<_BqCH#ex*eeRA>M)*qD4E8TuWYWP
zIgJmdbKbcj<<I5e%1p`wE~g@A)s3c2<Q5avK!gM-$(75-Qg|~of`I)$g(tTw0`9R8
zt`MlIl;Z1aE*~q)+@0z%3I_iS4r<u0?s(J{oGb|7@MIvjGi~kfdeNLtBThI}_Q}u(
zM!_d+CAr{ZYsh%O+Y|ZiL?YDXcyyEhhN*3(d`~#N+xr(y^3EYF(!YfHMsMKyk1l{L
zU0!v;G7jt3(X#g)9B6<|zX$7E9@I_7qiPTl-P)OLx3R!bo_&JIz8Oz$VWvYUN2&Fu
z-xYJ?*Z@Bv7DJsWa@g}d$n`esUSZC(K))lPW(183#omEd>q!3g9hAnc0Mmf?Hwji0
zLEftGIVDKYH;Y!s$p^!0rc@Mc+kP<T8`SYArxeOafL?tQkTa{&S?@{BHX=YG3@EDl
z7R%j{5E7b}S*d(o9xvc$kS@R$aBG(Wuq`P__hK_vi8!rAPKi9qY*;V&_UovA1{upV
zjaIYGmUmQTk}l6ND;)|5Ymwu2;dbfj+S7Q1EJsBUzP^Ol?tWxHugVI+((EMVbfrh}
zS{}RYGXV&_Dy-T0DV&H*1`9Viy<#*Hp^?kBt>T^hg4COEwrI||t(Fo`S|er-zxQp$
zX}iGGP{A2nM780Q*B4F+<PrpuCV+sbcK$-~CXMfuWfyB`u02I$fogvEZoa$4TI68T
z;CKC4&5|GUya`E3tvA!W7P@Gw{%dJ#fJ$1OWwVKDhu^r=*ifNp6Qx<we$vyijl2in
z{BBp|+^1l1_;t_V_pKfZl>hK4o5D%XOX;n(G(&zXJe|MUhaowceRm1QQC+uYj(ht}
zbNpteBl70kvk}!~;7lr=-u0RdTP;!pL&x&$>M;h1F@KSa$g##})B@?{A~5#Npk&Sq
zx^?Xuf_b{jFKXFWJS!QdMMT?V<9c>3!0OY{`EqIH#*6b&8Nyq>ELDbdi!IT2n^uI^
zvlk(N<n1ZjM!y+(dG5Rzzr0u359cG-VVHxjanCk%@tC8H7<k_XfI)Q<;0z8tTkvM7
ztmgRLoiA{CnJMpt{V~09I^;P1n)Xa>#qch2ImY$$l_|*O*3&-5;TKMT{DaLaZTQWD
z)UWxP5&3n>Y6n^gMCTF(@;e(QI_JAk2jg_P?#G)hSIdx1G=nKyg|qilkAUOPryX;P
zVnNds_w#q^8wu<0>_^uY=dv2ovc@)C1)rQyQ&wcLc|dQqmn%kpG;Nhvy6M@gMFhU!
z=<SUlMypG9b~aREVq#H=rLdL+re7C?6He>|p?-4Ydc=jc)(?RV#R}j6k^Gb0aYO`s
z+x@eU{qZ$gmFtB3sDM2sEF4^<UqRzKI+|$Cb%Cr>VDDNxu=+klJtlpj1wMVrWyL--
zP9$!p^YHV!n3^|9gUwn%#ENGw1dUu;sNJiZ=VMjzqFz$iu!)f8(gEoYqmXHA@%tAc
zNRIiUrKHpk`XCB@vPjjC{fg#qui|<54@3?Os**+_A+mI%Ukp5LkZpagSv)!NlP51*
zQmUtQ)FY+i3$r>bm`<DaeB>PF=sF*ETTN!p+;A;QtN)b6GdpZc4Kq6Yo&kF$7>|Gq
zhSv2sPE%7Y`0K^NMb|>IA(3uQPDUni+_~ho$#Flf^F(%Q&=wGtXWMO7fkh>#&4y6f
zKQul>@jjZ-MP_Zhf^7oNdXUN?NF4UFzvu&X*=;{7;0)K1nGiEEO|->49yli%uC=+}
zCca9T`f3&$73Y``pF!pfF!*TSb+Uz-ogM3^ix|>zY!hCa?Iln6!J9pLti*?qT#OL<
z5I!_wHa4PY?)^o-%xiUKWI4ewb{O+9w(YU-iyOn?bl)387^L^2u)t#Ygjpz;;V_gK
zO?{9E3&6?sZZ7j1!f`d*>*qM+GI(^MGUA*<2=+6xv0=4`ArXU1L@E(SfJ%$Jq*&W8
zL(xqvg2m#Hlaq_1ocjX1D)|+rSUmJT=1@k2*i3R>UR3I}sMEX9ja}GCWu7^fi3Wty
zh-R~CrX!at5*PfR?QW1u(O|M(Ts6(R54J4S(;8?nY1(gBQj(R@2aKUsdtj*5sufoE
z8Ho1fdehN|6|fn|dvc{`*<6@q_6_&Cz}45+_q#9_cS~ARA)&nvncOtrb6VHvUKoE(
z6hDk^=lmI>AIAS9)aIH%*8#Al>%Fx0U08JahtzY6f|ebh9y6bjcG?#NSg0U*OW@<e
zDYS9`yy|;HS4mqLz&Ru*r}{M<(Zq>3-yc<SD(++Fg|>MeUN%Dy@HmI%QgVO`cX@X5
zXIq;m`{&d##Q~fuyGhaagb8*DV!ym^SC~!qQZjPd!gg)=70X7;5l~eyw-XshNq(^z
zDNSc@wM8x6W<V*g(^7>ku&Z}9&x&rlWYOkqX^E8Ngre#3-aGXcUM>iOC1cDh$0Hww
zoqP>4Mn_;xnze?)G3+VpG#RS<VG5|3$D!66oi?jZ=T2pJI5z?VP*Pa?7I6o9YilAg
zX*EE)8IE4URRl=uHM74?bGI^l8}wuD1_74tKR%&htzdG&NuC<S)>9>}i7DVi$szJT
zS{Z#`p9~>dwPPdHY*XQ7EzkE2dMCD()z{5}U65vCFw4W<kC)F_c$GRItJZaW-P%9K
ztlgbxm6*ynK?O_At@!Rp!!|G0>8?;m#fXS%X{FY^c@)w?yg!;&Hj1COe@Wu=E2qzi
z+9}Hr=@)t8YaNf@x5`pJDn7iY+tcolsobfR#Sp4A2NoY0+K#HJ;F$%;LLc~F4Ij8~
z$g2CiN}3|eH!>kIF&vjoE^I%@qg-h|P`p?b8_O$^y~g(my0<1fuweWSHI!ebI>l`!
zgm?v-*1bQ6d?26_suh!D{Rk5(+nXU$*gxt47i@@L*<q(xm_$5@Dw@ivwR%fIj95=b
zYFg88!S2sUCMwPt!eWDmCdrk1oj2E}MXoRgPB1_M)>)N{nV4KVQP>h}jh#PR(T2es
zDA&m?%YO#jYE{2ZeNl^#dY!ja)JgV8XID#}vz-!*IN>O=U9J;T%%WoaCM0zthM2Ou
zYq}W<<8x#vjwmF$AQ$e%-M#**aMZFnH1e#}8NY_Sg#)1hj7nB^g8t(z;)vBCcp$02
zJdpF$wYaeQqW|Rp-|G=hUw=IWqq05f?WreIj;crGud~$j#xmDhjhgPCK@;}4(<deh
ziFm67xvEPJpY6&UyQJ~;Q>KjMwazUq9l3NJ_jO$BGd#+&<K?Gibt2OkrRy{`=}WAd
zQIfRxQqrFLw_;^ZWwkWL27icsMtyK^-X+ftf&WIz`kjWFUR+D7Bqb#$9U)f=#oXw<
z7JQ4C?z=o9>cp1(fk4DEItc6Yjn?IOITBV@JdYp2*IMw?$j>bHKR?;8&JjmWk}=J*
zKCqC~&%K52*eubTgj-v=HmOVx)@MBmf!qu~_aRz+Oyz`NI!WR-c&g_l$y-pwVJ#@C
z8p9#&AG9q>-RKD>n_LN)on^n!7AiB}pfqp$z|L7u%%}P(w3lndznc``1fw{0L79;Q
zYzVM)#o0Pt&ym7MQ(xCgt25Y^(nE+umAsUP;|Oi5F{#@(S=S0iA(Lpj`KDpY;-TPS
z`(EBpyK2OVgkm?E=c@h0i7#5O#;^owStX0C9CGx-G+M`EmUlayHIuzJJE=0<a+X>t
z$jD}N*lG>PeI>#}R=(&va`@e?1)t9?5YxX<puIm7tcE%_HT?SqSri)C>lQ9EK0T1m
z`(A%=e6%~2Yn=lY^YdTN|FwSK+}<?;t9wA0Qd#%7jixL6S<|U&hsAzZEfbFxsZ+GJ
z0uSWzj_MY*DwJ}ol8-^v{$YEl7dt@Zf3~Q`SU{|aI?|5B*wt|r4I<=?NoMZ&r22H1
zY9GZ2H9R;hz7Z08I}1FZTtpBp>@HD!XT#_QtvHJfmaAh(V8bM$#oaY|V8bPH8wzkM
zPiNcFgUD8r!xYnzx?Wgci$UJO$v^V*N>N-1kf*U0EW-6GE&1CqLFX||WENmb`US{1
z&ZddmBj-pa1K)Pkh7kwl4N<8xfRWUN20Q0$DE?#$X*DIfS*(2!B0nj%x=utvKXhJU
zK3-r@Tqv!$R;r@z%+EF_BF`>jQaKUxKaZ_+uWdBv7-Jv_#<fopmFD=7rRMDAyV?I~
z^+1aYn>pcd=jRuu@uFiTHNC?{%97SK<)Nmjzg92F4BTM<L}X#<BZjZmDQ@LRa(Ej=
zlNt%5z6Il0VVTSzp~LQj0t1?Y2+fr#n*&g>aX;|LlwzP!QYsPXw!L@Ue`YE8Y#^mF
zuTiVu=ZE{NFXh-j!aHU>Al^06>3*y0qr(7ybzQxsN6<>>oeC|933ZDy;po?5TeLS6
zg{I<-nJm7c*y_(Ju@Lg}B_5V(G;}jSd1oET2tFSznyNPJ(_=d4Nrk{tnL<b0%GUX_
zxLliU?_nC+8t3!qUG&K1-(ySu#v1<GG!!kBt6)W}Vw)mWyI5jmUiEBXFNtg2xM<MM
z*w7C*8>WA^Hpl$Lt5tUIAwci`sZaRj1D%5DjLf_3v!BwocXzXztLLfN+a!GW@bC@|
z&}$4S6;i@L1<*#u#xmg98zEtvVQ=%=o1&FU+&Ku?>wE|104bTtVX}Ak+K>N}X2%%A
zCK8~QYTSF0#yp`j!(AXNM`nJ-Mh+PI>lle+)kH$R<ecS_R<M78to>2G^K6U9QH8`A
zjSy2b@O>%vr0^0ri*aFF(+m`4#AMgSVj)%`o?h-24CX8=aa)U}d7=E!2FO=ikzT>J
zVkM5ht^{Q$lWigiY}2lZI;w_)Hzo?OTU8$M3v@~q0Sz*XIF%2I=XdD8NbK1on<?u`
za(C)KUgvyTRQf^!86xPDzp2{7eH~uYhpek@HqOqZ>t~zxqI3EimQTXaiDp{W&8^MV
zT(L$nK+|+qTP8NAA7~;#B8EU9E1SxVV$ND&UQ~&u96d(l6SDDtn0pJRxVCL=I0*?J
z+}+*XHMqOGyAzz?!QI^<xVyW1aBVcWJ9!s--*fJF|G`&9QPtI}yXRWd#vJ1jkv;~O
zmE7UPk6~0=&fox#DFc&k7MCdiX+3#+m>7QOFfZ2aIFo%`G%?$HIn4JA>#LqEBM~L$
z&%l@IOBD_Rs6HmN+D03OI?H+5WeneHku?t)Ya<dLb?ei@Z#QYJDj|6m%8x{g#J~Dy
zqGAVC@}V&rO09wAPT?_kh|;X6<ci2O_~+=)FrBsub>WHnzNiEg#NFM!aOvt5GtmM#
z%pR;jEXx{CJ=8GAS8-GW1Jjm6ADXMp<Roal9>NQmCoHcJZCgwibZO>)lXX54++0(3
zSF=3KLJPx^3O426;;mX*9{(`8IQ(glI;Qx$b6j;_a4!n*ro2NNMX|LM3_P}zl>Bdg
zAwzn#JAmDtZ_<1JjHzL_UDDS<$na9c^FZi?=aWB;sCk87v(u@*o_5>x9t!b2zs!~W
zHg#>N_mXs`j6UYuamu{7#<9b$5}``2DMl`U*mRdsKlKd~Q~hQPN409U@NWWbO-g)J
z#1#m7{I;U^D)BDpTe)^*GI5>5t4k(Nh_?_FndAnwsv<@l7|iik7rH3UCvjslv(yPk
zD*$V8cIskYvJUW*Q^NB3Un!+A`0+S7m&K*zgiTe+2BWY;jG}n4Lh#v80n$|AQH2PA
z6lb$u`&rCZl$U#9USNzWE=K${7Y*Ne><g~Z7tI0?VI!3)i*zFKFYVA0B$0^a2gO82
z!|}Hiq(ur{mdb}nqCr`+*~4a;h(VR02rB*Ya&&;%c!aD>sla3Ut;}2dhTUxlZoNnI
zh3Nw(n-@uubgKV;u!nIt?97B^V(*QjMcu+un<xCI$Vd$K@emY?EyVSJLJ{niZ?mLP
zzuZQ|0d}&cb7{2hTq-TnBDqBv>AwqK-)n1%I)sRUv59G3OAQ_bKF`4X0BjgZyYwG(
zaEYu|?&qe%4n(0Rj5*Y%XOQK9%OP!HxJaaTMjdkA5GVG@hkV%O_T{T3^&!r&Aagc1
zZ(nP|GOE*57RwX2(4GFRktyYw4jMS9pW!l)m>+J!dqot!jOC^K7)y6iYN>AcDS?s^
z2TqTfB#s*$T}~p<^EsBIZ0=gFOb5qkC1@yTiDzVQ3<hXx(syljyijcmkb+?yl#lY#
z#m~yt!g<@iOOOkL)6x=JFDZwqEw+bOXf<N`IZyXra=gTpGU=xV-b6TCud325ZuYdo
zFXmf6ySBe>fYUruU_U#W5s(_8$Y!NPJx|_&9>e{7ePNnkow^bGDpF~<s6_@@F|uJ^
zc9^@F(Ld1ZK=NFfY_$s)+T|^>X3-JGIjA|nUDP4}=<*fWd4;$@553nDJH$hX%cinn
z@yW+fnH1*|65q_Z0##cm$?NICn59Nxz3#z|WG6jgF+V^C5p(R-73WqKA${pn5zNO@
zCBSAK?tu%$qEcw>z&SGS3EZX>Ux;kS2KzZ5{=qz{`6D7mD`h2?i&Tp490%6-yn>nf
zw2=KoWIAD4$xKQBX-GlAV&c0$KPRnI|DGhz|Gl8~y(75~o-?IR3-ZXQUdKbB3c1Ke
zNg*iQ;YmN~Rl`qp?Zu$a5EUDXujSTZ@=OY|rSj4YZgF106kQY3lG8)vRMo+{3t3D;
zS!|Uk5LVzxW;^dtwAHdToQg)-p>|;de@`o1N+)-o4ya7+0(?rMRWD!E{f!Fj9WDpw
zxpkH1nU=~SAvq5GMZK*);xk>EGRAw&^VCzDe6bkb<{Vi5`vmvP9i(yISi?A28)tfS
zUL>wAeG=Exwa`d>ZvxyP1TUhXG_6ld3N;Y;wk!S%b{)})R-1i)*f)n-UGTR%?iaT~
zU-1prJ<qo{&(C`Gnq&oRwqXm5(Lu~gPWE#LFDc3&%GW-XuY=<-gEv3pY#j>We)!m;
zc*kodwaN{-)DG`vfy_Vy)@+S-p*J-8p<)0_OD3KNj|=@F<0jQPX`C#Sn+p5kckz!+
zZ@l3+hD_XiX5ffKjF}D02yhiilt>)E{gqz;>4R(KBHVhp*(acEnB(RU#9(@(&a${j
zM9wUgryh_sV__n0w;Z{j#=F$+0zu?wDvcBC??2Aq)$^fOh8B{Yg;?7T`+vGtZO&YC
zg1Ey3U9>Pc^&L}L){-kbif8m^Yu*eL99a~lsb;sHZh3EXQ$qB<LZDll1m*DBn-zt2
z!aCXnz$=}CG8*8SwWFQTy2x&$SbNcr9VSD>qMhER{<5TRdw^cw<`6SfQ3Rv#IaE%b
z2deg#M6j-(jffm&2E|=7Afg&fD^fUIN$hZ0#d-OjP1{|7zK1RF=GrOx-h90QQGFJ0
z+gRm<<I<no{NlOU=pBe)@_a@Wfv=+f%r&*~x`4sym2!HlHA?OJu3{ubPVWEue3w&L
z2&GhnXQ13w1eQB1UT)9uQ?f<3)h66sxZcAIi%oS*pSlpkf_RXawG5&2#(K>)3ZESJ
zq;FyhOzscgTHKxV$Qi#G*xx6}=6lwy6Jo#Y47m1MsOCR*NMfT{@epfHc=D^TUdQxF
zhWm1xAK+qTCzbF&{Jr)s3}n3A{}>+()}{4ztxGiS*fjOmFIg~My=na<go{8#M}j$Y
zCXqb>6BE+6hvcD|3|0LRm~;VxAAf#PWn87Uh|*ECHTn8;+jgN656ONTsC4|MTu1$h
z2t#6Ea<J6=GTNWshyz+ILdZan&zL0Wi7bZ`A-1t9fPg>+T<WNlZ}$+TNggs$g_S7T
zm3X!t-y(M%Be?;wln)V)sM#x)VK4$Oq=UO@`--}%=MW0QiWR}aqWdaYRX+uGc6Rog
z`BDk&IHW2FTQ4)DR|pSA=BKdTSUiw7+O8qjV><&t5j=G#K3W!pCBjdHRC+{DQ_T$>
zqf?#i<6)+ilpAiB2CCo2*kqm7p{F?p51_&$(FZ6OL(%kxN<(DCe0(}3Jo}=3ez;#3
zTnj-SEjmQ^{dfzKW5gv98kRR$+<2YkWYB?{|E)^wtDYMxq-zqcYX?=Yzq!FXJT}?A
z8%nBvzzs*+7cKT@nE1yHBN92p_76Slxz}!}_#bgRm<eBg6mNc<Y(alG4c}Q@rba4q
zm!td?g-d;AsxS7%{>;0Z9WTZq;elLy#e&!m++p)A0~ILOx~hEY@*I%#ZOwu%lM2P^
zFB=Obfs+u}OLu!XBULAzvK82=(9^PI+On7B=Ds^5mRC~2WLElCC?F~dzTx?7!~7u6
z?7E|z!E!)yQbsW_j3`2u754`wkHizqkw^=nvZ}i?Q|oeMpLR*B2D?)qH`t_JU)dHz
zgwtTR`1mA=%Si?VB$ncF-#&xtey@(AQOaHYW~wibm*v6)k;%9mUv6mGrM6n&cDVfZ
ze7K1XN%PFBEd--b5~t5OReIAL{3EHp^ojtg?~{3sgi*?HwRN|q7ED=*nsZeDD66aL
z#T^`|v8SO6QJiip--Jt8#D{kulhd>!U;F6V_#!g}TKxVOZ|d-lH_+|y78Af8WSLY?
z+Rw1h(^vUGJX2F|%gGFI+g0|KBkvQbut%U!7T8&$obt@8su>;J(Q@o7i5ct;$3D#J
ziGAv!Dfq027*#+paE^?f!iw2^Y{gKFPq`4;okrU|cm9cbag0Dl&UNB5-ZLD7C_Ee@
z7Fag~w_h^fCp=#;^Ek#iGq{gFuPXZMa9h10<+3tiuG+>pEKCp&_wW;{a4GI>sAzFk
zTyuLBe;1{gwQt0HF4OM>>uRLALEIctiTtMqvvz~^Uk;31b8*?`&5!Xqwhy;BN#cj(
zy?uDa^+pnkipYS>JZOXe<x7wee6298rlzKRgD=17RF>aK?+h7DAAZmISv#&)qqX4M
z&zU8)7CCT|mFfxw32zGc=d{7xFMZom6SY__lE1VYSL^6RW?cfeO~3g^ii?p3o1F;g
zT6VbTOk2DV2g8fW?AhWtPYXW0?WyHzd<mSEZ-FUOtq}Cnj^4y*ay&ruI#1W@Yjyxd
z%oZ*(Zd!~cxJroP$rs&lc{BFy(R1~Qtk}xPe9dxy@tM11$P@H^v03F9sK_TN6A7n4
zh}Ix0K>zafdvCi%@2ubqCZnvbWxCh=dETRX-4U#;A@a-}b>nKw$u2rR+wD)x;kx^@
zBcN~hpK-|LpriXlV50gUS67K|zO@~dHZB_QJ=a)XUUy?!gTTH{0_Z#(1{PM<cl?ku
z!k=TSafK;e6DgYoKCg$jww=(N!WPVd0V78DD`Vz$yiOj>ivr^L9kCJ(ImlS^iSA#~
zKmInOKY+@*pE3oaB9i&Ob6lju{J4$|S>A2@h19%-x7G9){I~5)6oUQB=dH9UtxFdC
z_2dD9#rbm>aZSdLm}*A~({QbJ;gdcRP@!6XrrThLPQGmRBqk50!9j=y!YU|R<Q8Yj
zq%xpI0<f3r9Sju@Qxh}LUb33d_wnD1Qclw$=dW8#5qP}Ntk15w=EjIGqN#a`;`ibu
z1A!S|F|u#ru88poI!utgB29kIpECe7{v`aj52UGfQfrZTCQ{$7u5!)$#q+Iam^$wR
z@Y9$YtSbV3iyRlYT>n-%uDs8=pKT&XQ7A$%tp4_6LDdH5yH^SoOIm^4)!XxNwdI19
zdXp`#re*=LK4^T}rV-SB_owXPBH(_8#(|~7)a(keP2)*0?M)@L4oI<+MTUX~=Qd)7
z?AmZ~ny8#{q*F@$$qlm+sO2W9q;mo}bEXdjO<*J<-UZ3X0%1Q{{z+#Tx2BqA#oC3?
zi<UaI;#*b>)A6L13CXiO#{+mYIXU_T3owYH(Kvn+>Fnv4v;eVS=R&wR)H4vX{AKeO
zO<<bW@7VFDSx$Wyrkf9O9jx7D*gr_i{KQPk6SpCvvMBhyIlJ}r5+g`;y@@aOO}9!L
zy8Ebq+;abz!uukP@sWq{$P(*ERpy7?5u?X^Z99uN=hjbxSJ|`yu~SlOw4Oh@4zGxM
zoUL}J?qwkfWTInPt5Q5-1~c6NZbt;iA4p8t6$9NHnK7`cJVfrA-Oz&?%Zc>C6KWo~
zIp}+%#6TNsYoTQ>YOe({ea)KwND1P{sTAuC(NnFu&-c8SzcQnFN+?}hpvFRrth{w9
zWtOAOSZK(i%`WnE#FUcr2YXg5@-u6>^D4}CgQJC)olbcmXvO}V?$4NSjwP_oy8n?j
zJfcoDyrYQ;&L%eLXtktuyb8hY!Yck6>`$0rvl?~@A(KRQA`I!1!D9x;R{j^EZS=eT
ze2N1S`OhDm9mA6OV-b#u$BZ-`NPTnE@+mcQ7%o=ovYNb#Dr0{L_Dsx74R?PcmaKJv
zA(P2=@2Tm86p5#~uT}_I?uAcDWzvww*w!D-D@|lw*>D_0OzGbo&X~3+WDBIuGA2-h
z`EMkV<9pvAZs>I_G^eMhU*PNU4h_Q}n5{iq*{)q3<iqoSQ&CB@*qo4&DJiRBKV6I@
z_PUt~S+X0NS$1=Axy4{Ea>1Dp+xx*Dl~m!d#+CA<4g|;+GB{H%5JQjYZGWc{$%`{s
zkV9}?QylK0p;ktJQufu@4TPw2+jl-!7za##0+1)==54svUT61i51h|Wt(kFRXoExb
z#pbD%?dHO4)(J@1i{;i$6Q)(j?lp8$Pab_0JYOpMm=oh2q<@D<G;Gt2;mnfXEH)3p
zn7uQI0<n(N&B=v}H&j(lhc0?!D?iUJH?KSn1H4NqCm4S}Q&@amec5yQpzyQwyys$$
z!D40wl9ThrPt<nRY;6m?YQM^Uu(Jzs@vOwgHAi+A7Jr<g{Y;ledt@AeS^}opRV9Tm
z-V8N?WVR~1WyH9A)ZJi~_G&M~nZFBh9g?jSy?Yr|kj$8z1mitYA(`qU!bLYrXuqkP
z&8WczHA^_%L}PYXuRFC${ynXVeZnGzjBrK4&27$Ddv~`^;7X(Xk)uD!>370}8`(as
z>M>8gxpt<%)q(fXV+!qMW<755I_`=m-094MGazPyN$Ao35;*h4yrjx05hKaE1_j6E
z_N&{qiq*)EPAFUG;+;{eH*E539(2#|Nkpgy5m<~!siv->3fZk0o=+njr-2}cm)MZ4
ztxF?^s~b5&{-GmIG3hh~VzD%U<u!3VYUOJ^%3zmSC{3$%9AoYp{#yfBlBS#LwBr1j
z3cXvYuv^ojZpdbFX!BZO7EdYkGbmUa8m`n(30f5@9?HsOniX7^E-htn*kP0x`v(=u
zy-=ugRCh>zg^WVSm&L0_vS(p5MaeejBtJ!tnse8iuSc=-HGM9FmaFSK(O{giY0QIJ
z@yRabnVj?Co|C2FWZHq{u1Mg_V_Gv<#byL?NUzo}6BGA$Sa1}%qcEH{Y;PoT8kYzF
z8JPmP6c(QhXIP<G!i(I_PP9JgjO=zufL*B2S@+4k?+Ou8J<Z&VSt8#a>ccjfRcH*|
zqk@)M4o@4}@D%vlgYZ_?U!-f?t)%dB*&!op5=lt6BOCo2hOJ*tKSJm~o;72*U3FD-
z=w$hdJwYa_Zm_>Wna-^}*8MoxeZnU_tK(1dK$jpl2r2N^-5GIlqN$%Bvd&m76E`!t
zJf8r!)<s^AknwpilWtrW+O~hZOoo$dOK%$}jEx%j#ahjc#1<4kfqiPuS7T8mabWyS
zdWec|%5CRLa|<>njxs$)U0EWR++jSE8OC$0N$@_{F#(h7g953It!`E<xn28JUI8Q_
z3RM0t#ve|dwI9@Uy}tqqhawAEnZuG&11Whk6fqA}0l^0cIR$PsaQw#5lP_zO4=XKt
z{o^3Mpq9EQc89?ztbp<x<#^TWX#lPED;P~FIH}OYa#<6Ao%|jt&Hk+-$2ben18zEc
zgP4M1C>+wDqlNku-AWYu)Q6MrXe!jTiOlBt$5-Hczai%vOukXN#?(868hM_aNb{ko
z{@6DPYpkNyG;JpuKtM;+6N``DJ3(iwbVq(J!a2}TL|%-dc2O1gZ#<{su75pi>W%1%
zH|Gmd>}>ny$TZ27&&#<(z+@OkrD0vQkL-khDwrx97XWZ^#j|75<7orZV3pNWM)e2W
zoe0(g<S|lHkCy7bR~>mBVjVab4W;z_q|$<IjSxr0HFUO1l!rku|K#&baxoXOM_%<Q
zg%6d(6zO8pbgTCHN3oj5<z^!OOx5Nm8ee!0HyZn^*j7C3=JWGz)_bs46s>D7CouaS
zqOBJ88xHlYpHSUdmRoNJ<rhzy1WV?WW<p;L^PWxbkho&1H&fiCr_P%Y_#x+TAG!a~
zkgTRwbMbKTE{^;)IFc7Rl3d;u5KF8v8j2b)h#$)R<yeL3#vy7FJPOAf+~RdWN8@{E
z@!<cP4~q3Gt!dr*vE2)4=k@xz;dqJA$z})G*M;XT_>cnO1b<Swt{;U{oq_!PmpFLp
zFDO|)XQbucARA;ey#dz<N~(Te?}N7g&>AC9|30(<6cE?l<R)9qMPaf?R+sbmNJlNf
zRH2`FHot2dY*u`t2Zd<OvQawNPGf`_v{xGBR-FBo=89yPXBJXS0(VllCc^TiAXUI|
zJce1+KIVm~MHWArKcR#w$uq3&=3B7hN0!qUNE5kO<&ck~7==(;x*wY}VBVtE*qmZ!
zn3@i_;I(;U6&~A19PZ#zJd=2<rLu__hfziJcR0+Mg5>Z<ab_9cL8MQgy;r#%Uep0{
zUY`9f#W6vQygC<T>tg}_L}X+Ugo2)0fCFf-bu1LcNxF`=u7BLIX1%p|Oi%CA<SUf@
zxbG)s`Y)YtPFpPtuG%_mBzJB2V4GdYDR16eO2AQ09dfM!#r#+Dj!SAx|4b_Lanpz7
zS8$F?rY(w*bEn0RP4pkJuy$J$N~Kbre@n|>-&!9rG#~8}l-FhEQO+FoaeYCz%1WO6
z>0QAMCUAY%LEE}vK@5hkVtSafSAcAm-&u<@Arr~8HJwVAboqP>c?63BOAqk;d6Qlq
z<w{nY=3wPDzwMv=vhD8|<_{XHdbL~g8mj`f<iA`|ocrb|y9YUixmeHNlZ}QNCkAmL
z!5K_el#$J5Dw@(*;^CeXMue|t-+}bP$uQ=rnvK7Ew8()>naf!Qvh@11kE@iPP^u6(
zS5z?3uYCIiv?#;Av`o{MxjAP0`57^z$xtWzT?H}hpwjpNC!yFz&komKDDoX8BzEB)
z^9`&iiU87l*pZ=7C*UGNV&SV;NU|slmC@!#F6*WMkTQ2?)V}zk`8*#%Wrd5xa^8|n
z+4|igBQc40aw-$%92L7!ewqvyXaG(w%yt;ZvHRZ@8km&$X~Y($!DA&e`PwGouBvxu
ztKsG4(x0``5aB|`k8pq4JID`&QEB>fVUwCax(tRtO|YtT2L2ETFtJK;lIfd2eOQ27
z^64mIHkmi)QaRyxw8Y{4Dq+@;!c*_X$kirt??01D2bNTj^ob&#(G$G-59j$Cl>d?2
z(iz5G-wJ{(7m2I*bN}fC!d$Lop7r{Nsdn1hS4Q(<@juA%8+Y8dQcs-y?|bdk^v7tt
z(w9`^BBO&wnOPrUri-7GWHU|USY~bpxf&bS<C|H7Wq&=uw+A(yI!Z}@uB&`CzcJal
z0LgZ%bvZCrzFyuozgD(gcKyBo!T9I*JG2ig)?yaOhyAD9#%7s7>>~@n;k%*I+ZEPX
zPB>L4m8pNa(ZZVXR~dsO%#bRnXvS(39(K{kr=h!&!ojWnrpSOIb^}-ah}FghJ>$`u
zz6>J6-i#~jCZ&xZ12p$Ft8I}Dup<`FuFu!nn@tu@+FH>z!jt7F0sBTtw97t;sIC0c
ziZ)YpTKBpZQfQ>(#dTLvI3*VeL;xu{;5H!-e$lQsi538>F3L)0mGhf1VZ{1sCZBS<
zrm%N%xv()4qbkAiE#Y8SFl+nw5coVdu^c~`GD3!~6OmajuZ&D%QWe$Zp5<UXx6+9)
zZM$MER=7*>oR+6>SdwVlnB7HW$?w*IxVJ6Szj`hVH{g4<u**@#;ai)rdqp!A2OE=e
z$Pn+(e>lak9t@{G(YY=J%d@j)8!Sew4Ug`wA5^=nZtLsBAkX4-=+laZS5Q4kWy?5J
zj&AnQA7WM~%0#4oHI3i^31w(ni`X<-kJxQ;LD^+QD4CJ)O&IkjfEb9#{x&}yrPtkM
z1>Ao_tm2-z=B9!<r+Xvbn3z@4B7r|Z2{0@@EIPP6KDfiLE{?hhkya=SPCGfFvEICc
z0yy*EY<>K^7ligg(pX|?k1Q-o%GaWsHr&8m65AMSt3Mp2YCwv4K?e5%LKC^2l=?}K
zDhurYQ3P1^3WJOt{Ke~LwCC9Vay16|*?<4=iN{k8twM>1d#usGOM#B>`-<7b2-$0%
zeXca)qe2m^*V9fyo(n!_F$yc_7(K)2HCXD|)n{ZvuJwgc@+<c=be+%h>7lBZT#8|D
z$0D!W97huJCR7u>$hu`&U#Gs-3<IrJ`R3YOS24=K^x!R`QUPv7?43!rVm;!}cAitT
zeHUoIApan1h`H#rBea(0@lB1b#YX&I)Lpbv%jQ}}V1?TC+iFVVfQlSPF-oX)ibGm~
zgskfkO?u>Un*BJYQ=ZG2IJo39&WztU;p>zDN8vEKgK|3{eA#oiu7bf&<*Gk}d3RPd
zIK2Hk*v>n&vP$P}esgAi{zo4?zvL4nV*WG*Mpm?%YGrQ^gbdSIWD%|xLKMf2J*Kz@
ze~*X94B_8I8(H*OWPh(aw?U2Bxg@<yy62e-x2^#8iq%w0;>t;w`8|1nHttj2Gd}K+
z#P^l+#-^GRarcFUJ?2=$`9rM(bn!l%^OIE3Az8gg|DUJZ<ICbM8bJ~#4$&w)Grh>X
zOQGBtOl{Wr#r(=jxX8#z(-;7LHfKNGqZGq!%`wX)vS08Z!lZG!TwK9}BP3v~s&ngO
z{b(GY&@clVqfA)Ne0k&MiMv~pM;eQ>)K-SmS@inwv^beu3)gUGhw<x*2ouPsLEJR*
zXf#@5qVc~0^%gZX5WXBAN!QU+zMX&lww7%J>d<Ke=x1~uMw6R#b}zIgZjmp`bmJO>
z$ft}4x(x<$zm?vEzT)(W=0t3t8?f<o_Nitl&gr8nzOZDl2eoXVs1H=V2<XXSK!a#f
zf4dbM&E<ON!7`H2tS*%Fw4(F!Vk;m>T8+i;HDXy>cZaNVsBNn@X-I2dTfc`Ro9--a
z51xh|V35<-9fWHy?nwbisl{4ehY2LIma{ob<^uHPwV;OiT>+szK<%1LE-QjQ%ZCb!
zYOKagt)*VeiZa^h=CpxMVLp|#HPvLMM8UKuln(64_*(S^wCuYz!_Vi>zxEv-ul0bA
z$N9dBmiS$J@joIN=DKNSFBadTW?EU4&sbdM0B9?`xrtO4upZ`_W4qXA%*6B?n8s@!
zl{Xvg{N`1SKpMCj4Az+0iynp;bL`7_RV#;_VL(=hM88aLcHlTd)&{ct1P^0!kVh`g
zE8a3n2&-eG47KJ73XO-NaVsrL9iHfpwRJP|YY{grIz%zJb-v+n@_e55ANW+7OKQI*
z5&^<KwbqM=j>M}rNncA>qp%gegf+`(sw6C3w!33AQR&TBHD-#g%cjcmtefA@Q{D>u
zUMRca(6!e4ZhSjlIjo~|iSi^RVVneS6~p&t;rqKBuh3Ks+vb`?xWh@e!nmS4H#-Xe
z?~^}7(oppRn_=W9llc;b!K&wKx5!W<YIBy#C)R&!nwNX#%WdD!7+fA-%;cC{u%EE^
z$e>K1G0m5t;kCXSaE~tw%w|Q-En($&mNgq-soAqlxb*EtLm}T(1(#|w5Ms&M^en@w
z(T<q}m9ExgvcTD<5W%@vdC;z6%K`;vdkI9sfQX*vg2NzG>YDF*sBAV52z91Yv2gx$
z!!sK6sSj?~WXxkCGP<(hvT06vZ5EYuU#5ArUC%cnWzyMl+uPRyZ^^m3XCvv0rBe;T
z4K=3-tK0|+aKU?>*Moz>m6erKyj9*hyhvvqMGdV-zB#>EYL(D9B#`Jfp{qcb&9I%h
zGzBdaG+AT&-#*)~P?7`cEpme?j7Dpuae*;+N8zL*zPe9&4(X&Ka<4rZ1O;KxHgA7e
z8buMJM*{;5{<vP~HYrH#JS`A@BpY`f3gi^rx!9kh8h0RvO#dYn7Q8GKhUN&|Bpg_7
z^eknNlo5mfQxfE-yWrTsn8{rJIEz`eDT#YR>V+3&*R-A@dte>o&+`3}&c6)l8wNjD
zgiCcrY|RDTSAaLBR^C4!KyGwjxt_v%t^S^XHMQS?wN&2D3n)!X!!iQ*?-f~;C=1Pw
z6dv{)7C0O)(Y8;ZtLnJJ%JMxj`TVksp~M8GvCQdOzEN0{i-&5W6^mxsZIR81NuFWv
zUuK=Fm=v>nC>11SV?%q^aV#pG#v%yLw%;X2XlTWRvU)_t#S%4bnzE9#=rR;CV6@{#
zT&A>UyVls--{o?wn&ES&HZevO1e}WUV5x$nWSl;`&`OAq29gNcw!%MRo=us~!iols
zRjzwF{0)HLzUYf)2!rl8wkL_G$sgLn|NBA?m&JsNx@Q9Db~2BbBW8M>!^*RGw;##X
z>s|)OfTj9Prz$A3mCTBm^><tjV!Le@?v<3o8@kP?qo73|H8lR(Q#~u~e&gk4BqB%6
zejTUeczXav(&X0$#Z1nqL8Ifo9TvT;HrWk5A8+)1<$uf-i)VCezAWY!y}Lk4NJwZV
z&rtwCQ3-<i_A{xp&)Dx^k7CTMg~wF70H9pUtbC`U0`hyt@6L$l57-|BPgxkb;%8^a
z)@n-ZO^yrO57zX$gvqvZstR~ht?%y>L?J{26WPuy$(R;Y21;UlFBih?H?vYp?H!-q
z$_+3WEn%;24$Ti#oWIAODcQ)N-knwol$2t{OAT%@XFtNi@xRzRDc8gKP>{ca3iIvV
zd&W_qg8Tt{k(|;NM0OqD!urLYLWdc`wV=%xy4hLg@hrvPH8*@~)fb9DHM0g2(mSER
z<5O$IPlVZP97r3hg_Wk7r`x8Ow6v)GqLNxt65OC)X&$@q*inFnP6RePnW?E14;Ehx
zETQpMu8opeVgwE+(h!al>?HR&&p59E7gMiG$<iI8WRq7!Yno*~%@I@F`+=QGlAq0e
zDwB6T;r+;-u?$G$3|PETQu-MGfeLGRT&i}6uV1Cv-8F`X&Uf*)TZh=+Wl=ff8bt#x
zBre6I<34s~=3E89po}*n$4hIIE~5~0u;|{aFDG3|pnUjEF+m?bGCY<MmBw#EzdS;7
zYFaS4$Hp#Orp9{$p^zU`Q(^=M1=6;6M9dZ!78X*M>5dnxhK{ScqN4ei{rAPGX6vrx
z8S)_A`=EhaH!U{Lj@eaH>cCfdz9X1c4tM^{c)JCtlI%<4cpT=Ms)pBXvlA9r0sE!<
z)d+db!zDUm%$@bdUvpoQys<>$+0Ogi(p<qOQ!LYgMW3)N4dY;`UsKg{9JbWKk-Fhe
zu&N$4w`rVtGtg?>WR*HO<o&n(1xoW3sbMpb?K;spo_ji77Z49u$z9ejfjEb-X_$0T
z(|~9I4TR7t*VTn^wWrz_(MU`iV6xSc((nfFC!w9JcR=(cnbtMIKu`fCETO&7QB+<P
z>3e0)zc1H}=VN-kx$%R&o7zF^tNeq%Bk^<Eonb7??$h_aT$;Z_9JKh}x&e$sh%}BB
zfGz@#YynIWF@DjLeCZrM5f$ClTn3XzMt#tt1k~gZd|jIv_WRex-RE*aa+QSzlImf>
zWm<CN^=o`Bl@1H%1x~MVli5T^-l}UT4Xl|pE{)}x(YUr(ioVh*<eA8}SBvp;&KT$_
zjT8|0*0?+ZkeD3rDmiCtrF(HiLLQOrvbGsoN}GWOfK;EkPHt`~=CX#4+$QD?ZA_<4
z>5>W|STba70dfwx5IZ}2uAvzxo89AQ7ng<<hnHeThu+V|#>Pu?hERk7L7fSdnIaI1
zzdkE0=heyG%oFfJ*_<pfieHP!>ouS^s63DB(kwjR=jV39(Gq22{jpML`Hp_4dLkfW
z^5v6DqG|j!F<fR?i<8`-1bJrQySR*XM0#?vS(31(T^bbOdT!I61R%V#;qLi07#=?~
zZ3UbedC}vs(AP_RYWN$&5|MXO%!3ya)%HsLX>JVf=738&%pEIv|E1@gmS9vwj65-Y
zMj)0LF{cl<9STHz(0AL2M6<Nv7Rq>X!?lu68D6tEKpAHx5ZN(@8R3aSf|io13RgW{
z1&JvEBbnVf8HJLTmUe$WhSh3AK-lR6FtV4L%%UanBNE|y=1U>cj~*sXTeM}r4R0Cd
z&{0YT(lO7<xZJV;GFDUxiHQc+`x8sGCNQoiOMZa9T%dQ-EITQZkgY0sSa^73oaxo>
z$UX@|qRJDvMl!#nC=4O5l-(Gz&Ao^7%jVy=@78P0GsFJ5KSqg9r83?3Q}@L^0FHf(
z-;5X_Fc9NoT0*Uzp(K2FvK-LG|BU0Giy(>`iJ)Y>!FCKD&xM)|Ol@%T0Ez9LoG^4&
zt|i9=dQ?=@!NV;2u(OdoCdtTrV}*Q4G%8KVBU}%yEc5Jd_pVg*^z1e|dq0A|n%18e
zFpb1&tP~sih9SVbi_#10Zs&1GqGui{Dk&Ki-C2bQK+s3!1!aQ0|BS->%-`l@)|;<r
z%(IJ7;p1f1n3sV((gAPd0Z4r`@0uJq2+-&Q3au2As~EtqV!pr@evG@fX(BF$B=r7A
zs3psoU>GIJ8F=Xrr<+0fIEiiau0se0Wkwc`^{*n~tPaP@|5vvDNqQRzF6d$x6b%YB
ziN<FC?|Z}Yg>rZH05*#lo<AZIn;qjXpfNPSPS=V+>2rKI5Q6W4fX$}9hy%yDi=cf|
z5pIJI5K_SaO)h|^5Xc1RHz>(x0TkvqKLRBWoo%ElYljOeoj1>I7guwdu6B1sFTU(k
zVq<ea8}W$7Pakr^4?(jZE~ppsJI!FoXUZ$jt@~mE-i7E07XI0OvR8PM(X9}sASRO>
z0e7Yc%#*7?M+0+41Y^l6ddjEOc)3Q!Mha}U%Aq;AzY}*~6-JYGT45>&YnfK%APLt2
z1jaWLn|#Jw8QLNxrySS_ln%8HvySfvoQKSWfzDq?QASaOJi>B`<S5X^<>ro|lf}7_
zmA!Z!g+?r2OnVkDZedm!7iqq@;JwN%gVaFB-zxx=OU$JF+;qgRR<b!L0<<TZo7BTP
z;LG4f6MoAVA<VJ{*Yf0Q6Ra05qS75?T$|K+QDh0jbHkctzLKsk;+k#)W>x<Dyq4)&
z2l@SK{_b5KENtUZfZIR-l=oboof@FW?+O_zmL18L4|X)cL#PwPRA@w@1St^(CXppi
z7gITFmcIXXxh*!%L<A_c>vdfa)rrbV)LWbxgy03+d0nSBRv{<Q4)j{784c1l8E!lr
z-e6_w)Yw}%XGvYYXw@9HUsfAh57k;#4IDGu#a2VPreqdb^SwDQ({LNJ`Z)DusvAAS
zl3qJpSMB#HDWm8pI!{=Rx8Jgj*Rk?howa`G(m3UDRDpFrPUZM3a!L^)?b8g)-=7&*
zg^Q6))+jBKsGMvRTs(O>HN<f2_@Z#Oo_upXQ`?DF5pwXhGP)_bI&#3(zlBFvz<V>4
zX_pf(yr_Y`Z?eoct0rFrOGlv;7s6C{p38%&jq~%px9uGSP5`*sU~{YB*|<g>!*L+8
zVFGPfmgo(CxNRt-j$&iIAL|l*4}2yjeY9@WPT`{dHmFcsSImO)i+yT*NSYSolv;46
zYeW>oD5Q2UKi3gGbr165Mi6TelFe>3Q$qUuY4wwAc^0P3eP3LmI!2vyF~+s6i|I?r
zr(Ktq{gp$evfoo;S1AkbG9fO$$>i-_ao4ted5@$?aRVKADvizuEl5ntGe>1O7^KmB
z)UuDH1vV5)To5MEgf>n&qsXIQW;LF^0io3FUIu-3IKB5#28M~$c^%eRQj)=-3GlFR
z4NcvK^}D=|n95~TL5ixuxD<jC<I3@uDfeYdsYEu4jVRGobUp3v%<Gs$DK2=ExPQ4+
zyXX?lssCzq+}Z|cB!fa`B*;=6HoQ=(bpP1?<_0lk8h{e0+%0hnc%)+E4<DUB9=uJ?
zVKTC9JX?jI@u>*~Q?v?V7r%VR^EO>ui;4lp?)!WY(sarhdv7u3dyA!lZw}3>W*9=E
zD!+#Zf_Vsj3iCE`<dle%8j&8Sq3o-*%EP|2l~dKoPw^0cvZBARKJ@&W#F<Jm%y0Wq
zmVKI3Fw5~=6E|~t?)UW(&EzZRZFE;x<KdYTsqs(6&3-=xwe33M0#<8uosg-h81*Hx
z2Uzi|o6ug;?V9N<Uag&bI|UY+&{LBqgiISlT6ab%BVc}u?K>B6pOOlWAT;$<*_7{b
zS6u6vC!jfaraPxCJWTjoRhKWdC5$k`6pF<@JB?nX+$EFW_5(j@o;#-kam%ufE4Q5n
z<Lf`9l6&fMj~MXwh&bB^`z6)!mi=4Q$xo+y#01K~Z<q<E26_nD9c7qZ8)na*A4b2#
z(Reo&lx$9?(g1&rn}TM>-<(aw4piV<@k0xxr%mX~R`r-b`hQ}z*HT_sWz6Ih?<O^4
z`>lxUF8c5rbB!&IADz(--dY|0I3;IM6AH)d3$XiiPw4L&YU@kGQ*b>A8q6X)A7dgh
z^&eJBx9kf=OCMF{<>RA}@qPq`5*qI;TEwRUD3H!v-Dr$zg!n*svdPvcVq;fGjyAyv
z!wo83N|5`tRP{dHxpXY>Aau$YZQppL*)@M&rZCoFaI04NaTlq3o1K($?btPp7fas@
zQVL4coZ3alJ#yG3+0q<a$64iK|4u^=Tp8}V9`i2uq|WlqY9J4%5;9DZ9l70fOF|jB
zPA$CkSW|LcR-_46a3#6)T6+%9Ox@YYmRF=<uk`?cyP5xtE&|$hcOykFI9n}exG+Yz
zYr8kj$zy*-cZ%r>Gx1@B{5Gb&-|16=p;Jke5Qlcm?>D$^3xf~A@FpiH{cK3qsArl^
zU$iyJ&$|8BJ3<!6eD*J}_!%F@8|C`G<R8bBpzubD&+uv?U5=%r_be`db#<YXEshRS
zEzgf$=M^*6i4yTxiS|6HaY>UsxypJl$^^x<_T$6g>cLy3#<J!U8@y%Jhnjou*16a<
z4R>(%CzWD@gLSpQJmjVd<_~x1IYqXOR8q<9k95$_A&0E(iQ)3%hc}*2T@B!1+e8H=
zwL0Imz%c^)zoBMwD!jex8j7WMG3b>8)?(Xvb|t>`Xmx<O!atS-|5z=IWv<uCq!n*<
zIwuMKuCnFBv+}u7qPgu1{oS*e=k$Zz$KNW+eM&yQXDLrlJ%F*e{cr4*w{Li>&7Pcw
z^vdU>H4oXLy=X6Z<~9OoXQ#V7f1Fh@59HAVKRLPKgcMin-JszV_e-X|kFk`l0jw5T
zVVxz6wIH|l&gur~N5BH1`+iqWgwBoLEn!gBor-$PVRbaSmb~2pxxnd|l4&oRNU8j1
zrax1mT@DZCgR@-Lw~J$bHc+YsrW@ngkT>Xfg2N^s|L>b972Gm<f2l9@_IQ=2Y2jfx
z1{Akc@8k-J!+oLQD*Ef0`q}vu+x8tIrkjBzWU<AH24%BR1J$>e=JR8|HQVA2B-f3s
z<9pqt;5uo#%m7D&EoNXZ&!*6J23vdZ)`a7}VYoj$h^mZlWQ0c7M$5lBgv#*Bhen^(
z0&IkKmK(YzU0o2(Vi5D~WBsOX0ILi5A}t$_iH_#2rfLX$D~AL2tX{Y8AL_uO>0huV
zZIi6_9Kb5rsuL&%lKlJA$z-<;cRKjiDQqI>mggIA4%&`({w#kLg`aBBDPYf)#(cO5
zl(wj_cZcRS^@5L<)MEW9twF%F$COWkn(CN4jG|_{#AFhy?X(*&W)KG{70NUjr?A1|
z0F91(ehZ469c(XVbfF#csu0Wba0MGp*a*2Y-kPIz-%&`b*W3W9)N)A1vZ2taML}+R
zeh+f^ZDPSOr>*RZptN2uXq}N3e5!YoUdCv_yC}sAon9%_!cdI~$y6wpgrWn)SrgW1
zRhLvsT&=Q@gavI8eJ@VY(XKRML%HhUf+lA$dydxM*9SP{AVf0{gA&G5=t{W^X_M%{
z_WyRPHc|`>8M)TX=daDY4lTqZFbTvqa!uv;%ct%rrS8<5#8RG-aA*}RbsAHoI`FK_
zT(10-b|><GO!gT8!Yd*r)5z=5#%2#Bp{G<7oH%p(L_|L6x=dWqkcN`5+lq$&jRS^n
zc3K$qnwNL8VNr#(#7~z@@2|7yI3EC(4q&D#R9tdLJLm8SUj(|{<ia-6jVQ~eIM&B)
z=&Xqv?CNgADb*RRnNL5%Zf)-_J2}F9dIMHL`y=#J$0O(R$J3_uMxR?`Tvh;lN!rrU
zDpK@9p$P}97#&jgt3nvqNH#HT^!|~J%$SoIe}?MH0>~yd`Qf(1ch0SVu#O4v@)=Hb
zSkC9|%n*0DD#RcxIKO;;7Gyb2c;@FbPZa^CM!&cE?|pNzWP){=m+mOL;v=`<a3;8G
zbobfi!S(yxki%qP&H7N-WjtzF9C_R+H+E)oU`(XrPr|e}3z6q2n2bwCiuSE&?L@*1
z`@8QiJbxez4!3OxLiEW{!RTR5*Sx1^vxVLU3Gq)#vpka`Dk<5Unn3z)7BlO-aCrWj
z)H>37Z|Q{=Any$paWmiPBSjp5>z!`>T)rpDHh8LoMQ}n9&8s0zp;gBgib)43yW>^g
zG-cH$;96aJz;{KSJp&EwF5EN@V=hACMA8v0IcvrQI&McqU^$IFE@hjDX-^wJY2%fh
z!}AFnh$fF%TNly1njMqy@vCgv$dOvSaJntZh#z*!m8~>lHFQyW1|^*qF76itF39{e
zR8e{|eWAC`m6R?-xa;YG@OI?ACK(9Jz%<)>33g_UWKp#I7bTjUmE4!h6mY(=TBCe?
zDq3DXQG{R_a9h{F$_Xghak5{94>L*vU)NC0n1@Y{bMp1mGON5zFgaMxL{>)n@5V5|
zWiy;aDM87kT=epFQTwpoDHHL)I<72i(P4%(V)m^mnj7L@je4noGn#7(pVi#mwd`<d
zcd*4)6Akx4>Yz55|JhGkQ%@I_YA%<_BD%)drh*+F7nvQhxupi8J-ZHv>asZGqQ!%>
zqqfIWv3~nL*ZjM|D1|{1+Vm-fi4##-VIxBRaR@4?D=2(YNJ%z%7Pk{lW#Y(@KH^HC
z^oH0Q+4}Jwp;p^>XDEIHW~I}vanUl}tj5C$q{Y`&kwqZ7Awg?|;scB0d9TP1e;@&j
zh&3=@7|&^*#&4Dpg$#40kFbDnqkdl?nLGiefcYP@G_Zu16If=GM3N9bYH!oPn0_EO
zg9Bo-m3@K4_p9ni3hlQML4h}L)>;L`(2mTU0+OG+MW4zc2~UMn<8Xj4bRPF3dq32u
z0S;VogYFE0H_-3bDthtNQDP^5s*mKu{_h9g!EJ#gLw+Rxd_cmoIXQlk9*wZ$<0_g2
zT4v`c`&<o&T^dJ2a?GS~>MRz}kk&!@r1yrj0Sy_Eyd_Kq6BhD7u~AxSgp@#A&ym@z
zEEyS*X3zWqb|e$NQMOUH(RPi~Y=KLt^L~^Iiper88Ga8k=N^avE7zDo{m-|wh@X1}
zu1X;Z;hx&^$9_7SN~tB%u6|cD0HW~KMR)LC_Zz_P84T#xg5n(DV0=RYCRpSw33$sL
z`Mw{KVM%~dP00IY4~npW99T7jv|RtO4*5r9|6O1I|Elf(|L2wWFMB8vBK52JO@|3N
z-_SDOD;S=;{y9L%=T7Bcwf}bmlw84VK>q1(U-so%S8~3iFY29|3P_K>J>swD1O5NG
z(2t&I=}fn<-WtMI+nF5D9dI~>|C<f<ykK`GEG!IW`!Iu=BF{4!h$ysT_J7zKjp6_E
zP=e{+mF{(3g|jKOld7~M`QP>&yiCtRAD$ld*bIC%uSj$?FR2t2UjQlW5X>R`0C&A7
zq8GmG7Flo%>htc>a8-j||JBQB|4UbbBP$P~?b%KL5CkUY9BH82P!h<2Bp{HkNZ`{_
zM3Jsm1M>A1HGSJL8m0wfk<QBs-vNaQstk|cY8M(+k8eoU4OQ{|);eCKd~N25r&0n(
zNZMXwuG(%>M#_!<?L^#ZGw5U>Glltl+hAwpxh!kFb_2EHb_}3e4$WYy05>qJ4KMW7
z#&ZS-?jfo*w>vfa%TbNyzeim=17>;q!BA56pq*1!o>|g=R9oLz>C%Rm#r`!lKoAla
zyBUeg<4sI-yE;0k_BdU26;Jpk714RwaBV-Dp+QEYp-S^aWlNJ84ROYa58;x7JiUyA
zPES|o-3<t=Zufja)+b$!3ZZYo8k5V2mIzPQ4}zNGXaeOzN%7VRn1Y^)tGX%46u!@{
z{h?f~)H-@}bJ(^9>D3%kHzTTTd93-RtELg;zg%n-hk~@3#|OVoY5TPduB&pYNpN1v
za9&RJF#uY+1dA-4?v2!$RT5BiPwQ0<GoM$bo^alc3;)m5;3P;wDXra0?s}3DGLh0E
z(e#<;E31B4fFzqt4V8!z&HYNV*Xy>nHTk3EQ#@XWX0PP-0*{TBcCb<g2aH+xUn(zG
z2PnMyKHHQ!EcW%<U-1^I4U+LFK);6}<JVnz@4IU6YK5ia-TqcfByer<@b0BrTM9K%
zewTQKr=wt$M5Bgh)HQ*j8-lTYaN~LLE{#r1_-{u-9l8XK)dH?{0MI9j>xE(MEj)Y6
zug#8izj*OwTKjtvMyWy*(_>CRL?%n2$r9P`f=kdkCQhhEPzZXm!I_ZRT?i94yEZ#^
zVL1K}bTpYUpsF;(fh@_Okcb5{71F>USt*qwH@c1$zuzufED^@3w)GUB!Hpf=LY|c4
zymxHN=Y;NImJu-|0%O`XRiFh(Soc+-f%0HXMY4}G9z}EOcuYmV{x?<De$(1(@;WFp
z*m>yh4k)}AUAMoULAX88M`JhP!MxUqbg_x9k7na(g?-<6?r!!(QE|=r9KVy?SK`>;
zgu5!qT?U0oVLjBhd2fxhwz1!oDVWF>%f#a~qQ;w!pcfP(b$a}tK?o@!UPY~Kc}znZ
zrnc;O|M&G{;i+{*8ITIPyZ05>Ju)<n|De@mcmCp-DL6&7Rw5Y#RWs)20k{5raB|Ve
zHpNJf>_1;6PW^O}Koru&dv9knM9=6L0Z4J|9r<?ZpG2ibDgh)*t+m=5iq-`4HidC%
zA<V|Xsc8mg&OxJ{KsdG^m_GsPENUywFR?@#Hq-qns&aew|Mf=|XL^4k-*Q>&{_%+G
z^gd!e8&9&M1AM@4cSQPb(xxC1PM1QB;T6)_E*#(4xH4v&etR1v!1ytniemt!Muwv$
z=noK`7gd$ngJ{bb1n>2Zl)R;mJJjndD`a8*Kr*+PwTXq2+#}Z&P&jaIMsbsQ&IVpK
zUJdpIUOUW$@|8F5O{SRr!iFEp3Iq1!|G8=Uj!OH-C$*`*pS{1umdF$vIn)=uAi)Dv
z1r&h^CAV4(k%<fFWUmGJ4hX{xrmO!B<ym#eZzCVUUGng|S3m4Dn)M%Z$hD*FJe~i(
zM{``CGs&>+wO0Khi&t9}l+e6P7dqO)-<iRwmZFrfc0e>G<3i(v&PV1#)i=dEr7Y*p
z6(j}375}y-hV4=$E>mb$SljcJzNV^n^sXVA%F?#wa>%q1hOpo8pJjPLGc=V3Y@5de
zNUQq&-?ZwJ7ksjv7wu(4vKye2SXleNHYx#;eA(|?B3=gYA5$F2M+$jBk0J|+%Q*_X
z(?|X@(J=q~uPdv!GzX6C3LqXq{@+bfJdOi8#;s6XOH@wxHZ3VBiA_dHDc%Zj!UELc
zb?4fFWF-vXA}~w<5?Jda^+y=}v(cNBrdHi_M6AqaC*-n)%o6eo0d}!B`;&3O9?`1a
zPXh}GLVj;(QDYoGC{8B^y8AhC!C#rkz-GRk1p{mddGvb{o}(}wNpW#IgAyo<*h#|`
zjr+NS;Zq09qL<IF)43_g`+?N5T;$TA(pu5i$%cn^D8d@pKt5<dlogf<4kbv6VK(CS
zIlIr(6Acu<;+sP#A0BgK&`VS^??#$@CsIEZyPrHMMHNHW*vj0W84tKPV4CS`ZhVra
ze)#m#>CBA^1P+H*sYqxatGAK$U%~NRRX*g#P?_X2^*EGO^x=u=mQ-MH?gXwjMn&WJ
z<{kgBzml(#do$;0=(~FmfAwJG{hHz-4@r)L-NQKdA}$pQmjlFOb81)psU~@nh*h=U
z91;jFq2a{{cUU*vLQzO$aR#8^SA9r{ga#zh5iyZmK^QDqPb!l?7wz<BG3iT7O9#z0
zi?xNst=<D1=d|2P`%?I`KC8WZ{oBgTydrmc|JgCf(I1k}!co<VrG>VvMSlr>=acx5
z6c-9sY>xs8Lb;W|1yXmWWN<@;9esX)!srBD|3Jz}Kpv5KQ!3r51YPdN^UW`Wm7Bwc
zdqHBm=cK`_1ee$fqcTy!6a7gF_t3F16ED0ZNi?x)URptgUTy@jACYFk{hZG~8VLD0
zOe}TrQ?GJFg}QUEny%28h?w}xV+&>TK6fbv9^ogTa7*Y-D5u<$7xq;Qb7u)IYPPSX
z$gwxlNUTn?Gic$4*fbj)*;34@PlYhg0yL_inRvS7+5$(pqxM3y%lC9hjDm(n#LkYM
znwqNIiZJ_+<q6k>yh`)uJ{k2+kZZg09lyD`g#dwh2cv4f(CAqiMg;Ak8^}8QhO>S%
z7aAy|eayGbJk4X)tDRN8j0@;<LO0wmDT_&pD=dW~)G4Sk9_@TJczK-SV`2F=jRcEr
z@)HrxG{b;eLpoaYO+4j~1dD);SdSqJ30DlG4<ph5)OQrRwAjL*HM8cfT+OpmmJvc?
zSJMo{*(3}D$V1Kjh_P00^E8+UkM<zcR0>RqLKs5a8MUi|(o)RlGD`$V2{Yl93cvtJ
zL4>&Q^_fP)P^509squRaD3O@X6>Fg0yC!lId9&qgcYDww#=b>AW5Y^STzNZ=>h|UA
z&jJMoI~=lDMEB8bPpa{hvqFg*AxV-S!<j)DN#G4PcA0K>)dtrmIo~T}<=?D1jUUae
z!PCI*ZhUZ2p=9}omJE@WxrS#*!B;{QwNTkDu{3{ZGCrsO;FY;m*Lqc=+3?_CQ~9e^
z2RPH{E05GTr`CgtAk&;z(sRHNaQzR<(Qx}ydLlKEavJaKiJ}m@YF?8n!V;=6yT$Q#
zLIR)r3kocoq1YZZ1~0XA$)&I5XN+{JuYP+)XhkI9L$l_!a7JkPZU&+)90Jf}z=S|~
z@pn2Y&&p2~Q#VFQq`4Y~iDe4Cg##TAW8)}&!y^~&&f7)NUY4v-%0}HeH`|oR_z<Y3
zYnQb@N*cv347aGd9{HHQo*f_M5+E*rK;r2b&i}qD0rQ_FZGJeZ+Nv|t2@Po)@cI-0
z-;!*XX|gF*iYp4vyD~ulNMI4-KyBHjSM{84aDFX(X3y_LG`FltMi{Xxy3>neic<py
z5rxi9#QrMI=RbuJe@t`QEvVmWo}Js}eIgUc{Q_e?jug=%vit_4l`$v-<>e#TTo|Ui
zo(CRv_cvDvh8I4{d&S8@(5rr$=+j30&QWfcQDJ3ZBvrj)Nb?#RJgk?UC>(~Fp)m&G
z+-G|&q|rx$zdko0nQP0a7%g9d$-02p{-_{8k0b>Cf$$VXU1oLMo;eJTF>2>qjpqL&
z>MXe0>bhuML5dV8?i6=-r%>FAy9IZ5EAH;@P~6=uxI4k!-63%Ee)o=Xe?XEk_Q~F7
z?X~87W?NJ+$YD?+{D{5a$@vX+NFkmJyE$Rf#dGXWcd%t>aCxOWmwktgX|i++aipCN
zim{dm6`HHLIkkm_#mgId0Y-!}Gm2?fH<T7%v+GtZJSR{P%`o^cOQ;jhoGs*@(N#>W
z9=6%_s`2JHW-SJZC$^gSZT|u<=SxPd6?qL@F^H)f#GcTzQt4nDSsqg8=+N@SOHRxV
zf7v3Gg<u`@D?Aw^dE(H-YKhI-muf@0(o_e775tBS1{s$I2o{MWHMFRj1fjdw8p*R;
zlm;G3t#@9>#XuI)940(n%%$;SyQT4i*xj|HCyOlL9jpR-Fsj;^yz{ISzTuf&rRJZL
z*U?iFw{OJY@PgPY8Wv@3b?>myBJ}HAA46r`R1^ft%A|3{#8i|Ck)VVqh$63dVl3Kl
z)&kdA>$8n^2_hsqm?}!vfSH($<2OoZq5e#S^V2>;REw=Ol-9#zP~V^;&033Mrejr4
z#MIlu{|~0XseJSsht%?*sRIZ?Bx!qFx+~n4o}p3Tuqo9}fRM%9Cn|zs*}!P}zf|bL
zsZxs-Ki*BAA4KPxVPZJH8<(X+GP^`mteC^BbO7jxKx*B22{)lL80z+794c$|u%aT$
zg0eJ6E;t;svkHk{RR6xB5!4*%i>@|dv%*|QRCcDZ*%!aW#>aipYg;x)W#osZ-gzjJ
zOufjbUs_P@2Ht|UeZo@GFF3=~l%1v3%YZ)$?B^@PF}eq?OUm*G>!RZN?v>Ge)6<m;
zO+qEH3N9Mh>`VG{P<s!~o2*D6L0-}EA`0#ROCGwh0K6fE=+theF;DdGoc06JF>{zE
z?(w)F+t>!&DsHZAIUgiBop~EoW9fQi*@<7Qv`_cOTG!Pj&D%+w{!gcP@oKhH4%GDh
zs=HLZkQy2<g~h!09HRMtQfa*cS8KBJLP&3|YObn~JQWGTnU$ZMU8uaQdqB00(k5x2
z8B3rOR|17SZuth1VzEXzx-A5)W9!ih%Sem4@|b*QmA%rk-L`UYyWaF<Uop+LVf?3h
zc`UTS$6h)dHHF-{o$SSnpoyVt7T$4!Ks{R-3~AT=&)igsa5l(qn-g7`bUGnGPtSAu
z+XqEPudj9?tw(N^>ze;KlV3;MaLPr&HK7GE;R`RmcPl%)RTQ6eA~yOtGYdc#7+?v<
z%reeb5_f`;Y+GKTmLN)o_cfrIMR*%V=XG|YnI)s67o1>$1_T$8HvZIE100(6FjBBH
zqLpd@>R98lv!H!VFlPtkCPtH)m^Dr?6B2^%#$^geoTE}03{Do^%ug1%a4aggEXuD-
zOr;1|YpMkZRxCGqDx!$C{k+?MMB)TPj!pOis#=hqa-0EO`DQK>8YKj$NGOv^c7qGM
zD;2vD==rBxt#(H@g=xK76g>IP9Ia3xAhW#uIcr-@<vS$jrm1Q((3*E$`{k2L#Q^o!
z18qONga2K1aG<}cRyCm`2CJx7)dK=s5hjPo#?002$1KLZSF_0r-o;Z^-OF}%X$rjT
zOd|POatEmBy1XT|;E`1%w6mBd25od8B)E`L(0}(`=q#1GX~l5$BmU)4vQF4B@?riC
z3k;q||7R|$^jz<Q@xBp?3z~}1w9jNySIOkdCa*hb?fL=~=4}vwQtP~&8qGbkjrg`P
zbqIs5HfENJ;e|1VO}u9z1myF-cnDLrkdy0nSAm$yBqChn2!?Y789~v=XW2iXcl$pe
z%Wy~JA<mdKqKE^Z$jvO>kk@XMKCtQU$Y=1ONXu&jB;<5*sO9SFm6_quOw#DRy-7nZ
zQNJl7xO_)EiGep`X*cY=B%=*-_`=Z8YPaV4-a%J62`kMG7#07dhZtfI;m~#yYHB+D
zD&<oU(#S=cu3MtI#5{hrAx99BU$Rp>=%nD{__iUJ^4yB<o*?2fms(ij>%@}*=?G8@
zwtYO);&8L*6N<%5$0Xh;N}o=*J>FU@c)RKhzq*99R6~-<{3flKKML2&W**9SHHQYM
z{tTS!-b!jSN9%#wS8)#l%WGJga<2(?iyf_^a`!{S<SlQKm>8?%``NPqE}vq4qQdtr
zp$h$ZQSFRo@SI7bLn?c-GYRK{kK(?y-~L^BO~d#0kKb`wL0jS_;vf|zrFBUsT8ZqX
z5RP0`$ULnmP`!12gRcpyWE`g&Nk-F7;Gj%oRJO%Sa+VM9AZ<?hKg7NAPNo^PyC(6Y
zKK-dikRaWL4fuiUc#n`FGl5AZ#A@B<&=|7)ANfqEC4I2U16gEJgIduVGFj++7o?h1
zPV{YTqxr-u^^Ps*Vm!sHY274z|7UTTa&rQ^))-uBnZ+ad(Qu>BnW7l_AX$Mfd|SX_
zN|d_(n_g94x>H|2%MpH9M~<fXBl<?a35kiOwy|3&KcJ6OzjN56f*EYGwEU(LwNW#g
z5$820TxOU&!{RPZ>k5tu_|zVBWJSN>P)Qsr3}J>V{FAtiIhxJGZ;hq+Pg1?3vL8Gd
zs8Db`-ZIF+QpEzP0+ho@fR?8>WQ|c;JJ{U=YS58{%+=x(c-@s&wTWzHW^rwy%-f2&
z7sr6}50bCcylZ12^xs<wchI2d;6%S2la5ECx3A+g)2nADA5r~=7*7bCfMFVnWcD(e
z2`PcRV{VZ(wKpm$t2aYYmQ`W)CRM3*Y>bYgHMa|Is0+QL{e_8qd}?gk?-_0P(Ak|@
zk@-EPQpc!kcmFPwSO~Fn^d}rvnr@uy6HN!DET6{)xa&1(F<131&C||tV<h1o*uqqF
z)yWb}ERS74oP=mm!lXZDG#EgtRX|m0v!G?ojR9`fg2y#UiYQx=-h|keL+q7kjOyex
z9tcl2Ic%GzBojyc!6E->oMd)Wg3}*zo6Jet?;a`#VHFguC_1EWeg=~Q?eVIw)gKH<
z4|bYM)VA=%*P}WjA*`lCS=|>iuk-14d(cQbQ=@(r9Gf>PvnH%-Q^a!FCkK<Zf3wCS
z{W-NRkC)^SFQRXOA@*U*K@E-YK&g+fNw`9|+23I5=t_9BxiN);CF=s4dOFES?-A@I
zoba#`<4}dc@LkuLP`MWDdv&R#<tK~sP4`=C@n{1P>95K2c5tK+%vjN%T2MiQsY>X{
z%q?#I1V|ycg#h)}0yWSQPg=4-3K_(B5$ndL-H&frwbJy$uYudDkIvkrHRgPhdn0UJ
zJ<sHmM5+qa{;8K*==O%jz#}5bRUPkuM}~_CS-_i@frVA`uXPb`<oRUXe}OQ7iv8d9
z*AvhWbdh9srX4~_WKDA-B>SQ)<`l9Lbx01#i{scjv%7SZ=}{33snca^F7~GL<G{7a
z$;fNIp%n6*eV)!i-hQzQ*L?fLt^CauDW;g#?LxU^aSwc3tp652sO-Rjuj`%15j9S2
z1z<Jk!b|X@k&*9&Q{8Pxx+=e@+-!C2PNC)GDdnnB<iZ8AZt%&f^*RGb=8|Pj8jT;C
z%F^p_#NY^!4LxIFnkIaz6C4^yyZJQ{NMAt8&LhQQ<47JZ#y-=CWrU|z3OL-|g5q`P
zzxfTeNllm@;bX|*svZ+Op|QpyE@XsQtYQcjsjI@#7=U!wKhS;@ctq(_0UkWdkwfWc
zGWda~u50wsKYI59p$97|lcC8NpKa0UkWN@2z!RmA(8=`Lemaae6~WiCeJ9j^=Pj?F
z>YpoJSv6esepns^sVJ$){1g6ds(U2X(55%)CG8hScTtzkLZ@dwA+^%x7S_&2y<JD>
z%B{p}9<S>_`k4FLeZ;T5bN1{&ctAnbWUaal)T)>W$SP9G>c7Q52kQb%mLbQG(wXVq
z72p!4yDjB=Oab9HF7P)<yM#U2s^v@4y~;PJLcv@Iy~rOQ7M^QB)K_uJuD?^V?|x4_
z;PQEjmyM&u>y)igL%qmk`s4>w<&m9rkZ20#aqY}&M)|eZGX`!33S^&Xv0E?Nv>yzc
ziqcKB3~sqCBwtGjOQNO>41eJqcbwt6k0Cf{-2-$ML`TF@0lqB4rd$1QLB|}FZI+{y
zV;t3XQr<!(gqYC9{@_P|sh@V*t9Np-Qnt5LK6(-#Qw&dvRk#Z8=<(}r`SIHhMev(^
zzamvXLy5Cl^~cd0bMa^!jF;5n4HcgamJDY4NzvK-OMLT=@5V)-*TP_kMjf92y(Wf3
zM%Z~lW2UU07U<DimroJbaB46PYynhv^y_v3&e!YMS@4zw33v+tv;NOb0Fmo6=6JSU
z`<Y7{PN@{@h-wz&<Aa(qF88hMThMZY>g<}MRv#Pk`=lf*9;bwdie^O%`E{5S(*J{s
zhxJo~G&km6R-A$*9Zh<(g~$e`YGzE0Y!T1EGLvoa$jyy-jK@k|vwzXNn;|pM#PjxY
zCLd+L^HV<0M>WH}D}$!$#}(~H+-|pXC^q(!bR*tBKIG%bL58$VudCcs+eZo|ly5Vq
za1D|7NsL>QoboAMkt*TGo1x5}TwJd_p;_7Rd&Zv-D7u0rpR>R3Ah9`_en>a47G<=H
zmV8IHx(k&&japp`njHxP<;L9MdlM^Rf_ePgJbwI~Ww`gQW>o14Fc&h3+q4Qi9YwJJ
zr{&2(A!7}4Tc51J8nOm5?kw6iwH^#86&Mg(emV$D>ljdsxy}gOxZ-O5v#`})VA}N=
zy-?pNU7jvSZrYE5*W)l(UMmg>{dcjKG>jQ&9Q{cTWLpDw?ClPC5Q`%Mhp)e)zy}rT
zNC#jk?u&Q-Gb^;u$cv-l{Y@1}B2Zxox6=Wk;8$x!+}oPrO$ISCA`Hi3X43deaJt0b
z39#=xJSz<ziLJD4%qSk2rCH#SUI^|d>f4wQ&K7p(d81$uhto6A$*@<@YEpJ4#~ln^
zoxa2AZJRv-qk1b6#PsJh9!VSjeZ$!ex1T@Ty_$Yh(jiy;FwDU&tfzC@#JV(T{~B2t
zQQg-(anMq4-_NS%mPj{~5PwH_cVu~ZOY$|Ri|~;QklP?8JdCnWq=iX54WQN<@A>@$
z#I^9y!uU3C>!GreZ?+MFnH^qD_<~0bN-wiK`3X$h-oaj<DpE+nJa1bmJhvQA)OnN*
zvhEmSB-|qN60q*bJ3+GHmfTxkG%d!1iLcrnx0nI{h_rs2-H&<|nlIl?P-S#y@3PKh
zE3;+iQHztsU0?SdWOl*tv>}+r4KadH5*f?2Wc<<nN7((2@l@&RHur8`(_#ashT5(2
zL+r+mP2HV;qTP0BfXY3ri4Ceoe9xQNVEbE`=a7$)^v4S0sOYe%Wfx;Y1-~!Ktu_G%
ztd_}am?51a^?cV=+~S)vN_O5qSnv^AyOJ%y=3VR%Y?UT#(TJ=V6U#Ld{-UTbTHkSB
z3{?OO>PC^6Bg{=i`H@M(MHfBN1+~z|zG5I5^8XU14CTR?9UAX4PSkN*%c_SxV)!AE
zd^kD0PpGWYs{NjGW;ksfW)8h@6hi&@ptDl|o{q^pmGh?h2jT;p)uOt0;N;{}cq4UI
zmuxL3#F*9V_O!|ab1fvi84a2;-SGzja;8Rk?dE8~*Is+9yu2@I+!+gL)Ln|3A)R=L
z@p5QLBf0(AaV9{#<S|^+Wuj&z0Gqb;Txur}cuaNrB*C9vG-)xH5Ij4eT43YNT)Azc
zhsB#snZa=ltc?gwF7<WFEff<s(w#fy+LSLP?#`)<GqtM)dnp$W@Z~&x7aoZf;heZ{
z(p{$&<?Q($D&)?A4}2~4VatQ3?qV~-=NSyQpw)mx%Pv-6vhpuJl*gSW*9L}W7ak=v
zW#>2TwX0Nti}FzENkC5KaVvppw^6DhMj89|{_D~<+DSwfT0UC8k$yJqZfhl{&v`p>
z%fBg1gJmoHRZ=#W&jn2|qu2ULEH@K59wUhhzqS;HLhKj%nu>RO!8r!U;+!PYfP2{S
zpF;tsSg#xPt|Wqn4FuCzzyGYXU<mpchtKz;2FQ6w(u=|B@F;Q75^x#c-9Nnz;8lL>
zjG{qbO}DAe@*N*498}vi@U}$f6jj@_N$>U3*wpqH?=rH!;dpGL{i{_$&LMTif;Z))
z0ekskMiAMcsW|@&Hvs9T;>K|1xb3#KF^alv6^`X=zv?qJfy_Dkl=xDLX9_w*iYDcB
z8K1(sz#V+#1bB4!kW^;8WR-eKgIpDZjv9<%r|yg|O&K4Xw0S)gHy$bJdN0?e7N~h2
zG`KbcAUn2UvAq3g^_sRK>V?dAqJZ)kA<bc~y6>Ouw~XD~3G_E*=3@b)sOe9%(YJh2
zmA(V1_Mz69OoMUa)F(@C0}cXmohIm20Oil+o;*SR4|M#mZAm#rSJ(OFXfgu0LxJCL
z<tt8t(dpj%c!m6s3yLn7rNb$Rtn(jm;XpM}v`X>j5Sdwnth5{GTuO4fiLCP?M?X5?
z-e+q4VfGiUNQ2H${^s@bvWxjn5rS?jc1F$)b+b-de)fQKWYdVt9wZk!4UD&Tcsw|7
ziK#j;rW{ZLUTsJw_MZpCNa%nP)x!4dzql_<-3`W*=-AXdF6o*d&X9}xz&S#ej#KE-
zdSw%}&t1bO@kQy6R=dco7z#X;!p*j-71I2t*0d|r&`<FVi|KpH&zC9l$#sKtr*Vf_
z@gxQ(k432tiRd{*?(v&~!9;;O^U8%K7PuH#CKuWBv?TWV^}3lcg7oarL24feUHLOt
zQ3RIs)I7HWh0(Y{kvpjP?5FB{PUdYY9K?bD&45Hw^qE2%+uy_W*Um79D!DEo6^1~t
zabz8zw?F$Qn(_3&-65}qvXo#CYi1AsxNP-#y2mSpsI>?=_hTi<YpZ&Ifpk{xKJ&W8
z%#Xj)dEa7ctDoCNf#(qcfboUaMkA_K9#k(h-@U9MhC<LFuWi>3R$WS$ytT&3ZQTdP
zQbpYt^QBX)wz`_;xxomTBs4=e>0S2H4?(`;V%z_@R_gm8Z=<W+T8{+t)Q}74e=&hv
z&dS|u?JDBy>X*!q)=iF=#TO4O5vjilk$`O3?Z>(#`8jFrGX0eaNQ+(J5yrV}y|*%6
z*}pW=M~2+XDezr;pBIDO56q-q4O*v!VPp?9P7VRqNdIyoI6pG>>eVj<c6&pR!tRQy
z-r+*6b+5`QrD9_jY}OeAJXTr!#pY_`Xl&pS_I9~(pGHmnF1>JC&S-l$rxFjnshCUx
z*+HU7RXi>;y?^pKhjFXiPuWZ0F-c4te171t;TZZyDu~8}*=BT!bgA7CSb@Q3UY=I%
zI-*Iaav;ugsU(372SbTWvHd@6vJF{W4nr?Kyu<w3)3w@>Dox+u<khZG=6ukWnByv}
z?!5?gEOy3qo>KQrQ+DF06V9R-4fhqo=EYa5DScHSe8w;dP0lKMEy!OHw9mbIqmCgs
z!-6ypc2q9S3&)&8n?5W{#=b2Lg|z1QC69iXe|Y{@XInTAs)pp1AAczfRI06Zqw^{Q
zf7fDFSI&#iAH~e-MEy~~P#fi^?YIu%GgOJap-zRsNZx|l_|0m^9HWa>A$N`@ai)x?
z@EN-R9a}WX8y1sXdP<T&?EhuC!Y4(66q<ZH*?-Qy|1H@?xy*KblCPj{Jh@aUP;#X&
zAgGFUYLUxuOKWMY2MmTa-+y<N{<N&pO_(HGsmuR>gf=-OqPrjHax~Rc(mA@-@6@qw
zh^)4aJp0VS6@Vy7B<Q@v9d0)ZRel>Y%VNpY?NAC9WB2g*>sj_UF~jazv5)P6;av{5
zbZm^m9P*-RAL6g->yJs+oLZNpe4JKNa=n+WU$mZudUb+2+_3JL3wQo$7#cB0{1W`q
zwmfwPFfFTN)pvq*$u`~LPM^g=*F4HF_54%#wK&Y<tU!z|;d9NsiDx+<t<n(pjr*zN
z9hLr_W7t$TxPTFsBiVnjtXr;g35N>zph4+Yd>v?L0E^RMleL}0U|5tO_+9%BTK{1C
zW<cyScUm%_h>7Uw?7F9U@(TkO!SG~c3y3Y1FW*;toYW;ixocQ2iB^}5i4JF^XRMK6
z4z#=}-z*l^m6K%^W8Fj>ha8iN^K<61brfA(fK0n<UJO?pDUB`KtG;^^?zm9<44q(}
zSy$DC%yqS|9XXLkUbae3(;HLlGsVrezXmQKZxrj&R*Wxwqbi%m2bH!HiEf+@9gKc|
ztJJ;x5*q2C_I{+86Y_OpSxYM{eO={Wd6|faF@HME>7RA%zNdMEo_8K7OI(zHmcMgV
zWxPo>Ely_Wiffw)?-!iS%&lsZ=%^)XljxH{ihX=5vysSJ=_u%aCVRn&L`jCKdV}L0
z%;A{rb>VT8*-&yM{{epSU$)e;Q5=5WY<C?_oS~E;=aM;K9TG)%jL)oA9_{-YXwBqj
z%$I@`J0r(<VW4q#D_%nFtt&IFPq*Y^!ZunyHgQ)u-8OYkK=LIy<OCNP<NCuM8Rb?9
zpMzX-)hZe|Tr;Tx&QxvfLHd@Z{8Vvo6y$Dmt<Iin4bH@AY#Ur?QTacA%ru{XRJ&{z
z-K%3gXKo<!6r9dOT@lmm-;a$<wgDi#2B+U^rW`X!i&JM}-lXS99%mXbCVwyl2fOL>
zZ7(ZLjjgXrTJV0fedX~?mMys<T0R>2$MekrqlJ3b!})JM)<QLK0NtwFkT)F1+ojD*
z9GOeec&wyE6jsAJ?b`6KhPV{ugAu$NaS<NtZq9)wh9^I&&939kK9V1H9?2$MJEAU2
z<_H@(*3DzI_C3wwTF%9dMG}o>oyc72I?fAE9hiR*jIbqnu8WvnElcO%YoM|Qh}#)U
zcsj6ut|F0&odT&eHKuF0Zf%XDU(@KIld_Tt#ROz$r$pGl)5#FBW5QxZ^%p7(rZP1_
z4GyCH;NFpV^XUtFdQ8<&*I_}hj4;(dU*4@X8LtIa5P;1)1WuIPTCbSa61m~c#YP|%
zccun|*zt~Zf3*e8gb(wtBqGHoDGnvU_UP~;r&=qu12?0XRygTTD?Y-*LVo|@pkfLv
z3!9ZI8)1IicY}4i+om!-T92n630IwGJS3<AcR3iCnAJ2oe+$AV>j0}5%uN{Ujn0B0
zbuZ21o%cL#rhgylYr3+0c-k)enq~=rF0QkT|7(ljpw?f@*3(gNuQgXse~vo8V>0jH
zSLzdCG0(T>>2XA6JmpVqZmu_;W`pG21;g>o^*fvhNf{2Ie4MR{z!)vkWkOQ=ULU$?
z$)3guJ;Vf9+p9oMLfm-+nwW*QCA-NirD1yT3-G2*;R3X!uMPz6?whNY@4)ReNRrA&
zq0PEMcmBB=24!2Ev4oYgWxKK=I!$<k!fjAZR9JzWd}_Ks-_}t;C9^7v$*3FA+m78^
zdXzn{dl`9?7IH0tDWaGYSL;BAE=Ag9$qqQ0e2x%pYce10xn@G+{eU>mN`gYx)Ckgb
zmK+g{qjt339}HKchgL#-sJ|WU40J|sU7|0P)f$aiY00A>tfmz~UCOft4h?7itGFJA
z;^~1%u-_a7oDRcq_r;{(yR?Y{1v9_s34IBeRa^+=CI9Cz9Mf(5x`pr@8y6pJfODKY
z(qPRTq>(l(FWpaF+WMrqG5oJi6oV1CsKMaVLF)ciUb{i1Elhl#vFse0fDEa?lsBl0
zXDR%y+c<xH!(sYQ_i=0w!Ozf~aEkeU?DBj%aqUCGagIMGx{Fq53}04EWzQLWH#KSf
z-H(LJA-$u1T4We0iP!kZR(V<Ptv%l0aA{u%_lOhg7rR0vWXi_niMOoum@ud#_J`st
zTKR6L^Y!dQ$~~D({XkZe?JQRS;qi2Hcj90hY);y}!2~e1Ws7fI_D@9+B0lD-?V<5c
zr)z-caRAA?(tX--ND?9(4C4&vdDh`RRF1~D59>vb+{L}ZWslsWZYxW#N!s;Mj~a%4
z{5z(lZ%S(OLluiu72^X<fzu`2$fkx8)3@40IukQ8iT1`6^wRe^uRuVCC9aA4_u2XN
zPf;cH%0Tq+_K8b1%iw(=uo+Vj9-v{HNpGvwlF~Rt{*~6ysW@Wk?(^j1T&4Wl<6Pe@
zfpi%^MNgLOw#GXJOVPS9zjdMgUaTbPrn7X@AY*sLP#f$VQha;_iBeUD?Zj5Cad^bj
zI>-7ig7!|RS(Q{VjFn20uY)5fShoBLJsKB<WR=6Xqr;@^=j!iAbI#*&-#=%jCL=)&
z5G7h#@QSs4u>>DK4O4DA(D$eKXR-<2%qb2&#bu=XTQR#sR2<U%Y9eXaS!oEq%gEil
zAkoO-05(0`i?S*a9mrTana+Q3m@~<}7@!(;mvdb%!`dfqWg48R<2wd<@Dl&`!7EeO
zmi&V0%ii>M_5_E&Ag~OrbY%~AG}j?Gf0TmmL9E&Xk&{`)GZjv{S_ybDceaHAO6%H-
zobV~!4-`?WVJ^i!rveB+_$x_Viv8PN!}GE_zpws=!RxNyaI)3%N}?XK8m9Uhx=0Dd
zO(s>q%GF_RvI}E>`qN~P{^2H#0|v?iIoUxh>>_5GLNWT*#Rn2gXJ2+3>BK}mb@5_k
z>L4Mo)E*#R9$hJi{9~;*jK-+}-;{`eQL_rEWk;ai`UQWDb97P5q<*G2A%!_ijzV&r
z497`RiUblQ*y+RYK#_I*Oj++f@JS3*&^68eiq9nmDhf0Q&G&|xm$+!FH2hNp!lM)<
z6NsCZAFGpV6l5H<`6R?;6sc70EbF2MrQtW67Bwy1v1DJCymp%1gB$D~$(hM!2(|Jy
zZ$aacd?nuLopFVojRM5O#P+yJA~S4?YM#`I?NecDetW&^tiaen?RkeYjX=$=1)GXD
z9rrak0#I^NSQ<p`CLOjPN3BJkgQpGMrqVT85!TtQj)STspAmRNBS!eI7G0s1Qkp=0
zz*Zn5|MdGg)7-_rylOhp;SwA1P!5t_M3H(eIzw_6u2gS-9*Tw5m#eVp5p<2XBpM3Y
zs6w@Fwnv$fb}IJoSjEP~80J@!JXzccBu(rfa_HB%Xu*ZWjQs?f0%f2%LDpRG_@mHU
z@kW`EJydS1KJUCW6ai$=*=v{whhu~oY?ya?a$+}lWB;$LT=of64TcU8^l21*3v=#P
zk>#}qjhTki`j^Z5U_z%ERw8g1vlDGiE=^*pL8)b4v4!8pu-PaTqIVcv!oR&wK+j^p
zZI_F$MIR69F{{znn&N;#*#G)`y9;$Z&bLCz2SBTb)Wf6w@&YQ+YiruHc0#%Jq-USo
z5fR%OVI>*S_^Z@m-Dfx}77-&|qK(PFrgz0st9|f=zQ8Obeqsss6BL0V0XT>i{sJ;n
ztPz9^FN;KR*nkPSCv-qH>Gq;M{!^0b@$>AT9{DhT86u3stZv5^oz3tOJRdAWfG0di
zw_h~Z7UHK0N~}JK73ypAFpU%OW4=_1l%%zM4d|UCEEpmkBFf@(+an1pVvG(_EfRgM
z;s;iSe;38T6D_z?H(T!}_fOV`k|lAl_)7f7PKx2X2HKh|n@gk2tC<>3i*4y9fZGy;
zultjj6D`C4F4O145e}T&Epq<4AvRJ?gEHWphgnfw#kp^e-))0J{(KTQW3Jdk6j5jY
z$0Xf(w81Oqp0@J7Q5W;G#<36j`_<-E6h8E3Dsw8kD-=hTBcr1DQSJ1u9i&fpJ-wes
z;Vb+tCJ4eJR%k$*TUNv(2prh{-n_wLE@bI=8eacL^PaFtt=bWTQTO&VNpGMlSW%h7
zYKWjZi=LRrP_!y7S`zB95=>)}{+Qd<iW*bZF2f`EP=SfYh|5Vz4l*+LM8iEdVu!Ju
z==@HF%7B0!YBdy|G~-PIxvCIvJ5UQlY`P1@D$<7Y7+gHVwX4NXmDSPvoVLN0zaZhb
zX87KY70L^m??&ck@m}*kzzO&!g+|=pH^_gN1=(8_#Nh}brazcj<6B#lu?%X>{36AY
z^vwk$flH*2!2Yj_P84C-ofMl?>-E$sZ^r-@MMXOgZ&sl3K@U+PSJO4DF$(z&h00nC
z$0y?`dNV84&qi4m#UAM0Mun_<vr0;_)PCGM8b6JTOA0eq=-WCZOxsg67y#m4$1SeD
ztY1jboYLyw6Gm~lOEw+nOcf$)lt3=0h*%h2;b<kuSK0se(|@xH!EyKeZwS3hR*=X9
zhGyouvR}KV7^E_!YksqKUcXDkZ+@GR^_bY8o4uaqIjWsHXwya-lNg8N1P;_k0&kI4
zSL?tM(kB})(dTY%ag8Y<a$%Q?aV4F9A6tw~SN;>340T#JUHp>&J>z*)T97+3-Pf*A
zwP16;FY1zNhz^Ev2bY;$zc{z~SZ84{;wWidrac!w|Laf4!Px4JE<YldJuQskhF`UW
zL7XMD)!@+w8J>NTPZ<@3*pnc^d_!#^el%E;AG<URP^U%mbhw35XzVyXMDR-BCl8Nd
zDhWk@RKl7h1`F7~m_}RjDxZ}(VaCU?&)fg)h!rO7ZHtt(C@GN)$9qLTmTVWUX{(Lo
zOGn6b0p>gFh@ovcp~iI?JT&7EcIFqezFQ?WqFOMRrD7L!EHF{J*v4=Dre`)O)iOUN
zorTc1wjo3f2sh6_QUQXOsnXzvTexp@kpS_%B~cU}mFGgSaa;~g&<ZdTB(Z5b&aw`V
zP9JwEJS=!eiqcN~y)(31IV-|uJySxp=!8xo#@V3rMD*2kO$&tB>Kcf)69X6)$|)*S
zUWCYfUS`ql8#@an&il@UwOt2>sOab#zQ7TClPEEOB|pj1v&_c1{PUz8{svQ;Mm;=7
zF51Q*-j~@_CadkqapIgvUq&@^+V){=uK;zJxhG<ijL}I-WBHd-H!|1B6zVgMc2FTM
zjcDdZ0w@9%lvM#pF=bd;D!1@<gG@kshSAYYKlR^zZyWf5U`xon68?Mmvz#71b=h(!
za$f8`32@vcE?8ZeZFcy(b=`~2pe7O&TSK723Tn^PmzCu|=8W|5c2NbCCFcJ6hNOh}
zr$gJKE7;i?7WA<34&$XF@s>h6r%>4I*pCIpm~VxPF$V{jtYg5$>ZXCmFcj|DrAQFv
zf$(qqx7pqqyYnS80_PFM?MG)xg&$sqK)|9Yq}Sj2NaF1FgC#ry((5<8o=#fnY%l!h
z1lMK!@OKvN+Q-^9-?sh+Y3-ZoCh29JAna5;z*b;s0_d=g=+pQ7^d3n5lttq>K(J0^
z?%8MTA9mxKg5`0W@-%i2ts;}XC-nD!EwALYhP_18i98R`LV9K-$=c1c>s7>5CHsY&
z*dZZgtZzVj@wTHH$@tU&i3Ki}avGT)zsB0?VttG#1s=odnfHANdfI;ZxulTw>bu^Y
zqR}`mQCG2EM~24;VI2zT`x5}HaO#&)c>jJgGL-xh+>uH)K)lz<^$|$U2p9W(ComPu
z>L(N)Vr>{SjC-%!rjf=XgJqg*{r$$rt;#xRj`bwYq%eCX^58Yf(q_F)1!4(SF`eXo
zR8CSW3NESY&4c!FuSk-h5wHX#VH5wBZJ88?803zBN4n)P?;#TLs>Z0OnNT}4*`>By
z7VFpNEJXM%ie1LyNL%DUXYx!rob^viI^mCESKteqO0z5IQ9(WEQ;0~B#-jjcL-Dbr
zkMzYk#rk{40&+B=$j;TIS^N<2q$HBiB+z%hVP^qG_USQh?X4yg*FES(rF|+(9E{sg
zU!~g6hs;OFlG%!N0;MCB63>p}@B4RIJB{~b|6-hTOHs5u<%dqO-i^B$aY)TuYiI9Q
z>BoP=a;wS~YhZ9_I&+GcaWptKUIHh@_}j~&iVZ!9W`xxE^kqE`yD#bPVuiSZ=0XV6
zis2Y~gHM;IuHG+^USl*qd_DFL?WSs~dtYMm{erkYA60jt<X=ovGjn$CF%=YG>I8Tm
z5tgRGKX}$?3jtAYNvjVlymAxk6GfX6n_0RlY0{ZhYm|Q%r}pOc5#Q~3GO6!rQA5@$
z`OMUIa}I-_d{)JR;E?RCI7>KmB&a_Y3BC9WENTDh(cfC5{$&+?W~Iij!QEa18I1ZX
zRbWFD8I?VRo&y33`(@}$(dEZ!;)eN-IL!M=%W>rPjN2FW`~>n*RybmcsPJ79e2+=y
z9hhp@ff_D8XC?m@BpXPOd=Jn<I{dWS?t9Ag3cxU}9fR2NCR7e}l=`6;1#7c42`g(Z
zNHpxHQ&-KD1Bp``BDZe%N<6Q_w(cmWz*nNg80|PtIh!l9FkKvRw?;+tFB&f2yHLd-
z!8vQ;k9s(A_Ys+lNsYO0a;DJ=%`SR7E}IT=X^h$d5Ef(LQV1x=5y7SId_#7_pzZ>f
zNP#uq_mN%W!zZLscA3jc6OGjVt$}i>yPR}jk2oaazlGjrsWveFM}?ne`tU(D9)&h1
zke@Sb-&c^eLhc)xNmFIjKy+#<4ck0#)HQo=Anud65;ljvO)>!Y*WgtybD1%Eg~SyB
z{uaO3=HDtKE){-FRc6>^$|(C~%}QHIq$i=tcB}%s<_W<koA&m|Y!SBnJ|C~S8pHmR
zR=yaOmbn_a<@wyVe@THT32@}F#(|CvSA2;$(KX||vR+yFaIq85*#0E3R4@{l-htAy
zH$}Z9xYG7?(hh4{M5;M6ZVJBFKW(1l?+>dlM^k2Ot$W$^&m>Hx_nfE^(XZmgPUlt?
zGBMzbySauCC<%jvfg{|!ZSVao2kxVm3BMLr>74)---rSxQv|`QNQtgzUpRRjXUK`d
z7aj3%R#<SQYqvGK^&cNRFNZh~>D%-)pgbGiDUWv%m<jLHbiXOM9wn;JyQvn|<HvpY
zTwHc+FfAHM1!=L>@BD$o>i-@SX|+w#!pE|+A3BNoN}YV`X7PdCv9a?~?Y(EJkt(2u
zghed(iKB2GPmf3Uh|4~r4xR2=khkR54kE<?w~0o`5~Qnzo!w>`sqTJt%<|x@*{k4o
zRLYXQxqUgpj;FmTBNDPbPi6Fjs6R}E^&br{h6*L|Kp|>nhA{u%fCS&&@+`){(@rKe
zs^qJBz!x0~UU;xmOW<5s_#*6*GcMKEcY5P-TPfls#7ujPdr>b}=0lWXx|aw2zkRvJ
z71n!BVfk94tt=ZXDVD7@QA;JuDG9a)EXG5gf3x%vXm3QAc%49D0jCYh;{WK{Vf5Z7
zO>255zJ6)CT(&lrerw1*IZ7%+ue@fVQD_)N5-W%N@R>l8Xid!Ghb8511PZ`v*a1a&
zo`B|?G_D@E%r<tE4!?Y>b=DA6()UM0sW1&yzD0+&#Pg#nHEODYqLRlC6#f;koI>r~
z5l0Al9o01rw{{@c=N9wd_^%A(*}>DXoxPtmaY`1%+tqa@m2-QI!hW#CSYJ1dn1vzi
z33Rlcxv=La0M}E%u}8z<<G0wT#_QfuWzwo<Hw8v8i3H^dD1e(hB%vd(YllAZSq0ba
z2m%i)?u%EtkIgi$x=t7RLjndkIdU54$rYBNvMzI7oO(P|8wD-S6P=|h&XhxHS3-~6
z=0H<N$vc<CzF|yh_jcc=NH1GLtf^>2XUFkMJTxwX(Y*{XR|!J9({He*gYfhfQO~9s
zsvU3e`oPgvY#eBWvHcrX$eh2;`>J=<TK}MJ^<%^)VO-;~9eoM>_sZ@%uXR!NZN@L8
zFGMfP+MvOg$8APo8My!ZcSH??!ep!X<vEvMvp4K@IFgaMvwN4JIdXE<=2*)$1W&5o
zN0n?aiJ5cOT#Z*u3VxeH(6i&*=6|AXE8(r=Y2vKv>nO&!sD~VHSkb?Dq%waPeO)+5
z?E5j!2}~|h7?37SfcrF7lZC_Ul&ZeNY<momhu|MIo#vghuvmL^M0WX<Yu%me_!6sV
zum<);Vz7)^$|zhjVNdKV>S4!0wm4E2_QfE|$1YQ3Chh~Rji6Kap4HVRdu)$BA@&(F
z7-%Fuiy9MY^Q$=U{#Kf+kv!-i7z%Y;lb*~W{*R4)++{BSXY)*sYe=?=5!R^EW>SWk
z7xM*PLaWF%6IZ<87-uaisuFzr?33!s=uPuwGU*0MK#Mv@KR?L+60FUYG*rD_S2<4L
zpMMlz#BeiUjiI9x18OB&SlQ92y~t+@52_gStgI#ue)N@e{?H^)lVNV4Z$O!gJg%X4
z>ZL1~oRoVTV*Nl6Ty?xneSiO0NXnSmQ0{ErLfIeybXSrd3d3bF@ZHAIiBu(}bC$pL
z5>C#+UH}CJp9rOd^~fu*_Dc^@XymK2AGKO6_Dh&-H~2(bzbOnF4JSV83WoMt5!Ut~
zX7wQcz)K7Z{#1WR9w!4_=Ux)GL&5|A{_ZyKP;ILtiGDq`Ka6ui<tqB_wwc7%_SP7B
z?m70f`Z$I?o=R`z@}odoDyRnGVZ?CW6k=gW0=4LojSj3eO*eO(iRv35O5*}jt#im%
zF<(p%vrre&04A(BAmLlvr)(_b7CvV<RH)CG%bTt{#q?Ut1oc|5V^4~<UkG%BE{XAG
zI10HtYs^Z!t3!jr_ylV5iD(bl^E%0)(WDo#JhwR}wc7{xLf}Yj7`;IoBwZ_6eZ64l
z<{pMD9ve-i8Ka4<PaB;yJxS8LX0kA5G6VXsjF&QEHAE*u^ezESdf?9h1k5MvJVu+L
z<kNS|Fb#xQ-G*<6Rs6_$&wBK;N`c>Inx=(A6Hvwc3Kgj<q`G_GkHi;;<DNraeHKJ3
zruj<c^0WqNg^IDChcU%!{wTl~XlZ9pVjVhg^Q|zZl#Q|k33#1`$!l)t+3jzO60Xe{
zk1N;3*m=CAOixe$Bo_-s`%APr?j|yHDQCpei-?h|G<t>2t**VmG}VaWmbIJOpF$GW
z9(cu<aO*6N%B`=x{x1qg(B`S0p0UoCP|^)K8~Gk<U)wr{1ad5Gx42H=d%V?FNGDP!
zhZ%iO2^~%MdhXT#iyENd;a8YMF7wXR7NisbcxLf2fB(6vHD_in@zdPDDE~GUg*v@v
z=Y>(**WyDTZc{L|Pd_Eh&o4g0${>6nF#Nb*Grg+oKr@~AEw+wtAIWovmB-ywFl0MW
zJM~bc9eJNXLO8TEfDV>;AW$e|%)FklCw|2=h+N#{)-Ok2>o8zDZKxF6>0ir0n6P$+
zvDwL=qP6Ja_@@`~7yIx;`DT8XuRJhK+{Qr`;d3f|UiWbo7Ohay2buc<bCRME&GWOZ
z?O-u89U%_`aP`vdvU{Jw>%sQpbF(en)L>*Uw=9>-`4A3~P2`K8CUfFA3JHGG1rIBk
zQz}zgkZt4~9IvJ(AJJ3Nm~cO^O08tS1b7v!HaH#I)Fzo=n!FtB-SVPhErv?(a%=#t
zx8;LXnOB6pWM3+^^Gzl(lSd)bD#vuSZ}^8;>eUhK%{2PYOFMTSwEhb(MDO*Dk)8M?
z$CCV=pI6};qM6KiHs{H}-}?LxZ4klN77r6MdZo`~cvmZJ@MlZbX^r2J(a9C-oJ8X8
z(`*@jUp5+fqE||x;wdV)=)*t?uS4)TF~}y}H0}aq`w_lQdIy2odtoR_-=n1dTi3&Z
z3XOU@mlLTERX0SV8}DIsm=1>ReAP8uUWdcHJZ0~TECxfnCS~wi>vQ$hE&nEB6h}W8
zcT|n2bgW`hFNzxi*xY!bmm~gwJ=FeJs6{9&?&dC~Fy>~)i;O4W^?k7^=&(RR=klMJ
z1QrMXbWr0G7-q2=K4Ji|56Cs-9v5btR~Z<MDJ?KnYjKF*j1OTkKRHh(e=;-sB&YX9
z`)w3^!`mGZuPW5QhW52;BIpo!)$2NN4Qyo2Y$XX^q`36T+YORS39sz;3<_bgWIC*h
z{%Pf=o~~~(lE@S_;^$711!b5-IW*=J-@emghqOA)j4C=b8`sM>M4CnB{(7I__vzW^
zQrmup-l;{M#?-F?E_-S6a_H=UZMHN}Yq?$DI;~EXQcXV)aoTps(<P<mSpSPRtT)I_
z;3AXWUThM7bPL0A*KMEL1=%xrxb)QMn`nS%m&DNZ)FcZQ&S9XQdP*3q-p{~P;m8?8
zRN>I;Ux&Y?r4c60+|X7tFhh#Oi@DdM-?b@`j32m*090+{Y)!#g$kfDvFGK22?*~&`
z-JHIY3$C(d(F^W`rKc6<?xd6IR~C@8Gua#eR>v&I?HA<NhOUW7Kb*?9+t*a60%;k^
zOt@dWec$D5J(jOx<Y=jJm%D-~32ApROg}AsI3QlSD<NWae^EC9%I=+TDW<O@R(Pg0
zY7zAly=meTH3>{=5IFu|aN5Hcb5dGLfASxlV@eNdM~#w6=(9^xjH7qZS0!%cMay*@
z<W`p|lG@;AQOD$QYP}eZw$TTf<Qh`e*z#WOsOm4xB@;3j>Ms$#jTDG_ZJGA8`)UFi
zH}U#;Ie^!bQJ*)i1wU`N%i~|ZD17OD*oCs$NOwTEKzcx@oeSN`l$y_J_JZs7LYhV)
zi<Nph!W?DBayNA7N7D5OBpE=%!0jIm$@)fI{H-?!+d%gl^LMWK9A?s7Vm>^<uW5AY
zxG|kzH@k4eougC20fe-i;G#y!0VTIxobCueFJzvV=G{Lgg6T>oIvKh@xHZ<~Q#q5U
zthk|6qGl9}r(-_c?mXW1f_&}0SADa~_%QHtu0xWQX?2;O>^qF^rI|e+&PKGljqMl-
zy*m)j53{3+qPqThFK9bidBF#iS6EF){`Gx_gQ>-8_Bmz1dY<v=m1<yx-%IxGuf!v&
zW0BVS%YMipoN(D!`#kB}GvOM%M6_w?%?6;pM7tk(@Aquu>{>9scyoD+wWhaj;zbg$
zW8^?KsX4ta^JHi`ga@(n`_OjXxsfie-ilx0*j#FdrEm&hJam6+zvwu<^64|ZbnAI}
zT9o&C{#tykDp<g^EfXx$dLB)810C&+H^K2|S9|woXh9yeP~<7a?|>9oq$j2^Kvm~W
zxf*aLH5xvKzP5Vt09%zY%3xQ-OT?xb{!-<8xo5E6c&gw1z*+@dGWNkTE2nx0T)FiD
zmXG%_)Yu*_i!t_$di5~6AQJEDWPdtG0<9{?374P@5`n?^V#m~<_Wo*6ql!+;`bgNS
zgIQrFuZg=o$=-!}wq-E$%nez%$?-Xn-Sbf<X>)7QN|d=A^k{0w@d-6xx1agWDRCO4
zGC<7ha&aNt^zk!$`QytAY^61^kgxn_@Vfh)^G!0NX4hW<LQg4G;B8$aHR(k$O1iGH
z5e?}aXXx0{z;)Z)u9+N+#Ht|^E@P<Dq<cw(Bh>Y=FtTmH!fS-BK#aN)8i2l1-9ZzL
zr~CfXPAMjtrl#F!ov7Pbo6}Poq~<e!j075Ws{Rlj7sCG0XD-TU-tnbm!benH6R+x?
zCH7Lx_TiHU%WF;JuFqQiKEm<}_#d?(bdD6Xk^o(=cvIy4;W5~Cw_fmt{LO30m&bTC
z{3)k|X3CPmw)<asriu^pBsciWBMt>;TM<l_4(Uc+di-W9ix-+F^`iR70Waib)g&F#
zoz*#q7>$BU((KB@C+HR6x$eF(jDx0S|4NUX2d=BBT(9q}4{S`SjVWvHBYm;z?m=vV
zByVu@nF?k!j}NBPz(zuJAyR@~2N}&36&?pk%U%&UzFm2#)XQ6Ua;jb4O<rt&(w_8G
zaNQ@*)pI}w!Erie;ylwB8#(4jf0BqrC>e(IWGLDC_RW;X(4|vW)C)-OzU|g0<MX_v
z68PlYmv>m<#M_2EazmZk45mw=kFu*<-WN1Er(jWPUxbGR8>Y>nakr2jA`H2sMC`I7
zz^ga)L>A@iFsK`F#Khy+etXa?fCAuDbpyUo7+TX4n_8!>IT4H1Ei-2d?8Ud6fHg+%
zjhR8g?-+*zu}E*L^x96Gn0WCja*NDFJo0Y|I9^9)z19?q08w#u@o&t=sWiU(K`4~O
zk>9qJGxx_-x5j%<WBL5&0QVh@3}r>8c8qPXE(K$=lNXd%mx8Z4UdNP6JEh)&ziTsz
zW~rmUl;H6<UfOtVQ!Z`gTzE1fJy;`GU*Y;b7o0MV^SZHl??)y}+lvACG3nH|Tqt>F
ztbBS9<5dn-WJ{TM5B-x2Hjef(7PgHo8JGsUcFvYhHip|+Tm|Ho<ulg1S-|?_iy6OM
zoKyi(ILaB#fhA|A%ZFU3UM7J+U5SkQB@;1-d^uAA9Y+=*7Uu~%1=3=b6z1*SGTaO%
zz3$z(Oq`n;1<!uG{=&(5Q-tGu_lEPmiAjF%Ex}8xIEzVJyC<=EQ%vnrA0Yb3N(woS
zc`pu>e{+V@dqQsKe2uyg%`Y%q4ij`1eHc4e{7orsMx}ySJd%r$VS`gE7FLwUt}Qm4
z*wo5#5zVnE)_^mYT1i|I%*`S8z#ad?TL+8V_=J&Bu4N4a4aplvCXrMDfNrgCTv-ZL
z<?W8-2c9-iJUSoBbYgV5II4w_#42T3PWZ)bd0w}u0R*-<mbsOTT@{cgh&r_-){~>d
z+`1jQGdFNTO900to|1aO^-q+Jf{DyC!rL1wRydTL>O&Z9t5w3v6oILV!`mc*sefAB
zY_zoSblcAE-9-DH<<kC%dfu`)JzNg-c3Cek+(Koqe30_h9kwsefU&bz9|fOYbGi^X
zH=b$Ux^sN-k<VH%c-sj@^qRf~0XE1FG#+wwUSmQ8qXoge&`*c2J{VI(9fBPJOX4In
z&l2JW9OI1E9*}OFH|!+W?l>CuI?EbY8$n7N=j1LW8%O3ZLzsEyD!*BS^Oz*|a#fH1
z!JCW;l<ntb9CI><?MXw<+=07+u<uBdsA#Zd@{>Y4<cDt8OKCC1uQfDTq|nkDtWK#c
zIQr9(1;2R3+`Aek55~Iq4yOt_q$>=EG8?C~a5=K5cousW!ccK=R#1y1{U*bhM)PSF
ze7~m{;?x@w%x%n!QS&H#a0>pR&xlsjm7#B?r9gu8E23NS%!l0QY+wa3TQ^ZmuL^hU
zGuKrIpiMCp@@uFtYn(T4ZN`Dz^i-zztmJzyHy9-dF#_>HNXb{~`&I^{cg8gia){Ns
z1R|?8iAVs6meM#c1!HIGE4u3y?Sbz(bJ?68CY0*hb?_HoThhnXIr!j-ixCs<A$=ug
zk+6L2WI7Fh)=}HRvK6c#wcy(i!e^-W^SsU8=A5_9<p%JFf%s#=Fy>2tIU$b<;qtZf
ze-8&S2h>97`_`$p1xXomN=Y?cSvp$<gSs#BjY<Bc{GJ~NF^^`?cA%D6xl>O14r(4!
z@z`tqieZY5mOQ4+tGnD#CE`6_d{5PAM788;2C&Xyigg6;8v^Pge={eQE@M8>hMQam
zEc#%0Cr@JV2%mM2a?7{qIQ2#n@aP;dZC?;OrSF|%bN{&sVsU6?k{^;vjF~(?TGeov
zq0j3NYW_J>i_7D)7IYF3X=kqhQJqQ-at)oiWucY_7hl?WAQ848h_q7@RClCmI;hDY
zPMU9b;1V)qj~PfkB1pGtYte*~V#MT8Ck=q6Mo4g^^U0Tk);0vtzBrXFf0}Zqls3rS
z%A&vMh>Rys9oKh4IC5fc-6qkxF*bT-QLPTubGOEyIEI>q>t^SNhHv&i2)KHdT8oPk
z2I@Ejy|?Q4RjWxNjkS0c34LQ0jqMlx#=QO8vNh9tk(<l<qfvdijiiIcKF~ud=*01$
z;8tp5)*q;%el_0cHu0RIKa(#yslaBAuusTn(<YC#MiNIXfbV0BZ6hxZaYI02hLM7<
zmr?~#M2omG=LQ(R9j}CgTIG6EiwOcB4>aME4sm`>_^1NTp?ivX%d-Qx4rNoZSpBhK
zOK)=%W$l>@ihDY;X7T{y$@V|nap}Hg5lq7ME4_+}OD48dArLTSCM!3%RPj~pj#g&n
z)G50->uii>iBO&`y(9R3|Ix)LSdr<b6xKaqhkMPsk2A+bxl2%=Cxa`?fDa74*A3=o
z1KQa#v}jG8SH`GagroU`P}6TnWPA`=E`8d)#>rrt&1__#)CDMeUKyuyBS0A65x?+z
zQ@Pyf=kB6-@OsQFEre8obr?25I25#}mlw{ZF+<t9i0bW4!CwTPfLxQB_#z@}yjon|
z)P#Sku0D^-T?~kw5MF4w+aa5ejG?Ab(z(ifbtf4>>~~5X{e~ed^VQ|z5;zO(*jIn;
zSW^yrdoYPKMS)Di<?Zdg+~!Q{Q*(^B+;Js+G>MN`Er+kdSc_kf#h7z1#U}VB-Llu1
zvOCT?HIT{eD7Plu$_BsI7h7Nzz<1)z!(J8%#|p!NsFgbtnbb|7DO9%}`NirO_r!Ee
z=gDdT5Tosy+m9GD>g>8nY-loJ{60~u^^XPq^pKxXq@~7q;da5};D>R@y;7&$MUDAa
zF9e;17_K}>k?4MC>tq<~=&{2VxFb=x`z`+S0fWQ}v)}J{ARKIckwts|%>~<dg2ex!
z?k%I@=(=vvD8b#KA-KCXnxH{~yVJP4TY^I)!L5M+!L@M<1ZdntaBU>GyWf7E_j}Jc
zXN-HtxPR`C`@6bpSM933)?9PVJ!>Dnp4`Lxy`-vZ3qSwd75^))QOur{6gRDFW3yO+
zyk?5uomsPm3!x5S&l$Z*V^mslg9Epu-G&{5cXkPmSre&1-11fb26=8npU*&v86jUz
z2o8%X?I7`H=;Btz`VAma5=S<X=!lePy0XF9q0&#AXYX<&p{>KA|LqgcNu7gj8xk3N
z`u^7GYd1UbeYp{-;UsI89YYQZXP<3<F2O?Ut_L6X<0UqJ&t(mm1WE=7J;K!o{V#Z6
z-e--l2_vHEv5fRD=Jqe>bH1M{y*HPtOk!I(-7B(d6yD4ipE4BP)T8EL+Ng`@$9zIr
z%jq8$8&+j20$zf^O1;uV<Nc}EK@?Ga>fajA-Hgwf{kQPyipGbjsp!-3EUq<Z5G@G=
z+qUOS6(;d=d3o9UZ-&*$2193<)%GLaoohsQIiA9g0V#AQ{$Ie|rtc4P3NE{JouQiL
zT0pDes4RI}*ae8&e2A}eCDxvQ13-nsV>M!(SAeJpXw@*}V5473Ll>u(puS2irZ|U8
zb)ri?KTb86Lr=oI{y?@gXNMrK@YR?s=~=6mX8tf)8oJ$Y<usrkI}ZZ>Is@BULW6)o
z;Rjg$yv2QQBqRF%YHnnJXz8=$+?o$WzvR0$&VAVOZm1oAugmM&OHdh`C+nk!+~T?x
zIzt`p)*#eXIg~p`5F^r{^?0hPI099AM0IG_b5km1F`=!vikwwLu;03qT2pSz6FVv3
zmYHaMzeO2}nHJW(v+gr@X6N3_iVk4k-eAeKPU*4WRjNTR6J}W4&UjH2+#_9}ip*sr
zr4HWtBlvtF0Iy#@?u8&#uPO3s3V}nm&$Ck3W8$t0F2lgkr|9w;%TZFGerS4h@+izj
zDS=xaa@_OMo+(!V4;E9zz5O`X!cnA)JHz#QAh4~mJ|7abIi$Ojv_D%r*}}2`EHzkj
zGOCd(DBIhKVa?J0xDiFi9+qa9;%XAr_eaI|5kj36iL$LT^9`4Qjo@7bT~6OJOe$@C
z%v7QnbyhPk=|^av6#D3(pq~0my`-0!crLu}xP}=fK-+963Z<dbr?WaU<c&6_!YpR`
zIRf-8Z{11c_B$8mCE6it2_*4pAPQ|GIn%snTCx4m<u{Tvowb~oCmMhNe&(tGK=D=V
zJDKk;!naYLN`LO+WTLq78N~TV!VtWEq$k3rp`y+io+)5Dcz%rFx#{53QFOnJN!8f|
z8BRTa@Ee8kSarTkGY$l5RT(f@fw9$zw?9Qe=-plM6$UN{62=Kt8B<gkCz#B(swm>&
z>DQeGejO8kOBJ;GotpOcWe1<?3JUYZ?*eb^N~-rXmK$|aw&TltW*1T`tc3Y`N|@Os
zkhDi~KVqg0a(mj=;_i!+J5aG%ayyPJ)@&ljju~!(-3*+C#=lL4VG<p^PgZ<^@$wty
zkadl}I(N8?FhBi}wd?GVbv;Z(-Av`oC-vM{qko~Wf>NgSO_bnLmDCZ5VnxPM<RV7)
z!Abo337`KMoMP#0nle8zYEOx`zwN`NqREZdX0hYYE;rs}GBs5Z$rOTe;>%D(%FfRA
z-YYGxIqf(uI2rOgH5d;-Opd9iFGXsqQACKiL(dQ$M_0MgWm$BAg&x~C78pKAtqA{7
zh5_lG`zY3Jo;AgLK2etq`u=Ot-xslLfzddX>CHUK?UOi6f<5>EVG<!qZY6_x&exWq
zyAs>OoZZo;g?kM~Ws6Y4@wWRf)f{{Zb|f|VC_1r{H$Cdt@Q3MP$ODdq;#e~EQ{^hu
zsxx+;s+eW?A(>jdY8ju($g6k-rDt=--;@_!xhzs?*h1U_(bSfH#J)44fv@H3r8n7C
z^lTE2V&tKN7o-a-c-pu=EDE=T5Bt9X6Kw=L%d6JfybKO2Uf-$~qcpzlK{4vtvYyh(
z-zORYG@8^KJK4Z8Wq<g7E|JfodbfMxkx@3|T<(+0+`nf!d${0{S{>-AT|9)s4Z<i=
zJr3Zt4U{z)-=(Ur8>zI?+&`yq_*~L63niU(8~wmr_z9WI%*NXKSG&)-^B8b@EzKy1
zfHd$*rk&S=FIb2LWpq$iuwd&_ux?*8GU$2Kdcl`!rt|dB`#fv);OM7G*Q@&a`hj_B
z7=BSpmm(%v{z|c`r!d+iE_2!$F*)O!iq*@IM;~*x+)?~*!$c|r+p6`+<Af^p8Uq9@
zr8;t~Sa|!KdVOb;mw9J3aSAil3aL$g1W0HDivegMxAH?)2gF5*EG+NCL`V~V>F)F_
zIC#NBZgbaT)bTYLU{U4+F6#ge_H7v2_|G7iYbr`HF|fF5wTsclho}_9gwtflWlSO6
z`$j8wyDH}LKzrmazZFi-J|p0PwKBb$VWDNq5CPO@1zN@9=$JWDji$P2$4`1lqoZHY
z80~p_D2W)({b_M!yxXcpRMZSa@j2jzw8^h31dpmNj2ca)2nj^qeo5|r1?7?V&R!Dy
zTDQ{{rew)?M;`34i;r?|d67LGzd-T0vH^4WYCH-bZ@eAThn6~6@B0xEs5fN1%-y|G
zl0lUj=dB~0&Z(OFMkEo5C&~LWvh9`O<=>`!hvQzIhU);qLf{e<M9xdE&)I47HnpjP
z+)BVWybjzML$J6Sa^tlc-2IctM0cI9`6|0JxT$@MjlI@lFp(}(f)>VWI=xG$u9H|V
z@r61Ti``sTszpbp^p}k^-GwKC^NtCHXts|#pvJxCi=#q>P{oK^Zpt<J$h?PwA&|V5
zM%^iW8`>o7G`KK#s?wCLpCvZTb4fX*J7o6dmV#dRc+~XQP+fr7Ryq=^(-w(#st1#R
z%7>0^oA!;b*Kjth$Do@nY2EfSi|tmvN~JkRYl#t+b{?9)1^N<c;civl#u4X^QmU?@
zK$+s^0!<M0L4*>qxCLj71{|NtD<h6zxY=(K+AUGOF*KJJpULD(U?eOvmW<pOofG?b
z2Vod2{ah;eJC%g|#nn*&a+|R?=^%{C-dnwg_UDJa?jn7e3RRE|;~9v3#z>`bIM&AQ
z7RRB6AdBL|&UX|W{U|<%=|^;@o@Ii?i2uF%?Q=aog*U~BS2N>U!0J52LO<)<`sc9e
zOEO^PmJX-2xN#Z&1HWA)@_Itz;t5!^)?%IfX^a|oh!UPoeTfbe<;j;xBzi4B&$fMQ
zyL2^wI=>tU2m+v9cjDGv=f<b8x4t>{?{BzCF}@{m&Q4A1eAv=yw9jxm<Ls7EWs^|E
zG71pGKpz&&qU9AGQOSd<4Wu6Gd?;1<kf-9V$`JE`$>N;7HY|a$*Z-xDOuG)?uY#7=
zI+sur4L~65BvZ4|{1${`(Wce-G`vL9X!6Ky%&h0v)@SZ9*C*XK2c)r`!zuusk?c>!
z)tseu{2(LaxBt~JYXnAPZ~i5HW5b+)odgCmGDXA@9=~=O!xWNW)P>N%fFNqQ9(j0|
zMF11ZBYRckA+x4W*U*kil&vfR-{EbWnBr}JKP{}-C?aUN>VW#q)Hq0~E4+&RoccSa
zEDGLGeaI(TO!RzGn&N$%iLwIfc$JN3nk=nZ_Dsr70}zHdy73nG>ts{2Kv$$!&@aXP
z6>iO1y!d(+SL4dqPWq+2mA5}-f;~S2GCc<n=8X{N{ADn)N3G+sQ2Sw--9&8wTdK&t
zQH7(Sz>hzFz5|zo!@{(I#i+3vUY+;LW8Y0_(Ex(H_RUJe!Eezvt#Lq^XVG=P)A`yW
zrI-)V69iY8r(k(hxEyx^)6xos)X~yHGV+Xstj5gWbs7ukgfxDY5DO{ja44?$bZ5s!
zM?xK1OqyzH^GQroxA$7y%V0X=cNRbZuu5E^5K_HQ{^53lE9v^uN3<r_of^Eq5@>0$
z%!t4=f-X{+IBBf=gk@VGwkt{i1$%yIZQ&lIW`M7RH!hGYFGr#u91lSmH#CMv!E3eB
z422kC3DAKW{tQb#quR*h1^e)pEG2x7f}rp3c9&kPJU?9v10p%9N;V({F;h?;qheTD
z-mWktC*<8x_rx7{|Goz4<Wo9?jrKu=UH+4zthon*TYuvoJn<rrsv8h9Q*9itoqJBd
z#<1^vcXSQEm_hUJ#i7M@G4PzX@V+cJj@9lsOQ~YR$dm>Xwsh>6!%5jPg%CKl5K0wx
zZ9E&{E)-{8)`gC{Kw%l0KG|i)swI)(!{h#nl+%-<&W#!9nEjf5fkW$8K^En&{R)%q
z(>KEPS6=~g>D&B&My8rw=<$WUO!>u5Bd(dxb=X_CIo*a4y&UyMtIy3>WGf!XXhdUf
zaTY_s&osE}FdQJ~O_r|ECu&Ftt;hn$)Art66aaV>VEE)Y$yim(;;NKIU0@;6k8Fxh
zalBoo=Q_LOGVrFro+OZhqVnSf`B6qjOhCL-_lgyTq+17GCp3TdXUTe|`yZd8uqvLS
zU1@W=nasVW-7y^Ddw0j)znKng53lOWwc>QjEqG-ruDM6@xWfJ1OqYBeot8Z*W?WU_
zL$7{K^8VO4ch<j$&k8r%1D^ar^7)3*q3M<o);4?qO89~+QGsLxCcKx(*j<=J^x>o@
za(rLvtioZA`-TQT`mMH?<1p((Zi7B&(2BnoduX}=y=0LJy|Z@R^X+NU&0j1ffwqFK
z(L1JOH_w#tPuTM!V>j@u4ezzuz|l}_Ar<S+leexSyv`6Po~^{n`{+N^*H80AT0@m1
z3%;+}%B)U=;vY2EgHus{BwErE)HOeR9$!xck9&+6OV6UXnA1z<TwGnPuiOWPcdR_g
zzd`H&TUrbWevfPbQ*e*ze?_E<ON(0-r_lcQ%rn;GkQl9cGGmD5-aHz@tu!{L>`rSG
zeDXw3RAEG`is@E=BOzen+69qm+Ie2@1sn1nD;VFYZ4YdTGQ=hb-)q1<sa+Q-<LC0M
zU{#_$p3kK#g(ZEC!aZK7)G_4nS55y@Ey`792g@YKE}ixt|G>{7E?5!1LpRW9n(1z6
zI5He9nFV6(erm&aDK5wh^IO!Ow_5&9aJ8}MX|N{#T70pn(XIv_+@iIO==*+cX~?~#
zwPKzVb!|rG8cj#ROpBDr;~Y6XL)71Er~Q=udEMaj=Q6SOId4kBF}?8k_6N_A46`5=
zL}Osgd=P&qIOH7`Xet0}?f$wwvTr_ZT_uPNwQ#^c?<?rtlr6Pc7=I*7tq>*!s|ymg
z7e-WcIP&NB6b3W0ea!|@3EY!W)!IHh6cpYKRED+gFCGJ~*NBWevF$j{_8TDnc~265
zatFULAV`BF>9Nk|`%bgjDnq5&_wK2*NlZV;ej^I>1o_s6&ELEATZifETwgWHUdkDn
zWlR0;YfNECO7&lM&zx1C(f$o|WXuZ(nz6db$_P1n$3TF|`t}?9HJ`sotyQ0rG&!xt
zxy`WlXM3&e7RkAxP9pqVWZi5PIo+-8jrekyWY(qLBPv_a(g<yYf)sn2TOVNxEvbQi
zlcUF2TEP7ke2AsmeV_USBOXzxWGH5Eb8@ax8wx&A`fTEeAU<k%1mRwnk}P0c@HwoX
zQgTx#pRLf{7;7*BW1E?AZ=!6y-Rg@2AgrPwdw}5dVmC8$P}Uv|9?^P{BW{W|Ln@R*
z$XRW-J_*Bp=tug_H<aPs&^($5OwyUCMISTC5Vw_yj2@w}uV#mdQ7<?UQrHI5{DR&F
zu6Z6BU>+usOeR8FylAVZ$hYZ?BN3C8vEv-|{gvcaxC~K&Q3>bi;aGPVn#BaNOK`e<
z1}@OJt*s3j^c?8*<EvYK6gm5nN33g<Y!zkU03lT$;)y3E#3k5z2mZisfJ22SFSQRt
zqxNDHr?0Jq63@dQ-3(j3I?l5lvxR<|;DQeR;j4)Sc;?}_I82O+2?;$-q6iV^w$uPV
z>HFzE<SC6WXN<o0A_c1=Xf82|1OSU422p1P06CBOfd}g-Uq$zdG4;mNPYme8J1|28
z1OTTO*dy)%1ECwk-jG44?_e4d+|tOZ97-}ixIk^{{0D1U?pjvY^&te_zDY;rmaaDX
zACF_utCBeXa!-hJD-~X`6psrkC|S@UGD;n<U^mLO5t&Og0RdV5Ylxgb_Rp37*Bn{Z
z>YthW@4*rtJznidn{dKWf?Elkd4C+BFd>*O*)oziz8{1fET|UsV%Pl34?u5}EVsoS
z&$30ddCy?T=HP|wnUo@3y>%6~L?l<zDAB~c@Qzv#{dRI@#=1S#L&d|$!@=bBuVX1>
z7kdaRw{-2tNW6H2Vxi&R3oCjVfmFM5G%QH>!TZMWL>TTx6G}|UP^Xw+j}3B75WxYt
z|8tR%Oz5liCx=5O{FJGY2`6oEFJ8dv4-~HX5!wvu`S&mwHG-s@{LdLV8TQEveDQvM
z#g!n>$e>rJB@0a#q*V?T6hg!TDj0qkyqrfa0cdn%$h4^)Ihj%V?={`gAkHxN55A)+
zdT;REfj)F+hAhxZZ%HY#Cu8?NKcVtL4AU1!&Mtw>^>%lBVBWQ2rwwo2nV0<nfOuHE
zsTY7q=s#SMgd!Jll~84myH^ld=XH*Fw}59##5O~e&GRFQs#Vce`VQk-V&~X;9RThF
z_-2p2ev?skwuzC*u>R&B^(*4<wYM8LuRHD+Z*JOFBkT;zLJBtC2rBM%xdcQ=K+OMG
zhzP#>grvYy+R-;`TF>BoeO%-c;OA|`fVf#fu{}EF70$u4&4~Z)gs%PPedec{H|1GX
z-5}QP>7XZ@_5eB7cFsD%s$-SNq?io~tnn@ALHXN?j`o+rK>~_t{iiL}mM8k-VID;&
zi5L>(l$YNa6h7xvkWeX$Q4S^TUicy&eazc`URqGJDr;)DL3U)mM#p6@=UH#@xHz^E
zLl3nX>+*@i0qb#}z|-HwIn9-jMX}Q-`CIn#j(z<gUX5A0{h+4fJ!^C){pq8c?FZ^3
zahcKbqt!g@sq_spEDQgu4r(pK<US(p2x)T<TrXq%9>6t0O~!UZ(F@HKhYoRY;VQrp
zvUIwPzG4#6PCnhXiq3W2C>+1IOm<S!$!P5Hh`HL^jCh&WZ%QIWbREt%6=*gG4e6CT
z{P2Bn2j2`OS<ow&X@=4aCJD<7B=u~@9)p%X<wQdN35<y6Aiovm-C6gp>Cl(J@wSO$
z!%nd?K<wx_i(@^|>+qxhQ}{dRRnf^pX8@_T{-dZ)Ow;p~rVg%I{fPLzoxprcgU;EE
zINJW*MVixV$2Ry5Ca#cv;PKP>X`1R{)>wa$>0w#!`RnEr;@9r<e}(ZuzODuvc?FTe
zLS{Oh%;5<=E~8~H%7wwrKNlED!}y5koqOF1nPug0R(+~kSGmPzar!Z@`-Gz|wYVPw
zpIU=xa$p3eyWaoauAq^Rs~@AX3@+l%`lysU$a2(kmW(8GV%Rw_(**j1H=~Hr{#_6;
zCOB1r`{m*2>Am0@;x=eGZc6PtVV2uo@B7aiZl0_yYyNf~yc95p)i+f|cnGhRb#2o_
zkYAi=!f)<%U>LUg7s0WThO3W$=yu%)lPJzxwnDny>O#g^3}rJKk?;Z{Bw6D7r&erG
zt2(7mtynUHk{|Ncpsegb(j+jm9Vb8V-<YHx<85E7`Q`i+hv*dd^SKYD*i)sUQ4~qa
z@=YIx<Rx(0+MXx+YOQh4^Z1F@anbPbpcE_V8Gy>=0em`D>8@*75%Nk7xOpaS0ePro
z1iSaUNqdRSf8s}W@mHkt!TtO(U!=tV5vf%F6Ha8XAulHVyWWKtAuqcVfL8BtJAiv*
zQdsNf$4}HJi>8k?qmwiS1JnkF8Lhm@Vy+(pQd05G5W`6Wt4=2<)}kA^9aq)FMo`*(
z6mZ5H-s*_YWQ%L{yM$#0!vv;cyitZ3a0Zd6;^H?_81^N7xD!9+7;q{1xXPx8WY}Lv
z{4@D?+K5oB9-{%OUH$EhLDWfH)$>^Z)#X-nu7yE_q3s%d8e{(QSBP1pGmui-t&)fx
zMwTk*DIR&hPY&n4MJy5ZG{h3&G6+)r!gg(O`gIQwl{37Nct6y<o*$Zvv{v*w8QQ{w
zekyR(-1!BbMLfyKyy0d%x`9cmV7hDmPt-hB#qv3W3?`WhLo!5K{%j6z@omaUvH8@l
zYz}Tq`ndY&2xa_lYvK1GA|{P3hc8`F9I;-=`J4S=OtBs7U+7)!JJu|^^~bq!t}nc}
zZN94nyF9OI9IC-8i-Y`5Yf3-nt~Pip;;<XoUvqHy*X$XY=6V=;A2oMKQYmrA`H560
zf%@BUy^q?KCTSE`+294owj~QTw7-Zruucri>sTw!v#;K0g=y1NHFJKQhTowuy!v-;
zeFu`V>6Q88zcEmvY(>SZkt8yx0)~<jKDtbwZAvK~A<~B#l@@<@J2r^4#w|!7l|3CV
zCpI_4P&8e@%hQ{_h&lUb$N*8eQyz1l3^&gA$_6eGJiJ)*p^FcQfNv`F-iKTCn@EC4
z2D{?hjC^Dws?hXcUIE%32r<XqQK%q!ELy-ji9cwubOG=Fg9)(JzqxaN?W=!Ek0%PW
zdN>Nj{=dx~(izjqo>b)^`;)eHFZ$4uQN<J{M1cK6IfzHq7yfU03Co!J%}GO$dD?v(
zxtfB#J}|=jpG1eqLH{e!o$8FR4e=*Qdc`Akk_E~>RE1*8TG9{VBPNHQ5OJ=!|D-Am
zlbbz7za)3we1XrXhXkMp$jHC>Y*6}4D)N7lCW^uLSSRiDOfoeklyo^Ky&K)zjNAEw
z<B#AO6qkelBX38g#By?krXw9Jt;QCj{SCF+uwp)t<p>q@`KE}2m=46iQlc3MjDmy6
zlmA5?9{-@4|00h_p?{O){~VOc{(lcq{s~zBJ<A`Ge=^U1huDkxXWssM@c)b9GIZvV
z&m|&levLgY>$I9EdGiNidR~SC|7T1=pA5uHl`hPM2xl<f0t(DDJT~u8YzC}ECW%O2
z#A6FBVNm~AWG$cYzpnZJFL(a`G|{S9Ll(I*>q9+=1=ja(!bE^4x<WOSYu!7d;h>(F
z3_rH#m_j9mT02Bp^)8!<E;qK<fH^~vS)Gte^?i%0abc0946=(FE(_VelE1l@PBI0e
z5tQ-1@vbV0kt|_hku2{<kxqcu(ygTZDwM1jG<XsFX)#^UJ6@fze&e@5MbEIYFClK!
z`*y_q3M8?qm-z_h_7Wv>xm)_FGU8ACnTymtCFG@w)AbC<C{!Pr(={m@^Z&cy!uvTG
zA>Sk?V^GT>=W(xxJqRDDd19Y-gfLp&sSa&o*C|+Zti~1NC<q|9EXF2Ynoq@s0o&dQ
zinyTee*ie*bw>0ldf~Ol9~e5ku3uZeIUU8E+KeU@G6WU9=-uFg`29tNJP)OXYKLN9
zZb~unxYsNt9`-u)emq#|TqO$kR1l$fpP~4@G!JKV^fSV~rpunUYXkrR*(3}WsHd}v
zkN<v^M1(>jir~D8vU}*<)A8$GBP8{>JHRjALNAkFy;rX-*fNt-V0u4&K+Z95KmpaQ
z!!e$VlakD&$cR3`mH0#SZ#`itBxvAy7>JYmaA8ctlm1aGSCTqIf+|-Qs^c8@4Fugm
z&({&L^bLQU12)8}&BxIvGA2idQNJqRz$a-N``x@{_HpS_ldV<0Fux(LVBm_boQQU=
z;_Nq5w&O41>JHrFyRGtWLc}}nlAoNRNFOpz71D;~k-x7JpAt%_VBV~PEEPKc%Un_@
zLrPs8PcMs&PH!^!2c1bmq59`4R@RgW$Nsmcf(xvgmk1G%Nl{u)ub+JMyBtaT=bob3
z^xrOwW~hp&kpk&CiH+qb$!2oupAU2}6**9_X@5sHjY!9-$0|9<`abcxa-wjJ{;Q90
zEDGt_x>J4tdLFNALs-HjD59i(#}sr$zf4AcwR!$lU1^;W|9tE_(|MCyV{&#~*ch>p
za{HGv`B)Uzbl-IVYZYT$eggy7J{S{_7XP+t9MyAmzOwSB@A+O$=Y41iQBvWE^Uu^h
zGh<`QCq_+J!TmMpy_t*>#yf?=3fJ8ep^C&$v=iSPKcE4)KC@Xj=F*pckn^*JMuyS*
z{nZ!hWgc((13LSwlebhZhDsHlZiGqny?H+nb}h1IghVwykXnzDQg6e|q;AMcWpf)!
zC;S@@>ZkVpao&WIk-rNBFHW?_BvFK6U;bMvHfLaBrrE7}i4GM>eZwur%lHaoB%oaG
zW+XZ`IYk@P6}7s7se*ohx6H02WihIG^a?+{1KVu^INh6JhY=3D&Ze|6`jD~2HbS(D
z>`QHC8WX9QHY;+kpliaFPcdnLru6{IR)WPLg&O#=SO~`O@-rtDc@mZSj``sB`KLnb
zU+FQNKG>xk)3;FWnX87XQ^*)Dg^wt6xwJ<%a_VUvZIT?&FqF8f-nrSieX)7$xE*US
zTfF{N72d411${2@GOqI(XsC>CbV5F#Tv?OaVCPF-PocRFy^c@UMTUvAu-=Y)9^+)L
z4%J?t#y6%r1&+`X;jx!$tT&N(N~bOfjHv>2bQzoal;xWcrmt?1_-Jq2q!4?ONW>c=
z``>ppeb9=RiJ!i<tA+i1xsm8$W=L?DnI()*!tePbi9UD=xv1c&_O!@r4P#&S2i8h7
zk?o?V1SEN4K5=-<06*GI3(;l$i*_`S%z_^QK%;k)F#@Z(SGKkbjqlSe#<QA<wTf5E
z9+uxnsr{*H6@^>Dt)lZiLb0d9Cgy+t1VsHL8%<o-u(l=Ea@=TF6oqZ#2XI@kYy-En
zk_G=3z~rT;K#4^>1fG}gr>2iDNQ-GusFX<m!Ki-#MA;zOswrIBB-7C7U7U~P86#h^
z2sevf6O337-ZRPm;eH^DR?L%-*nlyy1$xoQ)Zte;$#ioj(&^!abB<e+%D_}gsock$
zF-U~WiA{L|=0cS#gWidGR9nmj;Crn;c|1(~POH|Bo{K|#+2C59437s*h(R!?=NIse
zd;0>Hykh`^g2?Yk)3W46F6u-KT3dzu)@cWp*~9i$0K85rfQRdNOg35ChrT;-$KO;m
zkRCx>gw=l8?>@Ci@QQ0L*rl>y0e7B=!qj|(v1A3R+dOtz$#S^+xsEei@rQ5~?6)B7
zsjfw{_4H(uoff%MPT_m^W5kuhYDg$lMOgo&`aR51bRuRaR0**(3>w9C#!bP;2scQn
zTr#8^o^Ol_B*KxTDU*`!i@~uaIr<RR%ftrBG`HZbpKEHPAk|6TPVm@?geP48@Lea|
z_UN~vJ@P#0=1<cN#+a@27+2OZxF%T&=+V0m_JaS#>X?#kU#e$n-z$~sZT^)0`Q}f`
z(}TMBl@f$etq<tNd{F-sUe)6M=Tj!Mo}~5p<N|14;pmi`*E-*q)jeKhO`-Z012Znn
zT10A03)j#MDF!F@dM8);PnD3gR9vEM2>sq-%DGMoWCYqeeOVw<EnBEc0vJ?O)t`+A
zh}(_daabAzaHRF9r-u9DNkAA&#J`VRuG#<Sdqq~iWD%*JWR|K}^@eHlN-R_-kZ3|+
z07>k&@8}no660$FFOj%U2^H%JI2}I&mOohx@2pPgqRd%<tYU6r&2cZ^Qz7Ihq`L1V
zB6nZKqS>N|{DyZ$5~XeXvi=cMba56VDxOIHXtwYc!0p2$<jsn(ytHfeW<X=Z>A1{m
zRb_V0#Fg}}<SU07@Aoj#RO}}ccQ&G>5YNuB1L<rRKK2hG_xH5MulIQ<K;f<6rR%SL
z$2~G$U+ud^^Juo#_p7>Ws)DUHjF%$7op>^XCl9ImlEs(+O3I#5;V)aW0hT(nqxa&x
znLPzsS#*w-X?gtajsBQqY@H9SooA{-?u43aR><SGB+S>)@e{lt*V6`Vtb25j<pzXO
zsnJ<P`>9J%R@yv9gPbiHD;dpHjJixVT%Jj&`_43aq0LN(0krv3cAcD?>VU?zR-;F(
zqv?^v|L_<8gL)NNQ1+{%A#-M#bnNvvYeoE1iwP&TGS_Cma-QE9-4MZyZ~SN*pJ|5L
zIwH(xEn!yKsI*qPg(C0V=T?T%a#Ycs<#8;);3W%y(OQcFU7O6$z6<gxC)AH$!c*zZ
zvCu)!Ge!sgweJ?$4*l=2jg}VTbK)S=99<5KYi$S#0p5QWIVna;m?MUjV|ush$ToKR
z91~Fht-OWaw?}7G-dT69eV8&<eq+yHd)uK;-#%&Gxm5>AlziDl^Jz2gLVU{R!^qkh
zyvZ{mThCC)5rWHSsDs#)t#%0cPD2xo9|hsquj=z#T5rfY;b=N=pJpB-vg<U>W+`<(
zJq~(P-L%J&%69rz*wa)v{(9vvIYUg5&tq%hh)J)9_J+rSZ~d+U-=aYXI3sFduI^!g
zuR*B#R4J#YX1vCfgeS}SeAd%@gU{9~7cRPQ+lb49ANL%M&WZSJXPMhNIjz=T3{vf$
zF7n}@Jaav%B5q@Zf6J@G0;H~Es+t3PL|n#F%Jy;WCG*81E={AhLv(p6gj#DX7WwU$
z+wh*JR`YCRBp{q6Zf}Z;%~ckjs(+bvqKG``{{rVWUZh1H-*^7X8GrA2VhKZg{LmD8
z`klZU;VAH1Lj%IP<`^9q<MyDRFQ#@TyC?IISJyj;H02Tf=W`|*v0#WK{cBv{l#M6D
zM4f2diUSw9FV%<bb2$;u@j#K&0(N`9*73tL;!8w<bN3G~Q6l^iJDm#GYrn`j;=L^r
zdo3M>Y|eR}p?AgVR)~7cjtbM?TOp>uMF1$<`4Ytf6RRaAlw-yUhCb^8RWc;W<{PVb
z$&6s)4TD&K9rta@L@m^Vmn7OX!i(_s#rCLW4eq-6bl`^q+Y>kH+Yp^-j9H`2=*CsQ
zT(H)>cXh5&{lD94U1hBn<0f>?9xI*4;^Fp-EmKE)5NLgARh_@?#R&~bwCjA}@#CDO
zz=Cyd*tLGgQFq=rYiQT$@d_c&G1|kNm8aBteGlVt%=^Cucb;SZlZicJqlB(elOC$B
z+tZim+h3qG3h7J1%Li!z3qBYA)8izCjJO=WmO|n4sioCTL>Tn<s4;7Zxb#A?Y3`W@
zM$w6RS{W4TeJy~!A3!>HPdy>`P62ag?=>d+ivUmZB`kFES7%x|)~|k7Dn&Xc7;L*k
zVX-fe&wG*xe$OY`e`x25lA6EBId~7s5ILK%(w=o}>wS5FK`zw<z#?A?vp2^4dB5%r
zpZqA&3Z=aF#MF7N@<UL!vIx{IwG5YNFv9yT8MgS|w;&h{7h<6wnY#E+10!L9Ceo>^
zbUW)d!Y^LT6r6`nM4Iw~!Fr~YRfKqcXG)pgzdjKgT@(4NRof82U5~fJtD&_Ar2e<U
zl8anUtI$QjKf7(q%<=g3&ZeSf)_>04mLx%IK)M=fN{O8Mz0rjcvc)llqbk`2DwiaI
zu<^Abyvp8iyEK5OF%=_AnTt&9c(Yk@zT3NVds(1aaWWv8s-nxIW!J!^4Ow?cZz$~6
z+A8mpeGBZ!pg3p8C;y&XdK{k)H$~QUxa+CHO~^>?<EwM-KvNSc*k(7E(bC;@r1&jM
zq}P+c#Oz!2xsokXcIhdgJV|*<0}Y;RO^P}Pynd^TLP4w3{POoG|4iwyj(QS?|Gc_O
zZK(J|{3K^@xaAv^DZ^S_e1`*~C1Hjt;5KhTbOl_2rV%aC1^q7;Rno5Pc*iS>dlzwj
zam#B$2}PfaG(&`gK=VHK>WN_gI~oN=yYK6&oV{Uz@rjGblgW|9tF%0nKx6qM42}X*
zK}|+A!5hL1RZbj#8;ucl6p$1+-qmIQ=bR`I5G6aMc2H~lVfM0jJ6)!^*QuNcw(LU5
zf3(*0(%>P}`H@hFzS%Qce?JUu()DL@`Onv86&gjC2i>CAcO}UVO-r7eHllosOL`e&
zn+p|f2rIyDdV7)eD)}cK*bRvoe&y|%r-8vn<3GuOjC^rKA5=Bd$tv*VQxEgC-!@0y
z3L_u{ujJL1w_%Adol`&g9E&|18@4$=#%-VE87i-Z_)&Bp9|gS#`hAK01U;8~xPD@r
zo1EQUNFGT9Q67lwtvZ@mh@7L}7u(G))t$Ba1?DufNXpV=E1E$|%@F{FtHs$mweg8<
zJ*!&QeofkBf)}gUd}2_o2Gu}dY)BqxoH0h|RS$#jk#l&8PMJ;ny(Am9ALAM)`sCip
zP00uMW$V>QTJ9lrgW4y_y4S0?)<h@iYGsU>h`)^rIL#cSoHDz?WXU>~_T&UxQINxU
zu)Op!5GYF~Xg&<vBSMw&R^GZ@K*st21`LRtiDts$8cX5t4M7cc%TehXxCcbze$BPq
zTsa6GOH?_m;rB@{8J+NiN`-|hk&*Hk<>j@m&${IG^e-n7Ssy48Ep<10wqLu!tHc5i
zQysP%ZZ?kn0RkPKJ9Qc}N-pS?rQDvWpdKQz4RXdsr`z<l*?Y(NsIywTlkp${fA}($
zZNvN)giX?6W?g33O>d&Fv*c%i+8gl@ud#156}QxuyklRWE{Y^LK*9VV2Gt*OZ>n2;
zO>;mI`tnw&bRriZfv3ALv84+Ti81A;^+2AQM*X0GkK{f)Ij;0Um>C8>dC6Trp&>VE
zn_3Tnj(B3z_cRYTYi<LXIGc^djj*R%*7h_O)ZF1Nt6Dc>$3Y+4vYcsxR`kTd7Yd46
zg9uV)Q*EvjC#qOHPRDTq$*nuQV3+3TEtV(+Vhe!9*lss+nj)k3gZGsz%UbgoMJ*;4
z)!!ms{e;-lU*=IfO(j`6M7>f4hRE2?UNUyte?7F=-44{_U@A4OVs~+}xg3IdlJiyz
z*cP%7^~Q7Wv!}p=`4y*G1j9>^^p?B<fxWu_58lXRWoaHh4?DRszWt`ozQdRoxx0VZ
zXNL9sXQ=&@YkuOF=|WRK8=hYxSH0Oc{cDRkr4Q<0hbDt#0FQg$($gffY(hXdRsgwx
zQ&SM&ilq6HPg8?SG~GI*yQv+~SGIO=;CtP}ibdn9C#96mNSUp@8DoK(YW-cLE$Btl
zH7&GhE)t~jfhk9_OO0tDk9c^FE5!AiKwE@`XUvu%fWq+AYy`83>ckhXZR6myaow-K
zjtEY!QkTA7W9Cx1qE6%b4oZ=4KV3vb^6?85pJv_`uN^0{rHebQj5xO<cH(s2b?HL^
zh>{U47lY<+5z5uU@jW(R?df8D^%-la`JoYR(dmiN_&CM;=+BToIH4*M^KFzW@LECf
zQ@cr&Dm_fbHR^RHP39yEd3-7e<+~s<@51VwuC`9c>X3J~$6-)=xs?hM?e^lWfx_3p
zulTjPtIAM_6xY1D+0tI~nz48T)O^;PbumHJ-4C;HBKs7Rc$<|UD(liMf=6Stlgvak
zPapeUx0~Qt=xtQ!azwo7R0+cU(<w-R_tAHcyB=JSM5)O!DfO5klEE#+vsR7hU(~vk
zpSB^V;08;*YV#C{DEh0b^PGErn#GY5jHQ2<UMOC3!K4smx?9Z_F!(!-?QwraozrfH
zoTp|lNl(wRptO|Fzcncaa1GCK2Bd&zKO0)1Wiyi<7uNMg&NxJs01f3M7o?Oh=q37*
z)Ef%IWUWf(I*Ymta8?%*y0ouGyE{Myb$Qsz>DlHPf~!*c!b(BzNC^#5iH2}L$2uEU
z-IbUhAncwvHOeQ}4wRtP29%#I6@ChzSt7s|t=p)_;>l1+oueAxF)A}H{A{_eBuZ$X
zjp*_4DB+0mmvf;)h|8C~U92t-hj+bA_qf;=6N)GB-0Ls~#dYus+OYG|Ou2P9bMm*)
zF;x6aOkiim|NQ4Oqm|dIw{fQTlmiHBgWBdDLSZi>9C}}o{A8$Ij4PBs`J;OycAAxX
z5^@;D@HSg-*Nar*Y;N~&Do5!rT!o2LEo(A_@AeP4wWDe5B>I(&f7qWJp6?8GM-nyB
z=QOYooDX33o!q=$K6<M1PIOk!jff>um{f}9Axxs7=}h7b*z3Q11~ETl$wa*;RDUh~
zuhs(-hrQbGk?ix=ll(9wDKj%XJ<CxUzx!7Ra|Ug(40jKY{POenM>kiqJ&8$SWjloI
z6~oIh4`EC%W80Ktbvnb42DQW4_JkjJV#H$Q6gBC2y6O7)vLqs;-A92;5}JLFMLazf
zctW3r?$B=T;)p%}sxi`61irYi;NGFwkq&Ak@<GqUNtVus#`Ni;{K%}V7A!DCkTJrk
z8!_Qb>7p9-u)}R&?-$H1kul`I>l<CY>8lgb=Gb0Hcuha!b2#p1k0BqgVy-qlSrG;}
z&R2cUG8LsLqp>y>PS$<0O1i<ib(Udld!rL%(|ezq8TSs>$vTdTxs(Xi*}At@#^Ja;
zIz#?BI~YD&B&wH>e|&iiHTmaPH{=F>w8u7brE_dzFFmTkhR0u$_?k*8hn<_vJ!@A%
z*O6+@C-ia#+35*i)K$Gn1RpF3Ybt)wSz&J5{g_(ZHdECPI<J&_<+CqtteF4J`hy6v
zBEPPv-9~o3d&QfhflJ+1B)qxFY}aM!F~aQ^MR?&jY*!nQcCB3Dl9XtdB!)`QV{-N&
zZL&l;NAh3WIiGekkP*E9=3xKHlfLJ=M-rfctB~3tydx{RL!E$Nd#f+N1MHmF)9X;n
z*-Haard6lv{vXb@3w}0Z{KR%2a_mKXX4eEuAR%{-4qiN)e`>@>eJdP_6iwG8Xi#c`
zD%)MT+wEWoe9m|^Bt6X8V_cySJ5cMdfX_oyjM$b`REl4b^IS(DN!@h`YKKd{?N@Rh
z4_f_Og-W&8Z!ToeY^TCUems@{M<*J3M*$~nK0M%9PbI>gGe+mMt~KokFVD4gzJ8pS
zWQ5gP;$kdtg@9uEKjLqMeBw>vbb{Nn>hV(!((i-gh=lahUkMp>!{&%cjp_ZgXt&qm
zH_}XuBw5thCBnLGb~2VGMcF9F(+Y82AU{vvjlqBO`w^~$&<0xUqVmq)hC0)Rgtq0w
zZ7Vp<m@+eUL@TS;1wAk)>29=1QMCe3F(}_UqQ<g&86Db}WYQC>9^zN+Is@g&WK;44
z(5sw0_!@(}t!+UKr>b1?wn9Y_<n%Fmw`U%b!ap!_k$iBDQ1&%-JaLQ~HpCuSMLbR@
z1YYEp!BwKsfA6u|0)K_CZQn5(8DDnpn_J~?p#XCJDBpQLU}K1P64FyC4ouj9HZoRu
zlI|&`411MI5WB)6Ojc|QIFUz;uy{NB7SMHo0B%#!^@a3Q++2sW=J)<IsKBI;^SrfD
zmb9<gPn0u0=$iN@ZYel+e-%FhCd0mVgnF0-)Z~aN<Y5b__UsqowKR&Ih5fEk<ZuPr
zjG{H~#Ior?ZR6}VD7^AZfPs?CXRtnM8f~m3hG{bw6i3Yd^WILUvrUe&%|T9CscCQq
zvYoNdM|E|CQLS6L2nnzVKz^)kw#Ycu5HSo(;E1vnG$^ykx)=K*UMXlG<A208Fu9Y{
zU}TFC&_~mB`6scM?@30{4Y8XgjK%;#Ny*2U-aUYo!-At<W;5|B9ki=3ceA<L;VZnw
zj|OhKSw5u0L7J)qmX)auEVYG9#DAC-foE-mx49)w5?1Ib4D7%5lgan9qTU#UCOY^8
zUD1T5&qy(wY*}kb^I}9efq^4v^tN~0(hu91JO(2Z^Bra{#Qk>OdmbO~==P*dFu{f`
zC*Ir0e;Y)8le+FnA?e5o&R%TVc)AyW-)`qh#?_W4H;EN!IG=&_<=UFYJjb`|05_ed
zx%nKq9%wI4x<g;Qc)pO6`lz8Vq$(M~#YUl^WI&QEspKiWovfYuI|`pL3zE6BD@AdH
zbTtN_iX3^-?6Rz8-^|X-c=WS+=tWect$^g(LU{xUA(>MvR(0p&{!Q&7)99E}R1q#Z
z)7@l!7Kf~pPx-NM%z^``X8~QnT+kyzW@3V7-l~}&k~lEFHuS09q9Y)DUq(nj2GC}J
zuTc56O}j!Lyv5!xHiCRVCd(pRGWq@iPE^(Z+<#e;&&`t>=$$UvFS#+m_DLxOJT7){
zdw3o+!69b!IPYytYI&{k6co8Z*T*Cw<N6##6$z;MXumPGOL7$yyvn0VAdyW+T0JsF
z)ziqY#dQ;kLTX2*d@BT(cnYkk!zh&NQ`-IBV0$q;r@RJXtN6GaIq1yYU8UFbx<#-R
zNs&S~$e)&B{LCdSog<BLql75TwNUD@Z(og(4|F{v;^!XE33QHtd7<aZXe2ObnnBM*
z3gUZXgIp*PUxW}m@_A}l4BwR7xryuxPXf}Dtvu&V7IB1~{g5FW!dta$E|`uTOgQ_Y
zM}G(5YE>jh8%|@xbj!&b7p0Z`*^Vaeg^@uVa0GU`iKp5|&z5*Vr-85)G<Yc04a`fo
z^fs~wT>WruR3xC^sBXgsg?9}QHpPLNn8fnwEaf9e7>n>v4igpV$6IuMEXpw=AH<V4
z#j?-&jF9kFNHU-|d0y@FII9Ag-~0EN$qMN}hCsK$)5ZJ}2{OICd%gt&$=Kz;STuvA
z!?36D<F>3B+n~o4aWx|3J1rm-@g;(_mN-F*09Np_pL}FWqNPD0c9U7Vz0VKqiCs0`
zdC3s)I;|5R-GGTm@o1B0uI122<l!V_=WzdH-nY7Buc)>fRjpf%R}3Vgb4`FIf*h%t
zvD;5dPp2;45+vsRzcwLmttb7OwfkBeDabXo&_U^~&&2-wxA&TTZ!qGm9lj3asm>n-
z;2{jjFt5FNd1V%<a}W{(uuX5RbF|53bMrO-L%CnM(B>~490zTu>z_d0=5Q`~vL-*>
zKSiJma#I2Rd-P+MzHa)5VYa~GJ9*)IbTZq|*KoHsEa9&wJc2Y1gWuF6o12y`|7gyv
zm)+T?G*rbkHgphEKDEVMipJ|KoUM?p_cO!u5)ty~Pk$#-Z@44C+m^ZSxRv!=;0xSl
zosg-%M1WZ##1JIBN2`VJ9Kq*lc85&{rLdbz*m|2Jd4G>PAY6=k$uJe=ih_T(WHTwO
zD-Q|Zj7yFFlj5zts?2RI5ftzDEvmoow>CtQ6ZRC)DX#a-=xVJID?NnQkJGo_+xd(`
zG}r*j@DkA&#-l9c=H+K@<5>uJZkU-XNo6Q#h%zVJk7?uqr6~RoahZ;Pk0)Cg?hhuu
zTZ$N-9NMm;!m|rJiYypVpKV;XuJSyKjFLc*EU?fun$PVnlZ%UCvJ?+E6p!=qCy|8_
zY|jHBWQI=(5rHwXY@$~uKfU*$_op`nStpxj*YK$RhXe~{-KWz2;~pMmkw~lD8<L!W
z-@m7@;2FjK3l9f9-f_Dbxn{$EWtS2>a(vD{&i2<Si+r)lB_+II3r!DKF{Vu@8+4;Q
zMIv&Muo^}KSlBOQ{F)k1|D608D67DlDpdjD?x8=-X77Ci3VX92_JT|1=jJHmy4Dp?
z;g(h20KF+)GRUcEFh6%=B2Q_vQbf65p?6-*9mmhTbrY4&|D7_t^Z+~%p~~*hE~b0o
zpBxbb%9EVSy+6~{3NoVcV$U#1sSv7NN1F{zAPZ+&%XJ+?d6r3A-9<PpdhKJ_^KJwy
zxA-rIIfAdDHKX`G<7%wNp56rx!V<Ed2+VAF{y3JBFqmF(hUXhJF4j#&&UsfGE4tpc
zf^B7TexbLc1m!7g^gSL|J>G`L<Z^<30efV^@4$C!ok5f+c0K}_Y|!*5p3wAsI5Ao_
z+t@8gcH7<Ng>T0(faA2DBmT~0CC=Xl=Fe*B`UNxHdqn9_Vka39bWfA*Y7h1mzWaSk
z@Lci~3zy*k3W`(GD<=c$c1IHCrZ;gTH90#FvEPld&3DVDJLgA6tK?{Gh72Z&dtff^
zL9NeVak2m~Ur8!PL*HX#HcinEiJ6T$o3d@3T)#>(IElft;B)|X*yLYP``uywGZwku
z#lU1v^~`o0vBDyiRif$hI5Vbql5liMx%hwDHmhU!%lcFuoa`poacm2St!6GuDp=-a
z6=0C8Jn4cWuO1Q_-GhlA?zjWg*OSUrMrld9E_9Mjnqu_B5ChII9c!=i6Vu_%-0k-I
zUzU}aW5e_Po32H%X#Le2s->ISOP$${S1pQ^IRSSl=7&10e_6M(4b0vcLJjJre6(e*
z^AK$N13J=f4D?;Tq{WYwAq2Iy<W3_j*SC?LJKD07isI4iY#6pTfZLJR@yJ6E=I3Yr
zJ)LTEHQ2E`p7nO(w!u;mqtecmm)WTVI&}xQ#nAXUSP5cvux%)po3@%m<S?;oz4o-J
zOxuqU;NgSXap9%Nc}t{xuh5F#eLLy?n3QPs;;U^kU!<xi98##J++yDh-t%LB!83+?
za5H|6?8I*Ocb=kT!_7%PSKR(4;0@pVy6K@7k{1Qe;Fa21TP2yvK@d%ZQkqU;g2U6&
zbi;nd(DLNfCH-kWoe^^~Xuv9QU<wX;6x@#1=S)jzqt`YtM{CNunq=Q{?lSDuablG8
z21oq}7r8z23ZHqL>o98)j`L%k`L4%rkM`Q4Oc#1_vXhMHWW|e|CU9+}MWyV1Wsh}Y
zE6Up@lct}!S;8^1*@wt!)>>LGr<WnistVAb{F7peem6L=V0s*UxbAY;Ia~;v(qio?
z9}6N#H2#S%I%^yrlIp3yV7qIhfTh1+zDuEisEL>34a0|Ljl)=~DwKUMTW8lR>c&xX
zm5{jrE=timI)7g+@$xIO)j#hz!-HG1uwbX>R=SR;aW;bJ(_S3q!%V_O%YX8{slvR)
z!U#q`-<%JR{bC3@-D<WUm51;b0~|_aM(nKn%I1sLM~97K$064*AI@(n`=U2l+fN?c
z0&P`Sl-XQy*uxS5!>M2FJ0iEifEypvYPTn6(l0zi5WRz>+&khxq`Du!KjIc|qT&f>
zGj7T*iT(L$gHhU2D1w2)d}gpur?<Lxn8GLDCuPCh_3gFUB3l!{M{k_bA%7xZmY&;x
z<bCAK*OJ(0bTK_zy>mLqZ;hmeW-f?h!(-}rMBYs}_~A6J#QN?JSKUa?@=u#atGmn~
z$s=Sh+4aj=;q5fT&O%>5?W$hq$CEIQUYGS}E+SBDASu<eQ)q-dY5;Q;dq4AAx!-Cb
zg)(@oh#5H`W_ba4Ml#QF#Q?eNPYF4@G7-Mdar{tGNCKU)<mE3?B%c7Tw-r7NrMx;g
zkZTEZosV13`=-!pBLxXRB<D?qxb>1s+ch_H3xS&FoV<;`V}p1x;iB}!O#qimEf_*o
z7vA^STOCz2syUd%728XyLCvMezqC&y(75bsC!O;LGJ^;ZGIn^tkT@ZWaj_76<1In+
zb*Rc?i`@W>M#)MjTBLHiQLhg$m_ZZwudv<2YAl!_oyX~|WfPm^K7<Zg&23^H_+`7%
zzGq6=sS8h84BVgV-IpjXc6BqAdT;}q^4^?eI4Q|~en{v)J?V+x*v1n78bKL=iuJg3
zmP!%0i6U|_QNaFqU=_dC^^UUZ_4PA3mdH(w!u9eq&yv%&{q=-o#WQWA<6`Vlj{S{0
zf`dbjC1(C=KoiZWW{%80VAvhc-#<C~?u}Lgs*(vR{j8@;xfH<^GOFc^Ej91mc6$H4
zGHF4tQ~MEldbYv`u51ZA?ysp*-6;)4iGrPnbT`G?D_`7#Z+DhDv2G2JZbgXh$FK_h
zyVP)g287Jb)nMpWvGf)fst;gJUQi!({2e-gpnWMmGy>mLBync%#Fv^+{fd|97auT`
zX(sDGsf=N9dj!bpteR*bc-Ga&6u-rvkE!u(_byN!=DUbvY<$(W&ptY2elyO@$vjs#
zBxQh4ni?}PE^}7I4x?$v0?X0h)!!w)+c=%MW+A!9;t$;^)6ZDU<HxJ~ZDBlztyqUv
z>-iZ~!6iiS<c_L8K8zQ|ir?^ccJQ99nxCmmbExPcMLj9aV6EzJO?QwG>pQ8Tv8<#I
zA)2BWlpj`uUbh_bHzpwnzpM#4v+)jg`_%?4Vb4y4Ch0m)1AQW0iAFuLpg=r|4ZuY1
zE{v;6@nZh#8}3J!Bsx0$1AaxHHVZLr&n8byVn2Ry{Xt>9rNEcHZ;+7MCI$VzU>*BQ
z;YG(13DB24SGuy5a2JoF#}5c8=8!wEQXut*$M=DYcAB%>75T|KBvqssm2K<uL{1&-
z?e+bX&=zip;OUf_IidTVf^pLH6lm~&a80?mSFbAWW2dv7Ygq2{Cx?hZ68d9o;T4B6
zX@~!1pL#*y6qJiX)Oo{3G`a;!`1w=xh;((Y84$Gujg;!{oQLb1rMmc8b>B`yULW=x
zKPpKE9=;CWQ(rV;>%bvJ9k=r9pw8D&$jpP4e&#iYK+PT<?j{fId3oUE%X<!ZW=*jj
zl?B)vCbf-WIed16u0EYL{P2XH4r>|JvESfjiwAg9lI4gFS@at`B3>D59-w{{lXiD|
zxY$G2v_(B%@q~FT6A3Kg`vH{yW$}v%5|BfF35g?@sP*_n0x%Ry<Xjh>-MT*7vcyGL
zhau@k#Pk26?k$7jYPUt*5Q4kAd(Z}gG?w6jhG0P(_uvvFxVyUt2oQq1ySuwL?(TLv
z-&%XsKBxA*x9V2iANLP`n(CfC=i76PIo>gzry5w5npSZ%t!!s_s>x#UO>FSN5bw1+
z@OofZp21MvW7oOdy~lppo0d)315b%bUN#vS_1JcU6sybWBv}*Hs!GuQamzLcL-NeF
zB;){2xF_C3sn)gz&}zD5Xy$b%^UKgAc-Jc09)TL&RP+?#Yh14c&#cxF@vDAA$6=rQ
z@WBqon+7%uLp&VS0&Z_5J03`tZb)fIkBhJ~4E&_5BIrZ8RCgtRH-dNm<l94QVc<iR
zJa6d2h<!t)Lv6PoEq3_NibsVPs2c6IdKWMe<g*&PFGJUjvs}|Z^j_HU{i<b<FxW){
zy=e3bJwjSO(<N{yu22xaXnP>Su|05`W_v&-F$7}!_X0zHbsu9J;iG4;svy=EA&}9G
zMpuX!pJ<mc!Kxr4yS6<BDH|LC#cu9zk_XWatJu}D=uF1TDQb;V9BS+Bhtl-7Y6EL6
zni1H?T{mkZ@~4ak87T~Xyq0t8&}ljc_W24I(e!fE5_eVeyViU`qaFdj19Tl{qqcJf
zU>8Y70S0ZEixke1ND`khN5}QQ&N{Jz9Jk<+U0&JaCsxx%9jHJ05wY!423F75NcTpE
zJIwtgRDuD21HqeB1B(U9^znu57HbHPj-{yj%q8GtP2Mzg_c)B0RU)jToR18MjUsi|
zfYa{`kTK%5pHRb_H+H6rOj2TaCa~Bxvv;Pw3;X3Qp9a`oXY3mlul;7z+33Wj8-kS+
zGyK2?6%_IGvgzeN3liTN&8E;}j(+HvMCLG~m3dZeSUW&hZ@HlUxsCVn2i4#``4k`(
z(}wM5!Ks~~vU)%sflfe}=LUAM+lU4D$2Ey3jA`@E_I!jG-#Bk@ejt9ql#v5H2E_cA
zX@R1p(JkFos^vZx*`KkiB+ns?c)8MdblhWM`ZsTX_=3g&8U*ZV(U59tw_iqvNX&CA
zJSltMi<rb}1XCsr?feDpjHzZWjAVwy0bdpU{{mRdu{JJhZyRXP!g82U8Z6<z2s^dm
ziI>I=^bqkT-W;c}RV;k9QI?(|ffl|vddqDe?J75CbH(c|I}1v$E)%3yv$6{b))b;R
z-0V0xG_cr8N=n!uzjBTilXs|N!Hs(Dp3jFZpP#l|n`B73*{0?`QLtDs!H;jl52-J6
z1e2^;+^BHw=X}|-)#nq*)iTTNPN{H;q3L5)GKWWX7J>LSd(2KS)OrzNBw++9vY8xl
zoIfYb*jQV(?=vTEe&|s?TZIfw#Dge<xh6+%hjim5&<6Na*Uq!*ZSRqv)_R5}R%d&|
zl)eAdO-P|GhyZNgPn7onBev(B@mk%ruiqwiiF5&mr0qnLixCM@MYK-Z;EJ4{hz&lC
z!Z$sm$c)uFzUP?Ne@la6bgR`cQ$`L;+9&wsgT_ijVydFGwIoYbj}_Ld=$R*r>x!Hi
z2!TH6snn==RH9lA=Mzs>Pt>V9aX_Xky)!5?FLsZJ(U3z;lt-&_iL-KUh{icr!A6D_
zWX;{9Ev{oI=G`G?XY>G(?#7W<FKM(D(RqI0N_RiEDtN2x#saO?6-XAZiMn3k#W9Gf
z>>Da8(1+%7;ZcL39WMr{05Vdxq_$(V6;i|7ptaE~w;lbhVFlMNHDz_j7$#KJ#8Mg5
zdSipkPuECsG8DozhvAt&J}KUICNgwZ6^@Qm+-(mf>ODs0>DM=_>6|dJ*H&iV_cQ;&
z^VL@gScr0#ndpD8hN+Eq6AAi4mEL7#*|hybM5M8k@wP>u^`v3o#C+_z!?+HD!kr$-
zr2lnrfrDXe<5{iKqv-L~<M5T;{Z%QHKI*e`z5ndHzG{bj^@Ab2v!pdSL${;^gv4T*
zEz1qZ90T(CrlR1rABN~j+L&UplTvlGVqPJaLF!(g2+ce9gRAZN$U>Uh@sD*4dilY~
zcQ-zAcSW$yX+JqbBn<ob!B1QxwWi<-BY<jR+BrhrT+W1bG_u*7iFt^S`^=8xTT_qI
zwzEK2l(V)mK9nlc5&PqS<b6=0U3c)jj}MHa*Qu3yXcGuV<J)Ef(%y=pXx^NfJ*0ie
ze?vi7flobg>Sr4Mo6Fs78_GyOX5lD2)7DWnhe~}!p6t6H2j{FV8ylQT5y$fmwwQjf
zt_%f?p7kD%a>cA<?ais6J`j1n0y&6!D(<7ftPc1(v&YQZ+G#4@A5#nj7bMHd1RYxG
zlhEC@zWRPDYBMK)b$!%3n818cDLe7y72;fe-O#7~@W}owv{ReqGrLf9mij$ub0TYP
zcQEVzoUGo#3VBVVfnv?W9RG{wZBeQF<y6!<4aK8F^U+tEo}n=>lGcZs>}xRa^)Tyv
z%NXT+i#@}aEX$o>FdbqfczL7>b{}v9r}65%Sj<;AlrgiT-RRHl3S0AQe!&@Ttf}YI
zlvoSc(NQsUQ)*j>jNkZqp7$izJWgS(gc3v^0=gt<Mbu};8v7SSrJ{7hODmtV9b)G_
z%AQD1h@5l}gGLk2j=s*__pm=Z#gsBWxm#AhBPlhWXCvb{6)g55@W5d^<MF@#Vk+xG
zFVD8zC?{zYI?mte#iR%UvS~kOcNpw~*uK#T+DqTw_S&7u@JY$OUr&Q1FUSDuti#H7
z=fw3O{9YAplpWXFgVLHU)irJ!m-{B9b`Lbl^*o^DFSNwNjG>0Qc9^biJA)2tZT7VY
zJ3_?ROe`$8%<|;Wu8>cC;>w0J@VXB~SG{9DqhWqz)^#jf5Lh*H@_$xfHP10pC{Jdw
zJ8VEDee=VadbJ+jfuN;Rmtw<`3K!O~kwu4x;*%^ax)Z|Q=}?oFGJeI|GB^IML)DAf
z%ouye{;f)5N9S!t>7C*%^7PvWzSPvzElVte(44jl(cs1@?p+n`5g;C`1AY@P-?j_N
z4aFWbbr*?}g68B=f)~HYvU<BPME0F=9{8O}e@tIQHDv_3xUc&Jovr&}Y<dc;zP69C
zJd>iV-5hR^dFwWB&A9BfE}iX-wFY=S4(k4_saZ%Uz-Q}9_3}V8_41+^ed;ygF7-@d
z{z8v)_hc%(aUgQB&U;>JG1p{2d9!o7c_g6gXqD*kP!!w{;O@gUrXCXE{90sj>38~q
zlgKJGld!9^?2~!wH51NPRZdR|R5zHvi+i*kW34k-vS53=mZ6A7`q_9FUDi=a;Zs+n
zcHfS_-qz>(uYU~tN?cz1YYg9CrWQGo6Mip}keu{Kr;@BzvGN<VBGGVIYPs!TRjWE7
zZp+h8fX#385~=&KHCrCueIF(B8fwkou>OMy&&;DfcMRV=I+-Vqx2aE}XdJ%s^%WGu
zo;zmwTZt(U&I-^bSDoOXc#>RY#PU@@T-xQNEGgZphv(=dUWFtyAUP^s|0+z@$-2+6
zaiTHIaC~umrn4s33}grNIUKwmJTa7p5?;PlnsC<o<BO8Y>lv1L%z|le(^LrOtzeho
z0SE$8?+G+QDX7kYQvAjeol4mV=O^-0AL>6`VU?Q<7-0(q4MOSssFjbdL>t@ha@9i<
zZ~J0gDQ0%5?^wKk7X<sblV0wOC6QtoAmjX@7DZGPG3y_140fV1fV`~>Q0gcNYj;rV
z)4d2=RSF|~&ynG8L6#g{sSCjQYTW^zgFeF9E^6H9!PxV&od}#aTdzo1Gf#-L@M@Ni
zv?l9wKxn{AdMi>z)N+wH@`w7mF>$m9wtXdc)2sqT>HJOLUt!KS{)erk33>Cj8M+^B
z9$RkpwOq|Q8V7S6kJhd~<aptS5J})NVRv{@=<pD3wAJ<7K(+$Sd1qX$@#N~utuRky
zwy0&nWNR2vN1-8MRsvv#7h=48BTPQGVm(QDDhhuo`Zzm@RzTKqI)JVeL0`d0G4Whv
zF6eMfSC%eTePQz37{gak@IYV;jnV9@J2Ki*?VBZR#;LL){t?pLt8Xp?3IgXqoM%#>
zfr1tXOfTAi$rmf@W`VJOMD^}c0rahM3pXSWA=f_wcnG0uu6z9<Q)CN)=vzLmd^*c(
z-fqx_B%Qxd{Fgx#ssoH;6lLUeBC&1nffjhSfXKL5H|CL&tOl_dWj7GYM*26P!37+f
zkW>IQ>Ofs1*!{L??KLK&X^{a}xa;ZgwM;9?MCrG9L~&2gA=rfPc9j4~1#QLQ-Ofjc
z(q;}2u_c?`P0d&d+5(5MMOc3Wf8@PixmzS2)0D$4sWim#G|GZDCg``^if6?<HytrP
zTTHAH!EV1H!^axs7j3}K)WY94Q!`er+M<5wir-eKF;x5V`=;Ed#t9v>iwM9*fPH=X
z=f1IcK$9#$IPU9bS)V+Ax|2ctu3`=F9gqGPu~-h~{KN;_5f6+P=tkp_z*jcNRfEH|
zi6->)UUZ}TeOd8aPqBI9GZ27|L-|GP0QIO*8(OmFauoGZLXQH)lQ7AeGoMt%Ja>ZE
z&l98_ov2+PeXB#V9)TN7RC(0bltmUJnI3|Et(mmwjz;5djDhZv&#9SRMwQtnl@{?N
z@yz$`s4ZZ#xvM-Eh2G65d}yo^X1BPLMFiv_e!!se|4k9I4?#m|MH}UZ3s~Y(URYl;
zd`~?ZY~VBZDP1{mf(<;gR#)dPXxowiTB$!*_VV)q;llxK<T0Chv$E}uw@>aFf@<o|
z1spm3Q6?gPLGI>5tTuiyE;$`trEIQCrRO+K<)6LgE2cnjtWVWHu<q?>@if?D%;^wS
zWPF#KHR$>-d&F1$GI;Tw09|5I{gr@y^K-<Dh}knmt#mn`22sDs3c$W`{I}j}h8Co)
z`Uc;500oCWltk9CR>8pbc6y}gi5Ov`4YaFLK~p3ZIB4tFb8)mbxW|&caVb4Ujw@>}
zTR6Ue&8ra&g?<$*PF(a5?)0RB+Z655spCwKfT3pQbqKQb*rCuoZSs5*c)r;tE@<+A
zROiPtfq7V``z6n3H}1x?@1jMX^Udc+tu;L+<NJ3)<UEPaOUa&#i-HwzT=d}v2Y#iQ
zPoHhtP~Pr+;j=*m0PXosSR1Z$VgZ8J^Hfhyo^0b8woBu;SBbX2N%l?=IEmu8;F=5>
znbX}N6YmJ;vWfKud&kq5{e+EVTJ8BwIcXyzMEcKY7WlI?5CI9}x~|YBP`i!0ry-m1
z0c_gXd~w`#KVK}i(eq9V6SRq7I~m{SZaIECV@IRp*o|ct382N%G;XwL_8xBZiw|mL
z9Ct=RswLa$iO@1-+FPh0h*vT)%=Q2+S2^;K2|60#H7p$mO&?{KRmf$*O?m%#S+LvG
z*$MWHg+#W4_6_S@!%_N*)$4d1@&5{NtgdfLXJ6NzrH)^=EmIUN_YdqhBQJd4`n}d_
zLmKkxiHJ~4({L-i1RX28_tdhJvs=1;3~Mc5kVocz<Tvtg0f<RS58TRj!jjRlT;3wa
zZI{r!Se)YH4m#G0E3(1tjA#WL<xD&v7h8KP53yPwVA%}ik?#qbxM54|*QB8;JBC5Y
zO>so$Z(!Z(U^28=$9%p4Wd@93<_tDEtK3Mu3s{8`-e!Veqn6Gme$kPXVLakOe;o4;
zC|1Ml4ijt@J}`02C5*hKACKBjMaOPWBwlaG=S1er_m@_K3fjEhd|CP69gq*(gG^*(
zZ~P0AzckN9b`X`_Hg>R35ex5eFxJZvU18MsNpg_yIdroBiph;MlUz`ta{AO4I`^lH
zVuixm&20#@MDf_in{&<UecAkTpN`JW$G1+(>Y1$(N>=8dTx(z|xSO`&JM)F|l-gi8
zm@}`x5YGg&;^?Sqv~SJp{EPM)i!AM1ZeAXsv0={sA;rgRb$gp!L#M8`*S^>G$JI-d
z>KZ#@A55;KkVGah^FGCC69$F*vBe7EmiO%+lme>6n3~ELcciq;FOXU(hzWO!IuaS{
z)$`2_Y+6<g4iGr}`=MZMc;o3S%%o~iFOu_1@Phz|uF`GdQ)dlcC0vtKpHB02>#JzW
z<7WXeG_!Bt+EYIi&|q~RR|mTQqIA(z*U|QS{&A(uU|aX$Kpt)65$>i=*FvI7+*ma=
zbH+)byK0AwV6D-s@Ybfb;2k$%^FNZagKvN88O9wT!AUVPg9(vv$`pCVH7p9)OiEqJ
z$6aLR=_A39Low{bqS<3cvW4EOez5Z-UO0me_*!Y$jc$Z|TqNfWa<lD@=_XU(2Vr#f
zb~cljrBmp;F^LAL-ha5sa-eMLacil!8#Q_<A0B10yG!qJe`_4)V*_3b{@ym;+ZVqn
z5sV4FME-nCA?d7wlMABtIw)lCr)id<EFGV@LY;WNmi};DAZLAkm@ev6Jo*$dVdofd
zno{^ujhAEhVB$Pxj9}d1_Z(YATZoT`^DQZ-#2{|Y_=0Hb!>NhmxdSp4J#J)&(8iC?
z6L*(w9*$r=RcXDHZ7VTF8*8J*50Z_vN>1d-+3_42v5Xs2uS8-}x*cD*Dnr4=u?e{W
z%{1zRZd}NLiU5Qve)p$|N5ybn&8GOgcd-NX=}wEpZjtc=%!j#qXg_DRP3l&vKcmhO
z<Qmu8@?|ft@2V%t3#34&3PDe6$6KWcn6fFJ*t-U-qy?m5phWhx^`CWqn{gI3-0Cuy
zW;8&n51Ir&({=XJS+`xd;1_knd?Ho1Zcu+#+hA~#Wk@FiF^|YUzQmATK=(G#uF{J4
z4+uX>Nx?iLR9Z)l6HD%FPxW6HD3XG5Rix{G*VhY~rem>eDBtg1$m_RxmnLZo_HNSA
z;y9E)yS^@{L$T+;I{=G6=68SOw;6QYdV6e42@T6632!J;AdWDP+ZU=kR*bEmZwBF(
z>J_}cp&fM%61`oX9Oe}xCuRxH%%*ZEuR^&;Qg2TTgH+lq8aAsL9YOtAQKH%2E!l7z
z`7eAa9d*rOn=$tdRfBvUIx2bt+@y<gg^~i>#Hb-TL~?Y^<66C^E5uzLt#2<R25D`o
z&#o&Rt~3)%u@bp{(yK8-^ytHGUoCMm$%a!$ru3L1@^|>vTOL?wvC*7p0%z{VQ@MN>
zl9N(<f-X42g%&UQ7J8LeyExg+E#~5LD#q_ItzVX)&_gc4tdoEAI2-U((M0PMPD8dC
zeDZMIJ{zLad{TW$kBTHa$3Gg3nE2Q7__igRi9FDD^=(bzdm_>GY}-{5;w`d3_%Td3
z*=@^FpHL~o1Vhj3o3uECsgjs->jc7lMp5N$2B`GaLS3iKIgz#=NfZdBbK_-!3~U}X
zp4tSjM>@PYnOnwqNWQ;TgayNp3xHB2DA&ZyS|^>RuQwF7kBMi^_%pYYgn0i<jf=0G
zTTmoZDI2LECg3R(s+%l+T4v%~UAGm$-X8Y0YxLvI*>l|ZF4;A%r+<Y~6Uyn#y$Ef8
zMxQO{=rosp#Bj>-YRCNzoS0jSf}Le}EZw$jc#<QaP=(I<i^L<56;=;P(UeM?mXPtk
zBl;X$4Vv5<b{)Eu&%|u~nV%@OR9HA8AL~T*)iF$0xV|j-_Q?%KWJz0mRUDO!eVKEy
z1yI{$`(CMI(80-5SBkgv?%d<<vs&5rStCx?h=2l?o_%IrU-5Ch8s*@Gd(}ng+;RJ%
zjFoiC@@8=^<CWJub@Iu84_rxHJzX^y<x2+<8O;<{M07BYxp#F&5E?}*yamIL8<UdL
zy~H3rlWM*cTi*^N#5(Ibzz`p{WL^(71B%+5Q<(4skqpD11b)--h*K4k!9v&3Y(>tH
zsU&wMPB(ZTn9>Y`?{9%pmhKL~STf{>Pq+;?U@G^8?(8oKy;rGx1#(MOMwN6|-%ZP#
zsSLju9D}vuKHZR}zgHRjr9cSEj^EaF@l>>Cmu+^NZ<()rd&*Zk8iAxHms4TCJ6lef
z1N9kf%r~H<b;SadWqYTMkCwRpn~5m0*JywgVE9uUN)2l4Y`a!@BTbd%yz6gly`d$~
zUP&=4O-qz|iWf*dB*(;Le-J~Y2sTTa3QLFWn|%55QhE9t87LGxKub(aJU+1y0gDi&
zE4147>U|jIQF*E<IdS^BS{B4l)h%AxR!8tWs%XLK-)1@Nu&ic@9ETQ<17_F`58!7p
zL)RuQ))Py*nM`-$l3R|?;WRLB8kA1z;9PyoB6`{(^SHZZcsv8E!F$|e1EH>j$|ek5
zS5K(SAWq7zrv<~%A>UiP5$h5^J#@xmw9{7^KLsqk;6QuK1GWf7PkNWwO?*~qB!JDG
zUp(D2Jb!%W?oOYy+yzsp^6i3@EwW*Bul}X0YbrS+nyBOK)XXD|$j81h-RKTR-9%i|
zXLG7ok41l1EHZ&nb0qDvPIP>ngMxewm1I`n_n6PcqE24q=V1JE@9Pr!3`%*P2^eg#
z3cUvmn?BCLLW2P^jk$YC77BIYEOwfyq@GU7P3mu(+c|V`UyFAmXLGOB2H_ZYuo(f^
zflaym1z5UffO|KbA$fEya^e$8B3EI$_2k4$@pSdS$f&;xJF^q^r%8b)676qzRInb;
zY>fdH4GLc8Hg0?Y!7^_XkiQ|eM&QV@R0I8u^W0%{wa!=)Jsi@QNsyLoH5GMrvy|;s
zS#+&?hwrM<g{Ni-YN=9WngUq%E%}vjWrYQPOE~m|o8}k~dI>!c3Qx^MM3i}vRnjB8
zmxN=*8Bzw}4igUG%IsAgjva+<WRZh%(`$j*E8UEV44I=jgk1NAH!8#Yx}i?hC<8g$
zC2J}$_v-Nc#6q7|6M9Gtq<Qkk=cm2%@k<*F;FWwWr0rm=fImXr3$1!%YS?#dJ;nna
z(iSJu5u<B=AnD|e?5MEXU@EGPSj!lUWeTa++h%K<1|S96MA<Bae#j*vpSVWZF_?lC
zvniPaO9r8?Y0kM^x)a$xmh&)IymTcQL~H}e>+yI+#<%~VbGdw5HT}J^@!z?>ou&;Z
zg4IC<xvP(6(@&ALkefCS#A6n*2vdhKA;=@qxuDTy1`SP!(YwfAXfCp>%OBJ2<MqI|
znEB}Z4ppKmhckmf<qJy#Tqd7Mu33UhZcU0+Wp8imK5N4~)84UGs8S#hHKRy%ER2Sr
zrZdi<6yu9!!<+jpS<Je}Yr3iVS{L%rW(ute&K6#P#fZBeC!KW8+{uh7rw<lKt5{Re
zKyhpwuj-EKSjpfN(I)=0+(vQI^`_ct-L%ABfbc;`M??Y}3CfL4+od4bYe7bB*lRcK
zc+CreMuv~)TSVbOr5Q-unaOq+%Lw#!<>sqX7OSUwovtm~>}Khp%kDiqNfwq=99(YX
z(4fQpL)Rk}aoZFUYbrA|waNbUDWi)>a(Jr3KtmoUC#Kt66q@Q7n97%B`*zmo5Y9jx
z38o0=qqM4gtcL%D@{ZX*&-vcw`2DJ>nXwXkp5Kh3NgD}Ni;}00>*$IS+(~CW+B6$Y
z95%cS{ChJ{<ZwN+bmq0UKFA(GC5aoIFnE>Nj6)!%K;jbSOE7hHgCSt$3iFf1DND;Y
ztVPF9Pvv0lCI&Ku4dAfVL{|#OsV-wuS{G*5AXV)Q_b%UGa-7D)nPs&>Ws9Q{h7MKN
zhTn%NA=9w=E-d;3qeFI8X$E%z)0XKenPKrO(PNM!>f7L_?W}|>DxiGJwU(J+32CS&
zfacp}Mmn)xZ;!Df<#<10*;i8J8LL0(tXirDV$);aXUAA)lu-lMOrQUhn5cY}iXmOy
z#VnQ;V?0XJe^nLv=62;46*rpQDikELWI`Njl@w^KuL7D;K@pxhHi<_UnzA(wPc|Zq
zFt{plL4zN1uwt>dOvPjbkVj0gUiD9Ebr^leVNEnifg+40W7RcyxJY_f`da1;f1im%
zhtrx8t}(c?)#Wu`iFjB242aN(rhHsP1~~`c4!Jd${D>WhP9A7d2~h;JMm|^K&e|D^
zZJ+dI4#)+)Ph$zi&|5Iq+2!{=P*PiD=fkkb`JE_FKGwBp7@8~)8(!GkYsftd5^ksn
zIJgXYZ}@ChsVBG@8%e6h03u;~!$TGY#^OT%3&;50$NZLVmv%$fvp|hQk!<5oZ)l<c
zQmR3etJ5s1|3i+`*j1i4M@j!{ak?o8<z;J4d%<k{&E}GUJlr=+%Wj9XtgiKSJ(ur}
z508)9E3=9Cb51NMTjcfoyiY;cq98&zu8&ST_Inh=^$w<!d<|HU&a$4xf#^w;f%)QZ
zlS;|E%^g55<CIkNPV(BMlrv^TC+gyTvdc#DlZy@n*j06q&s;x`1T#4|dmc8pVSrzK
zT{=%T$XHar4P00wW1+Fh(hrUX7uXrQCa$cV!~{1<05W`g5b`XG5*hS8?F(>XN^Ly?
zHq7_X%7_FA?s#V+Ya2|wlYJbzncmVY>M`>Od5^mw|A&ZN)f--WqaPU&;}K~jt~)0o
zpHi{x=5EOYTWXj<6qCTaK$96ExsynoWjZuFPPoYhz}9m#lm~J0yxfTv948RaNZW>D
zl5sqx*+}hLR@m+5Lu-$`8sD5oG3EIo{m`Y59WAFNKw+hpB56cWSXORL>all{5#?Ud
zvjt1A7)hnblI_Z|t1CHSZrSPc4B&qb^3c*y=%=x=ACtp^47~?_2WNgS_9ACp@T)*^
zZhMzHzMS02&z@!Tpt2w}BZth>s`|Yl7$*`Bs7HUZb`NgSCG3D~P4!=z6;sIJldjcU
z>ekr%iWKlIBp<cihz6&4PYE_F;##3-b8q`c;<Ej+AW|l6o-`zA{{Vhcp=o2S)>`X1
zz;#`TryvHZ$SM_N9X=4FwY{Ja97JqXPpRrn#L~?_Ej!FtncApt+BzN0Z|7sNYSf}K
z%WIv)lS7qT8jkM<7jgycp?f9>efm<IA)wwU-a)udyTLu)I)z`)cl&;HyN;g`U^J(Y
zz#cbm<hOfGX8qL~Ja6}lh_QZw9{5bdw0~{}IDPFLd>i)xiR%yH=$JIVbGU$E=x9vx
z0QIR$_J#y(e{4vI@i{k7w<dsj#yfsxtwm(lVNs5z50I56A?Sbw?A;Oo@1+y|kR{1`
zDBIwitmrCyE9LMbe1-|i``6wYQF!eVdyd*(ok6uZUCj)dqU)9V3tr|FQ&7gp$Bjp*
zT3Rf(nE-A*San~Fd89Ov+q1^|M<^o)NM@y1b@evW0Y4$%SMMXDc|KLq6pbWFWXD&m
z(b+z~w88-25^g}gQ%*(?(4<_Fymj$eUwSYjkO?D<4akwz>Akaf0Tz|RM@?tBRPVC(
zMi1R?PH(Ry51HdQS#f4hy$#1-5Z#qk=cD8EWg)z+C!I)|{f@mU{?8zAHcgKlg#m;=
z0Ztib`DRpA6afVf{QwS3%4@sPlnrA%K*Y^vR~PMj-Gej>&NY^{BSJ!}f<7Pl6G>kl
zl`#_R8vhzBMETN_Ef#b(t^B3ITnq~q*3ShJ!jM5#cNVXley+@t$l;~abm-?nHn0!f
zA_fjaAF+^u3QbB(MwJ`$*ZAl?pMtAI!2l079}PyPDNABY)G@2jO*Ng#Fyjc-AnLwv
zywJvttkqEeCDGuEzD32SGc&UCNQcrhX(A(dv?!L1s0@viZNgp~__2MbV_1{;8U~W+
z+EFFP#d3?eI-4%j?_)#qMSQMx{^SLQrp>)$|6rcsy%A0>l!;0IJLdVMq$$}x*}6UH
z(>d>R>i!$nkC~!B-`lhH-UphK)bS)|;Pg_smZ(Ulu!%i)3rIhe-^gP{Ub-}pkO>tS
zaPY46)*~Su)_@0_7?T|Hy=Pa`b@2m{qvOylEuPg^S^E!vT*t8HV>TR~$WN!u2V!x%
zlM5uG+<<!E<M=h2PY6iTS2wp7j3##qup0Iy^e3j*5i9k;o3V#{D{x@dnW%iYP&)$}
zRp<mom@=i=fV#mJas)=5cDC`8Q)#tudj1Brj{8+u0)9y(6QR71-5}hd>-<jC>sDD;
z)kb|kzH%lp$z-xn5nfBnvo(yiCSRc=?BWtsX<D(suYS_{7<9LR@rp1ec*&xvX{v9n
zMG|W=9s_0zT5T1cLwGdE%H`L_cR#Q=xkRL*j~sctr6E9x{%%3x;@U1|yr&TusgY>+
zLs8Fw!MtrUG1d3oVj2{y;l!@f(vF(ti(zK|;qlw`AJt#6+^O>juT{FZ8b@QE%~JuR
z>-9vu+)geFGA=fQjB#I+^0Ds}Dv_)Pa8q%RxPL*UCw(lRZHvCW{(J$r8hPpPJZx4Q
zfTqIwWs0{S;GH8~V3!;4(kyC^eYL!uW(EPo7BsVNL?(O@8>`^*s>~%V0Yk1QR4Pwm
zr7PE`_^^Y&#-@YgJ6y_gK$Go0r)ASsU5tRyCSVLOw1<CcnGG9=o=6oW>(YW-UvX>%
zH?-V;a}C+{Bt5YD*q4o$|3ce5HDiS6Z1StCM^ac5V|$!K{mtB7gtEB0J;XZ%9iN#c
zC_sLdL(!u$w~WHC5cF~4ft9xX_c{vONjroNB}N)lTi4UoQ&U7xRH7heU4M?X69h0J
z;=+%lN9hHyWr(@(5qB9hCqubx!4IO_K9R`uY}^A5?-{ID@PT?@I<FPBdZ3*w-Ta3t
z)tuVd;SJTZx+;pb$7uH7oikM=)z#b$R;o>I=o%@yIKBL?#oE*<?MDk$<&OJG&0A1Q
z%8sm#FP$uY?hFe%TcoVJhrA+VgYZ1TV|b=9ZHHyc8m0mDM!nlb`zNCd{-MWf?B-nG
z6SXLcy8K}U$ukisN2!A~X9_&l(|fz@h-?Gq3`Q%0FX#BWlTTsB>2^S8T5X`SWXWY<
z#+G7d*o*#{Z6FTYM<y2tW$MT?$aY-ZQzvTPODO@G>CD>Gjfh7=;<c*i^lx`th?taJ
zMFr|jBO~E+@9xs$#)8Z5IMCMe47ttPhsjb09sHwz)G7D>DXDLG5T+sMDG`*aUq4Ew
z`8=!u$*E3gz29*)tBcNESt63LW(_L;iC(<%EO7c~d5pDN<Jxr=?8G!{S=g#`Onb2=
zarNrGW@8+RyJU9I>EFp%MVHiy_od{C4)@V=d@2S@HYL>nHigN)TpcnYpaqc+tpAOB
zE0z(k*+h}@!g50)NEQGA$9)R7u6S^)Pd@2FOpYB0{5250pshiBkuE5=(78pUxu;?m
zz*4n?XNuCoMQ06b737P@*_fAHX<^4A<RLKI;<=9-ku2bjOz8~xQz8_h-5VZ|JK#$b
zHS~Vj`tvfA)$c6DLu3Fl&x;ru)LO=xjJ_n=b`x7SZv&-Vx-lDF-QMyW<}YGyOj9TF
zKl>sFG1qb`D>YL|1fj`M$ukUQQ+d4ibRQe<Y$z7%$}0p!fatYqm}5={C_b|S2((EC
z6jmI85rKi+4+x!b0!87!<R8hk(v*}fwDwY$SR?x>hBj4i1p<VvwNsF?pa5vbl+NHP
zktS1`R#R;KrOPqHSDR<xg@lN3Mziha#867T!;#Vt1vY45g-C)+=E9^KHB~>Z>S4hE
z2{zzuCUhD-`-Qu9XW0AmJ;4&0&_~^!=mjnQIt#^R>^YZ>tDi2NWmpbQhTe1Z4txxs
z7-X^cDSdu@HAAfPLNCsG*TUw`GRRJ>;4bMr`ubFL8F5=2SijVnxit3WMU#yo8b@%{
zY}iWY1J>be@DIR(R=xcq<Yc9(;x+4))YSSJOEWc&v5&;Eda>Sd%GvUbgT6Mw_FGh=
zT|+(F%m`=6iOTRM<ZEgHh3+r}HK+tPFJeD-pVu6Bzxfk(fD7{WPdrx~7C2gvVE6b^
zdS`YmJnm%rA0zDrD;MT(pIbiRz;Bwr1FtU`eHjR-J8K-kjT87}iEn=|%pz#Tyn4eN
zR_=0cz#E{6XvepR5B;lT;1sBA@LPzFCb-N?T|TahZStf2IrELKV?<zxLwT~geb`|o
z+cl}h*mrRMsr%i^iS#^sm#J1N@rdod^I??>16o|vkMll85l)FY$^2~KQJhB|4=<Je
zAnFjc=Pk{v+q|nb5$jP)W3wt*YsdyqAq`r}!NtUbFm~>>08#xe*^jEN*wu$oL`ISu
zT;$P|!5%vr_somVtf>W2{temVWg{dH!f>7q+^l?YQr3YtC5a|^%6v^V!Oo+nT?o6k
z>wgyf>VGpug(b$HP2!cPR~3`V5>#(i*Ydk;r)$&~vqr3?C$(qQ!QI&^d#mN8aqzC}
zk+L1t0rs6G?VGUAx9gtIi0)RGj8SjX*-pz8tW}^YSECBNw1VZ%OehXLXcx*Iuh`=i
z2`QLuMR1dKz!cyP=9_Z?e8>-`4XyAe!(r^h!R1)3umH*zyCddVGW=+QJzDUhf3P0{
zsr4^#U_3ceN4k<6S~sV8Zp?iHWCTVo`e2)U--;&I6EAhce3U@I&=#VnNe|dL!IeP=
zx)S^Zn|+K123N7Wz?{yP4+}kp+b<#m&?cb5x@ih!LNgY;m1*)a4oo(_{qmf>2=oN3
z_tZL@>m4NWmSV;|Bn*z7Z|1<ztWK18*jA=sa&PZQlr70wa$cPFX2gwSkuG5?jp@~K
zsrJ-K3P6Oa`(!OtfZM-sKPg6J&!N`-Q|o9kN+5C|MqJskS#h%mnMMh6&iPh0<R=tM
zh{ofo<@=^8_VciOUinXej~X|wt*b2jT>itEK!niUb1&P|XA6Rt@)`n)Z=>r6+_w7B
z?S%vI7D@JnfR5kzr8tK4(IMQce!Vd`rcPcAU7e;Eli?w1Oearvz4p`@b?K{T8)hix
zRDz^&>6-3?%}(hp8(l6h2P9{Ef94?j5K>1cN1FaCntrYKsFaC^63W>qBY6ZdLrxF{
z0^4#!tQ&H7BKrV1dJKD>$*!7gmR)Ba!*?if;*9A>2HY)-F|66!A7SK#B;GyeBczPt
z{=||yr;}zNpw3V?s@zfG{)KO7%i(8mMvGtagZ!{`-ltC64Si>%%5AY~%%uV9Mv_wg
zYlHv=F-erUc74s~wJpfW;rig~;yt|X?S*0`8P6pO`eZxxhVQt)8dHWk31e;guE(hb
zyW@AVXoYvs$twj96rFUUKE1SbSo#IO%4EbohAqVsJxS+Ac=<fbE9~Y5DS2S%cciBN
zZNi1DkAQ`E9T<L@yrzgh&n(`_x*$qR%Cby`LCWRzU^nEUQO~-5eK{Iy3Q!#N=cfBw
zahn$D)NR_PY{$7n8<t%35i2Xmf=0z-miTt_%6H>X&3_DRfjn#W`lZ`{09U@@e#^Nn
zsLa{X;Ab61Mw_!xr7OE~&OT5q5=|zizXJ<s!pL&eZaLuz@QggPCkQRZ6RZ8GVKm2T
z2RLPvp{I7lpwZ_HQRH$g6`$a8TtBmJh9l_z&Uz2O#2>V;h>k{y|Ck=+J6bwoB@ev+
zu$hmGWQQwnbmvtVEw$?3y}nLK?scdCEAyVn7uHR27?sjwuHI0?izOnTAvD>`79ZUt
zO@XDFa{ULZ^>Bfr0XK->{DL-B$><?8FLoQ{)1n;Hdvy`GI1V_;U5y-k6%Lp<%T&LU
zS#8EFesA}}fd@wFn9%HOrgqE6rmCx}w>mc$4&(FlX15^fj)rj2U>Z)md|Ws$1AkYl
zZtisjFZil75~v4~D|#TO@O*wLD!}Vuur0_bfENgHR7&oIlyhbZh=n8~Mv&%@3vXP9
zRs~36qZN$<99Clab~4>y9v%?J*VZU_k_B@<7^J2V+w~GL+YS0Q$e$Mq__>|$ZEBl|
z+*-1foU|&P)afrjxxllxod~(~^*DK+P;-B+6DxUQJT5-W?=dwzhI1m%|KNgLx7I*#
zOi(QTsQ(PrnDk!SK7UWr)NZmq&ZsgTlCgAoO{n+xC>~r7suK*LclKbme%&o7=WZ-W
z=y+&vXg$U%yw-;LPx5mG$94o>(L^kpxmg4-j+<=yO0;$s9qu!5@0#mQgqsdr?_0v3
zTK}BzFTUac^f?2t*mg%#{Dx7Mjt<wtZgnr<cR8{V{4P2M5S_VmyCP>I(dvd2wi}(}
z?{b-h6YU0A9S;ebw&N+S_lG}dOop_};Xqs$M;i_m2j8Ekr+JqPKW1ljLoKKc&-QGD
zkH^Tahi63KRT1{G^Z8`tbiobCvLYF@8*Yy=_mj3C`&UA=I+uI<^ot9W@vBOdiL=VE
z@w372W_+g~)IImp${p&Ea{BCfUNl6ayf;&uu<cm->Rn3qS)hA>G#lw0!%4-(M)p)P
zxRj1i8t7(sX_7tPcC2voJ+E%)ln(ZKv061GU2U|3nN2-dExnC&NR34dxUz-cpZ5eM
z$Y$U$DN{GAQbLPKzo_KGra@8TZ{Oo0%g5LS#&qzuJJ#|o4dCLwW~R&>_l2_%%X*d&
zw0<&a-CGrQewm8c+dJrOU;pVvVpTY6XQWZ${=Ma(a<3UEu`P&>iu$vt38BpMnt7Qk
ztGK!h7|Uf;>YS=FA1a6O#)7>ll+sSXN5$q`J;RiCpd#qz(MoNsD3lvo<;}p*$H`#+
zYHYFRxKN3gwnCIu_m95{FPqEY<>~&eAJ3+9P3MwFmk`Ln2;d`6(HGYA3gPtI4OiEP
zvVm&#3LR>b5p$;er@WP%Ky-s<9FM^$Ydq=!l3WIpss$4l>73KizhHY00<7j&#Z#P1
zT%rIrqibvp0t-U-EGOY}E~A1`?!pX9jL*;p0QA9R@kxH2$$@t}BPkKaviOGEp?G{N
zN?NkaqaJG(3Yr=1q(wLd3gz^6jmjWhJ7I!HJbv(V%y$>6=AaIXcnqhR1m1Tg(q;V{
z-%o)E4w_39_S^gFu8aHXjgI__JELNp0}_t=X6M>}xsmiR{+Kzf?hn0Dxh+<aMB?0n
zqCLLwfn=L1f@U7-nLxj+*<n(@r~A&nFuH=@$rFb8A#TjW=Hf>zO~*veM)s0&E=Cvd
z>c<u|mx{z1Jd^v_*BaWrE6R;P`C2@2NlPMulMhOg*8D^Jf-!O1XC+iYUvz=QU5~9~
zn+uY)sb{Wt;AD$eNsq$hR0VwQ4<Gbbn_bl_jY61nNwd#I`61~QPaC-8U93t2Mk39l
z6^GkMV=V!l=R?K1O94{>N5b^}=`{2k%CV6NgC9<Q?T~#CtYpo@?jb~@d#T5sE6X_d
z6?ou8$nu%nFVxqX!&riTXBN_2(kditEfc9oLmX5(fm(JQ|2wTw@h=9L5l)$i85N%H
zkLRa-^#d?F84bp}F(8iRFoveyj3Df7TzCjV#g&ZSsxMEsuY$Zf*D6nA%b^k?;Mf-O
z3Hq!)AUo!YWc}o~*26p|MCM@ffzmutmRg!`>X*WBT7Cy_3*BvE63QX4$KMmJ>BNcS
zy=DWQO?me+o5TVLy@O;e;?6g()P3kuz;>jDqRaTu3+433DMPvGt!Ke-Jp6<0-WbnM
zhc4NP`yzI!o0rq32as;Vy@<9){@BZPTjOJu;B7a(<MTs6=}7jMX1KgebhXivEU!&i
zFUW!J_03vGZj|um<9qyx=Lq(TTzOP0hbTgAB`+zMIq?RRdP_6?#lybJ)<F)!8l@Rw
zP{OgAnl@17WH!9Pf>eMmV(;-ELDos+-E(LmeAg}sagObJvcoTzzCDHbVCQhnz@RhW
z2q}SLr@;#+c&{yiFUBz7oHCG7KcqK2flDSU`ys}!hrRW1>4#xZ4Cm?$_Uh<RS+sOM
zpV(j|XksLHcl$vZI(7CrJyUb)%c#pzPyg#%vJO`QGy-1eLa3$ZdW%CDPsY~R17hVh
zUPK~G1dJ&olS$UoDll%3-!y&#pXGBYymx7!{R>xzs!0@`%}80bYEj#6UTz^Rr;Wsi
zUi%+hR*J?t8cf-s(Su<9YWrBdCWowuwS?bFSe4c0@*eMU`JRY*cayFNe|>n0RpX`j
zD@w&fwd>u?lBe$_dn4j*%LSfG-;7P~<=Aq>bJJ;;a+D{ATB#S!sMm}uRPs8vd2uQf
z<b0GGbW0BQMaz0NZGQD=3&nVvwSjazo^%i9*_sb=iSz`CTzzui^P^~&dO0z9(ud&P
z<>sqx;;f*YZ;-r<C%jHjJPF6TOw8yuQwDk6P3~&nOO?GcW@_EMSN=^e<8OaB$!6JD
z1stRm)HR-SIY@_}nR4uvE^%Um81g~O9+5Pi#&okf-dJN6&=6(foK;fqG4I<zLrM;g
zc52r8N)f_SI$*Gtq$NJLSwI!ArhWCSs!eg@YT+(b>XA$khfzRa_sw8W7%78jHEH9S
zXccQyn}pl48K*aEsy^F~_6cce{8zRZ{U34I5QgyB^Ko;rzA*M(47(V&=AF<6D<Nk?
zW&u;#Eq5ZTK?UKgzFI5x`mxS2TK{CvZfqD|%J$Hx(mo%xIvTanT)ISYmf!ZJ$yc`M
z1Vfj7`Ur#MgE-wo(z!_Y_V^KH`<;iv)xG>l`}J6&>CoNhf0U>CNz|R@yeXjG64%ZZ
z$;PH8ZOFY@Z-0!QF4TfL-{f3&*o5!sZHuKPFQ%8X859zTRyH&Asq;m(L~}cz|4bOC
zN55&0L+01}M#K5ikA{nR{io#)>H?BgmJKLbEe`!K9Us7Yw>m>)UVohT3Tynn^q*;m
zBGM?kx5Q)_j~I(huqVJdTS&~1S~>qzEOQ{9jB#SRP!#f%OWM11Lc8XIJg)y>C&LiG
zJ@;__--KJOE3giIwXjp4JB|8r2g5U=y<g|kRgT~JXnOgDj`}3(rhUK5tOAq@^@(<i
zD~cV;&z5zejNS5IN?B*L)jspH{9pep#{6EU7}=}b-0-(j>|`F}$8p#hE=&VqLyYv_
zA2D*OR^}%;rh$LlP@IY%MqwCC=#l&g1zb^mY>gMq?$!>8?N5qh?8at{=ci*b&-sZp
zAkGZbyvaSk_H$V&Yr%!4&626g1yE+5@%w&U=*AB;B_{}yeYdtH86v41-;1&|HNlx$
zMMrI4EH01V3i!jT_zJ?Acm?^Phm92d$)^Z0?=c#P|7&v#VaRNsYrXk!v{-YPyd^C@
zUE3HX%_G4StFa9K5>2G)aW4peK_66X?PI}T&jbTF4Y!k$4dPdD!7>5Esq5`0>73hJ
z&X>dNraMF~ndl$_()YJ)sqR70GB<hD)9n|`#}4_eto^>qPHY^;l0EjG7*@LUt~^5C
z4BFY?@Dy!<Nr4GR6WE;=rjSc^SAOED2<czHpe?Le;cEHgqw6T-))-&zsGV<)7UXwD
zRR1+`vjSBkkP=CzTJ{h_+t}$0egHH$17t9Bm!UfrJ_Ne%6Z~QapQm-VY(tc4rjo}n
zB~Ffy_quON*^VfNb7*uw>aqmFu)V}`<b_8Pls1!;IxS2`cYeLxfe5vky^hWmf6~%g
zvSYFlO)myXk>$m+Q|rE8Z})+9d13hS^UjeS{?<6=kR_K7Q>?<${wIIP#nBtN0-oIS
zV%ky7I{4$`V`+G%cb_F1kpPO}Qu${#g4ba&Cs>jNY~cE{<X7vVzdi-AzfcMl15RV)
z1gd<-2cyd169Rs{9K$VdeaQ5{Xepaul^X_+vy;Bm>zf<A(EfLyn|G$+>d*gN^BMog
zRLclbBg+GC;a>rEU9!b$b8}%=GFBMTA0#SqB0djWryZxWq=%*lGbl<zgQ+>RT@OH>
zB3i)IXT!>8y*rjgkr{#U&)WG5hE0|kR!LDBg2Bl<fHFllXJ^B|rSyNu^5-K;zPX^)
z3>Gj!$R8iRun>_b5?^R|Vi5%)Z^kf%|0Emv&<Pku`xFU>=KR+j5p0KDg4GkyurIxl
z%HsHEyrB|m)~)-^LojDzurNM5D;gY!&(=F)m2oT$8_|^BP_lKrm(G&-cP!(Z{V%@w
z%@D;2s67^HzW9wZk+T>>6Q~@VY})WI7))RdB9#ft!y)^BJQ@F|^Xo6J;lEy-COTGv
zdSk_!a6{a)gQ1i1>11I&*fLz=;ST2=l)*F!h|%)!(u<1eF0{(|B2(J=(md&c(wQKy
zU%Arga&)~k%C$CY<U8N0-0v?qc!hEQs>Y`LEnB@uS3e~^aPb#R593M%o>g6NT~<l0
z!M5R0bywI`_W#wD$O}#?(gulJ{beFU4I9}$ER9fsb5z6GS<||6=cyzjKv>@79|6i1
zHQBZ;^k4n|rAgT!!D*!<8s6!`24H*gK1G^Lra@&72`RMyXus5d<&u&OQ2ooPrGM3H
zW+`qH`&W{Z|1U`j`aYwfn7x_Fznoo)gn{oROpeZ)l=ez7bGekEhBH6RYboI1T{LNG
z!{3XJsf@{1osYS4-gOEJn?|zZ<NA9Npi>dh&moBw<HGs7r)+>cnH59r@PDYmBFQ|Q
zx&AI6s4J_Ze9D|GzX@vhYPo&FYON>|6cqUkdOZCS4CG?%6PJQXdisu^b&NQ6=nXxB
zzOiZwsY%6d+JBqH{;I*mEC;*#)}DpIhe~Ae!8kv|r~Nh`&;$4eeh<0WqDP}9sw#P8
zPz6n7wy(6M^<E!uxMuvL8T(xnSt-CGqWUX0*xdV{GuYElHkKCEqqb3I-H04kfvEO+
zUvPdyS8>)k4Ec|sM=+_cvJAic;R62XX@x_Zyl=NPwZle;06IJRk6~$APO4#l?ChpT
z{~q=4`TV!UEVM@{xd>;1<fn}Xz`bZ|YL^1BEKc7h<Nv`4mRHeMNW5D6XGMSPUSioR
zoW11W1!`W3;BP%w=ruiMHkgqxcenelF0RU8cPjx{w$p`4bJejxR`|NG^H`<+u(Bc9
zOSU$$j>gkJq}cL!sec6`uhUu}$$80fpSc!rC)kvPO6WEXFC63F!|9O%2jwkl54EyL
z{~X3T;@Uy}<$xp1yAb#9O%<&?{93=g)*4<0c)q!>f3*Q=*v^r6@7lOvTG$|$Juem5
z)y%B<L0wrkx&d?m$)TsJHmA4@tuQ*9=c@A3FJAXN>$N12rS1wb_brcOeY%oXHb9EB
zz?ve@QH=FYL)7t<WT<{^f50vxD3bbQFI@lm51}M_--n{N#V0I~8vuw^(?S2OnxNVr
z`*_^*jNLzvteXyGc1N~Y+@Fi<VmEFt=REx7u+{wYHvg*iHVrEs;}KqVWV5X~gvpEx
zks_f7;;24X5E=<N`2cjBo}O0hJcO>Me+kZp5kXY0|8{?YzAi*)C-4fpl~={`((UA*
zGhxfJ@vUi+MIhKM@%j`MQU=heKfN#3wj8TqP!g6DEPyU`%s!%;Stau*eYs>IAWSJ(
zjzQK%W_Rd7e1@16;C|J)j%c{1OCXvaK0U5zFs(?vq8IBJZ<Ang$e7?JD}}ZBm+0)D
zY|w2O_gwJg?%plYEKXH@+SS)qgCgbmT1m22um4-P%Z2%&A8WyH>CaNjV_dzJa}D)Z
z3i?;5FYUnoX*1j3)Iy@dG5*;x2VmcG@RJj6KXNzp#J%z#4O%iWaL{_6(O~i4LO0*_
zcfmU-!W_7sZc|@_Jq~5>c77MVhy;(dJ%+X01YLLW7-~IQW0jWr!(rq_ffaPOH~rm%
zL_vy?7J}6X^*JTsOLg%WT(&$mOpu1!H-~+VapMPkrMAk^g!`SrN#*X?|N2;DAad({
z56vOtX<=O?woWMy^!9-AyoL`|8A`qfEZBJPi!8DS9@<Vth=M&aoKBF&22O;;zKb~t
zovjnDl4nE}@kgbGEeFs=u3$i3fNeslPtbKzICLHnL|EF!*q-=UdH3-;QhaRNZotDB
zY^T`yh1q^8Y;b;gU`AEYd0DspOfG!Si0NO-FQ9Jc<be1;>*M_%qnNViw?jsnuc3fL
zMw^JwQdr;reHnhm^_>SLGv7CjF9_8i<79R7N_xPmjNGd?-9hhFGKj|nJ{VG3GRiO-
z;g7HR-;$`U5AT-3f&x}NJ?9{R79og1lb7p;-`88@$KuPk_I=l6$ab-I%bWV&u?1EW
z+8x%m(Ld=wSR+w*sKK_XgeW1M^$fwf&mFL!9J&_>`F!1&31(&k>0Kj%qyAaUxz@lz
zG{Y7C-+_@AOI|#GA}bvxzTORCP!vU8>@NakTv~Lb(MMPejA@2ZsPbV1Zk-MHefc*Q
z?)c|t{9GMOgG>$nOfConyX)WK|1q$n#erGWB<bP;Oi1U0F#d*!eArlqDcFHHLn(VR
zd!i`NLaT>ca?!}e_E6XIodR^|99o@CC5hFS4=3<&7A1}B4QPd>Itb{UtjImJ-uc&U
z?h~}IK|J-4E2wjqao&U@ifWoa^f#s*1Ubh46J4nPQ3)!Ve8|(@D<mX&D!t1<qWbnf
z$CqS&Rx~BE-ZyPDo@&sFBiEGC-ynnoeX9y8e(tJ&8!rEfze@ARS0*-`yZ*}$_Fp1Q
zvh6)-bfkX*4RJe%O3P<r`Kw-Osz%Z9tT>Io(F)KYEyYhdK!x?M!^f!~Cti!?_`v&X
znc_0#s@EUdMV68!^gv#HmyX#tIzat5lJcEPL)*i!YyJoKm*C?B3RU;Se{+BRkLU5<
zX~zHGl~>SY={x=ZsFc%}|Mypv*V!4#Alr!?zByj%0$U}r>yq#E20?=@i0fd(mZ)eQ
zn&RYALB|q)6T~t=wMm@hDV&Pv1aeH+|M8do=KA0BvcFgJzh3<RUUc?<rThB(-T&We
z-2QKVqRL5@+5RUWB##DccoZj{NGjdPT*9!ltx&3RG0r!{*dKGrwBp(=hYAez5k!MO
z>;D;u&v>+V`DOtl<RQWRp?7={S1OE-JdIfIzJ1%T-XChDjM&e~g{sI9pc(i70wY1(
zzT3BN4|BCyzI=I@8y|AG2r<n#nH?^JxdQg~WU;@m;2bUSAOM)+al|Z@;{i%`q{9V~
zv1EtP2jh;jlE5jJ7Fd$=MTm)KD#?@`d;9S9@9)CCeFxFk+Y6LqXliaiLqii<S{mK4
zxw#SPbQ*JKr7)}6J7ZcJ<7jS-Rh%)2K*B?a6M-BqLWp`Ihl>zm+?<RKm!AGCp5NDp
zeZ4v7ScxS9#DYY{(NYQml<8oJCCq-J<0WQCCf~l|aIr*x45MEXmKG*~Woe*Ewv!MO
z##E6hg+c*${LgmW|L8vK-t%HuYSbA2aT5~hWEu^PDKs`Vqq(U8O-;>~=$vW9?3NT}
zw<geH!lR`zhUP{(Wn!4soIo-mfg;32A%}|)qMpd%B7_(>CzHb^lPloy?H$<NHGm*U
zm=Tl!%$SMA6NrV;E#;V{1f49Qv&B*=bheb^K#3jE{;^~&T;PjqYR9BqPug)&8aORw
zU9+wbqOMF8nKCdifUkdVCmwoyI}RP{tLbPN3v|XLlSwo-q^q1UO?GT@kukGcEHwvy
zno>&)%?&<EhR&EY1&$Enn32Op2vJYua1la`o0G-ivhBrgJpBAY6fGYl6NtwHH-#w1
zg<0%aEXA;O`%XN&`FR}Z&)`rYh795;I42B+R}txW5zWas+GjOk)l1IAX{%31GGTq$
zbw;?P80ljDvrDswa7F{rMz4$zqHatTnbOzShcAC)J05@f1!S_>u=MyC={^a9I1(mf
z7zxwZ(1^xnI%1m9*l78N2DCIMF{d>Vt{cP1n7~EGaH>*MgM^O|N8?1wlNWaGL(<0e
z@xo}^NP0xkw=q{3tIE4mm-lD>cgmEPS&b=|7eX9Aa<~W~#?5qhxRgp|-1pQ@Y~6nd
z$wU(IcpO18FheHkrV{OXaX&Ua_yl$gnqf2lRHWy&A<;SuK}$1YDK5;CbdfE^VjlTI
z7KKbdvVDh;>Fz+`z&<Q(O5mc`ti|#b%e>RYbQn5btR>QB?{JFIaytpt9U;VVGF2Qd
z2M%`PA8y@&EnBytP@pUK*cp?27*Q!6V`NMM>4r2~ni`!G#!pjfa?Y5hrX=RJCf!;w
zvs&V4Ovf<0CBXc-DQAQUAx@k;DV0jt^vE-4pSK_^89zIA?7*^R%fj(&zxW>=D$$WY
zE<d6?Jd(h4qEluyI^9SJas0^PB7_(>)7jyYHzVi=4{X7~-VB07;8T!5!i<!?`#W&g
zPai{9<3h|{emWZ3=OburKsksx2MeQGO7XIvMiix3In3M9^7-r_GMxv|`@&Yt>+8ZV
zUGfW9zGA6&x>z#%27JlP1$9@a%|HsDO9*l7OqNWcL3AXZeSQya{r-!1Zp*f?Wc+xO
z=O`SdQmxB$#w1b+q>^d3crTqWbjHk@)q+I}oACNqwxYFJZ?%OuQ926OfV%ggr*O)`
zQ^S(+(bAa0)6Z_f(kh3`NQX+TJby)HVJj@0)!-uOgb>G%94<nLaWh>VE`?$V|M}x5
z(AAeWMIvxhe>jz>gff0`_a^Mbe9T#OHX7UKBbM}0EPkC9?_`M_Ej+I{S$MQMmArGj
z@LqWgcI-$0Gf&}+QW00Z?Ja0&NIHj0+Uhk}YBycx%mykqLWtvGqGbvlEljyw&KX6u
zVEIFj@4^p$dJx-p?g~rC$5Ca$Q7Vi@mbj^tVWO3lN+q#q(WyB9>;-t!#Y<#li5bs{
z&`~1!a^ItyC(Pl(UloUoyB6jviIx0uUQ^O!LrPIDLev2{T!awgW;!}tils8X@xzDF
z*`G%c1kR{nR7+1!AHMUW$B{hkRhYGO1p>~UHvNK*7I$>XJ5xq=xL7Ji`KpMQqV-Y8
z4xoR>cBG$t3h#dN6<E4(0n*lWquDx~W;EYyn^khU2yt9Yq)aImi=di9xiQ`8AI#x@
z?tL1!eEVSpi3T&Q{AX%uZo!(<PsMNk@)<7jMTnWqiE_APG8x?e*mIK_;X>u3QWk0=
zJa0E8rJ<og4i_Qnz*KO!Xe0|ECY<m8^fBz|=yQ&jh~2yQ;Ts#bp!Mua(Y9m_lF3HI
zIAg%7IJG0Jnoq`%X*6S{8R%^RdYWVCF`ML2Lkzv?7zUD7hucK6i8W+$-B5wyLY8Y*
zBfst<eDTij<C*852j7q9twO<4m!0g%^DaV&sRoUp$l1cRpBN=~w3Hu_YSlSXI^On7
zqxF$aCGf`ApN;juunNV337$~K<#JiX;#Oyr=p7-%)W<ncjGa4nxFd0TNtEmt<ymzK
z3w;V}@<#}9av_I{5Mn}k?Ah&jeCvK^Je7(?luWVMwfjZf`OpEJa_%pndG0Bus07YS
z;v6oPI4vmK0`$!`W2C`Ht;DT;B5y`Z!Kb912W9IsRz@ZP^rm7M3}Pr!U2%>Ve*~v5
zow^VMmtBaPp7=4IdUOl&rq9sf!t`Pm=q^aX5n`&r5Pv#b=%_84+!)I!^(N2IF~XZN
zK1D?N>ax+=ljH4!bz<>2UUBYX6bjr$$+zO{qQ(@3pAh0i;@lmSHOH7<a>lA*=k}|T
z{Er{?!!Hfhue1?DoK$E^kr302=`^M2P~QN)c<VjRqDUl@ZU>LPz6|bqa32<&`vx@3
zX#)Z?OX&JFqoZsoKg$fQCMzq`^HTQFDt4XIgk1Cr^TQU)^<_mX%UNH!SPTivb9ER_
zD`K6VrXu#W<j`~Zi<p&v0Dt*~x8Stpr}#y5t!<Ot_l!m$X?Y>U_?Re}a_G<@w6?ao
z=n(RMzwlN3=k0gbaE4e33mKYkKc!+-q)7PId03mUj6`Alj!L$6n|v-4o{XQjTzM%z
z^5G3Gzh}=LeC$)-L1Rn1>$jz)39mixRJ{2Y&#-)pt0Tlr<wQ;?+Qc<nPFWb1j-S@1
zG@g3)Ik!_0B?v`LWy+8{`aFMC%B$)T9_KeFHKj<1I-w~=LWq-^J2w6tIWv~{UZ-pd
zO)gi!4}bDJ+E=ebL(?33PJp5*7?$Wv$+g*O3J7u~#5mQ*>@25(l<hc*YuH7zxC%g`
zTt?bDq@$%j7I)5;{&WfZTl467OBP7Y!J)*<anm1s0|SG3`g2gUl(YNq&5m*dA;bxx
zP$+mK#1cp6x9|9&JD-l}+qd8CqWkzcn3#_e*R*PF=0dts$%Hr=h{ky(*{{Q*Si*GJ
z56guRCl&hZE`*p6cJJ%JGduP(jLxscU_U?o$zy0<auJ$Z7Fc;;7L|9ll#)QP-3${t
zU+DOtqs0ytXN&7Gq)Hd5WUT`8oJK?#-4et~=uX72x3z%ot1_;RGk((Zu&rwqZvMaD
za1IxHG#5<MosS`7_ZLD;9jc9wkxmRcD46_0+(U`y(Y29nYNmLYVytiNtc<B<-Q!3O
zC#bx`B{H~D$rNU_B;{}s;zVQPvDz^*-t^=%o88fVRg$~reyWSZ^01)#oIgT{lMDTI
z7eY)3|NWDP-J4s7DG>+uccHs<8fLYv@Xi)GSLp08DO8?o#z?k|c+QgP8gV*YoYTb&
z71!S9tMw3`I!8-b?2eUGHUp=O&e>UXy=}nNv;RC?FQ$1JzVqKXY<YSIAI(i$qT^*>
zhPjiB9k=3rSH1&pSbsfk-d^<uPGzR!Gatq#d}=*E!#nV)d&44eOwb77_^ozcIEM-y
zEy*NO=_DE((v}*~kWM3=O1f?5<H1O$i+8BF_F)>jRwG4@80U;R{xq5$l}shjHm6}o
zUQTsveEzEYw{7EdXnoMBO}(D^q>xQwG=@1os?z`Y)c?UBf8vi_Vm?~XyE<_?5syoj
zEIsTR)1Q9w)A+>4{{T09><@6`AN*;}KB6RqIJuC+MF>%Mx_bJsb@xGPFLvgYhesdX
zgSJKIAQ3b;XA7b!LyT;(d^~68Rvs@{;*r;)l!~L=7@*jkK-SV=V-o%81p3WD$(cbF
zIa#WYyV`Q-czft<u~dQQ_6((#HTcRGe}IzR%SE}^WA+u|$XWixGm5c(@8@udEB_qs
zkxqt<H~H^qSo+|tctPLINd<>5|CdHik|=tG(Jbk73QbLoZXJ|amRc<}+Ih;#U9^kU
zW2)r<ne0TW|7n)WG`LDg264=9Ynk8(7n3Q@QD8FV$5l^ZGR2Rb&tYR&G!xl)(>q6z
zA3JgL2SeF%)27jUX5u8Fmh*#&>$^lSU#rg1Qf9DrA8x8)bz<o4lxKW8N@aXiCmU<q
z+*KQ6AF6RZtTUFs=QaDc@hZerK@JxoMBVw>6Pqh<YpFmSJkX6oYK<92^HJt{mRvZ+
zQhb&fLM1as1}$Hrlg09Mcrg0KQX&yYvNefB(vH@IyAw6#OK2<<kuH^-AvS1rx{^s`
z;(=d4*V67eIqbWp%GttX(vEp%9qD;^;F(5jetH|qb}vpV;;yV+gHyueQa_emgD-#Q
z>-gdApT&mdl}|s-@yec4^wxb8ci+y>_jP>vx}}KixE23;?{rXD#aM`(72esx={`Os
zf&|j3G@2V5vG&y$;o~>_9zOk-{~I5>;bU0)nzd+dYIN6GuhK4b)cErtOwoB93)<)6
zt?S=_Kfd9&@Rcup8vpele}lWe^N;Sx^G|>Bcks41|03qMw+(AI))c{iopiJiey*0L
zI8v!;G^NO7%2(W&GnvA*K~DlMzV2$Qpm^M|2|wCVEkAZ)TNn{@@w&B$os{xaL=1C$
zR3$ofBV4{l9VQO$TIEb5`(W8HXG<we|37>00btir-T$B0woBSw^<J!Ixp&JJ$k+xP
zda*-r0uGRbg!2Cd1HmNJkbnuHg%Se6U=vJlalsG+uE>&H)w{IPuF6W<-e3El@0mMq
z@2+-NyVBd$uJ-#`&(7SLxpVJ6YtB3Ky)$z)efHpl-cRB?S--3CJ?*}$=h$qqyL-?6
z%zdA~PgYxh{E7VY4+fZ$7R)$9`}1%8_nyAM6JP8p1`%=wq2NLY$vZD>*{g$xn7FMj
zMYeA_B;}RosKJT5*)0%VVj}TU9Z<DpC6?AfRZ0g`HoHY*ty83fkiw#<6m@2#s4F7{
zDJRN!uw6?`+b_suB(8&(X1!js4xnl$CgtFp+FTucVFv*#i40_Fh(r?-DOn)D{K@0y
z<Ye$vN&jo?#0g`C@KdJlv^x%}^qK-6ev<2+E`h$E;_kcm{lU{JA3{&9wB6hk{U?HS
z?rD^BvbxU;>Y3jZx>k=cgjqZLbr58UIda>Zug-~R3vT_q{O*pG?*DPXzI$&!;X2(<
z^80(T7OFGg-`Uq^q~U}oYrX#8gl8C#0m%(UH2CE`SSl1xxY;e2Uv;Vc>7W0p%$PY%
ziVETuzv(aDBv)L0g_WZo>i1Y46b`Y7EM7EMKJkx#C*S|ho$}6i+$>jKex6iTOpsKn
zOBxy)q^qk#CX^P+B^ND|zj^!3@}uv4UOx5l_sWvR^ZIVHpU~I;^>{%{N($Y^xub*b
zzWd3?`}ubp?i1Rlb2H6)JdF<ZtsXXIfc_Y^RgZV~HP_dB-ir%b&zAKJq931(c~{Ho
zd9WMR^2n11TpoDhsi2LOa@{J8df8J?U$)X;yZdkUHqL*>-EHJP!;tOh>$3{m-`stK
z>{7Q)C#Qm1nm&K-x$8^viywc>0@5~{wx6E^2e4FGQ$f&Q7KhvT-d$e~F4$c!{Bzcz
z-_`D&FZx}5t9~~JEV%Ux@_T$&_sbkvVEs{~YJZKzC!+oSvp<!6__$WRPwu)^?XfH9
z_62hE;dk_~S0TH1r=Rr~9Gfo{IzMF3K;J$UAw8ksLI}w#bq!5Y-_mA|1jwY*(%e2x
zic6=8q;$}cR(C=}!9+Db*vl46i_#EUG!3yu>y#A7q(}!sMeP}hr$k~9V=@|NT#Ro!
zw|vOWXu(jXKvGgysNe5@(TWT==GIH#!Lk!x^jBO5K1gaXil)e8>)WKWGZ~038QVCw
zBMDV#Z1L!wPsw%u$q|n4?RzS2_(|@g{=w1yr{ob!JEtfT3}D`V?*W<TpBkz25>cn*
zpI_a35K}F8-}#fksZuZ)Lmj>L>JR-W_e87vY4}{Z?dv|z1>Cc>{qDZ+xqtN97-)qZ
zCw06&j)76&Aie$GYMHOjmtD&oFbv%Mz(w!nYvFrzPsXgy3C>fmzf*yuh0iD(nq||M
z6WRU$X0H9)d-MlC9pc|Pe!=V(d{hY0sP=yiF|`d?E`(VjFL~(=5{IA>bZW$S)BH<r
ze2JC2O?2IPx$}d#urML-{o6OoSHJL&a>ZrmNqc*{+Ja7LYipD0>T21sV~1?nvPHIU
z-)_f^jg9uI>e|{`S+Q)Pp7#;?fA9JWy-vJG`~8L7z$&nfusMlXfs_>CZySB?*rT6)
zN><-@@_)ChZ@oqAMVaB*A!<_|wX_#S2h$%t+SfkY%ccYZ#_Bt|`)c<rlfL^gY|4rK
zxIgB~>T6+#bb$B7+T1yhKH&tA`D!;;TdFrbZKYj5^mpN&7pz+8J|C@Hh0i262=%jP
z4)mBs)7y6Sw!bHQR=w;JId#xAb2Cjs;e{R5^6a+#7Le|%4vf@_WlP*~sIU95dG8_F
zxaXj3(y+DaP@i=ypslkG{dWq%BHSNy-_?DAzTrNH)z@Ba@d@N?jH`pb+k+my!23-c
z_O{3DgW8pM^x<<nDp!a4u^!)fyPm5y#(X0MB5dxQHS)-l!9BcLeJe{5av~I52qAf8
zSJgp#qHH4{bslODH%M{m932D|n$QB#1;R?ASj*e8Zoih4Ru4p%qJoGNYe=-|z$qyb
z*SwgCEiPbYiywjE-A5VCNa^J|6MC(`KBfZ~tpm#z+=A#p2Lb6Q9wH+z2$5K!-ojMb
zykVC*Il%^Y8aH=B)fro?zT<s1AXqRDf`O8A>U$A>lKX^vlDkg_6;^lEElv~(4VJFE
z)(y5~)z$K1OQ?g<W16lGsJwvk^;=}&fochSpaF%2@ct_pSXj0G?zuNu(hwFl;5Y?O
zr*h&;NJP4BRq&bU-{1yKYjhyhePiME-xxR<C)`W#zw;+@w>esVKpCJ;UT@K*`~Qs-
z!v_6#66=%rY~8Y=?&Ueymn9yHNqI#%YFS+m`g-M*$&%1=)C-^I!{qWw^5uW~u-tUx
zwbIqqCCOw`4jnoqk3RaSJp8-g$x}~nkPX|aWb^LBvSIrHd4AJ&S-<{i4eRCb;ln1%
z9654CUUbbR^0hB~R4U6S_IaIf@cXzR#{Mn1?^q%x6H6i3z-WywR)6U4<vP9Plm5F^
zn{u6rscv=%{%`ElL5WS?P@D2rh$2JikJhKWfTDeELFl>=lKT@-diP^%aR_~F!L2tt
z8<#uB3n8I<?oBUSX@veRvz7Y!xq(<9u%P|9E7cC`JwN%BWOJX5pGDL2v$B6RA^Us6
zXBDzb9PphcUi3JH(9qm=LY{y1yB(V_<MwUpyDSKLeAa*^cpnOc3V@keK_BgNMo4H6
z7$<6IKUtMK`_y>ir@`#n?ta|e*H2u6oD+C*{W$2it8R9-O#9&7KiKc=i`u!zkkG&L
zt*3jR<g8}&eZvz%#xzw2kLch5i+$Xe*ueuwrKqS<B&}aYDfMSkSrc0#T{`gaLJO7>
z1);12VvE+%G?p60A<jT_(Ksx+z$Zb#um!@)-oL3AEMmfcI?l2w{5r~ULQ7bLL765I
ztgx^`o_%_YIXani${eD$F(|kUp1CFvfGTws_UWMF(I=|y*gaiUFd(r1eZdTp9uCk+
z$T=lSSO^K8_QF}g(g45zihq(6oH2O(xqhJG8_;WF&3868XbPUJ^|%L*-izL!UtjK@
zBoB(*XEayl2UDNP@L)oPcJ_#N<Or4rLC_5ZipIJIvjaVeNZqkIXMrGe*m-Il5NoKY
zm?)qB>_5otSyLpHO4$aMk3II7tXcP*?5;16#^M!{tym$&Q_q#ssY@kZzDT-?7s}D}
zblH7eWapj(vT@@^I}fv73Jaq0rO*ANR8F3hyGCEZ-6v+cAXdAjHm4w-kVz8@My22~
zc-+%pV6#KAYEzzcB5Ll*^Pu`;Kd4Q~?G+Oqu<7~XB|5$P@z8taO1bV@oD~QqUig^j
z#F0Mf&sJKYClFE;2rQ30u|~4<uGRtC9Es@p`}}9)2YCH`R>8j;GJKf$ak>FNL0W%V
z$mQEL+;wvKzASWnR^j_(@Lla@dnwwNKj|NEc*1q94`WsrW|#!!r@+4b{u*;-K_C5i
z-+@4!9RSyc^PONJoSoDDtUeUZoxkd;ZXbk@J{Zg2@Pv?22A1R;J>F=73xE^R)*6>Y
zVxkEx2%@2&P`{b5oG1`m5JP+^#mp86EnN^;#Do?sDT=2eQlJ6i3-YnCE_{--wx80l
z^WAmMnAtciqJx`=&1Ny-#Ro0Jz%3HjYvVr`>2aCt-q)!2uC3|)<8NqBrYt^d$vO6T
zTIvTCx5#aNdhfhB;xv=cljcz9e;P38Ilcemxu-sB<hyXL^m=YEvQj=iSaG8_y*I<N
zjVwQ(+r-k=eB*DhqtFxJQ26+Zw61?TrT6l&@Kd<Kko$~+WddZ_@B<LPG{?;p$x2%L
z=wpvOCfGjPk5Le(GFf@zQO&nLj90|F^RSetFcFhaee}IjQC?={5KR8?$Ro0^p+L&!
zTq;wh&yjRTyEJM3f$Agj!0(=w`+u`ue)Z5g`Q?L8$d0{r(kzuyRhN}Ld-q9mbF&FA
zogJ<6sgJx@3b1EPaG$+{C;YFau&_|3RFr7>7<b1)Hsvwc6sQp4r@n*fkNu)HC3H@=
z{Ry5lpH4sS#cKUKa6Xn2`I&!MGS%<QkwMx@+i({Nn-QY}w0X1LY()LM?g?fZ&eyh#
z)B3E)=@1q@P9<#Gy1mD7e=}VAoZS)}Bmb<SkMHX5+^^r&f$&ka-#zT<lU(2OOYeG-
zo2?tn6th%_;M%!azquJ}Jy|d}m_;@Kxi-{3xS26nKIxYet(4o|+`WGcA$>u?g%FZA
zFo0=jZV|kB!_(DSBJpTxuzyQLGAWS)?4{DF1}G_RmWu|Yv6Lv*nUxqsmmpwC5rh{6
zC%Qx>nvK|tj#7G^-S26znJw<2x3(JyEEvB)Wa&BR(PNb3#_&r+BvB&Ohn>KJC(aOF
zI+BRbq~Oy1L=;a}yd!}pp#}ywr}gcw4ub9VQk`4>KVRF-4Jty*j_&?J*pb101w(t<
zwEB*}&)uszExEx&xAW8e1ZwculBDqFb-Ahi!Bh3nGKahGb^9<lu%0{EtTN}&b&Dps
z&-i5Y_Zg{^cjBhGBp>9K=I9RwDCuNcHaxpQe)*H1%aPjS(v`|s{EHv|OrCrCIZ0_b
z>Y+Yt5`NzHmN&@kSyQclx3;#*6Hl&@&XPqkW%@j+t8bCE=2kg!s7`7%96eeu6{QK8
zP#l-ySVj`rl<eD6B|rYfA7t~+W3s;?uGc$ef(w=<#ba6dtJ`i4uGe!p5d!{=_<tuD
zc;N{9%gmfMX#_US^|Lqh-+1VWZm#darnuB8;%rI;{UO+YrN>j>!Su&L;+N<F8!Vkp
zKkiL#K=qW|Z8QJ6ZE>IUvIE@&f0wtFxpv*&S$5x+R~^hS3@uyg^;va)GJ*Xa!e>Q>
zh8I0fB}^)FZyuUGdrmG7c4ou=T6t>QZh3O+PI+R>PI-K@hE3b$@r~Q$u?^eg(G6SW
z(HFMLBhPJ-N1xj)k3G9d?)lA=^54JwoqY4>zm;!k`0t<nR=)kS-&nZor@xW!X!!0=
zACe#Z@?rVSBkN>;&5__Q7%6)CD4xE2l*fYa>KwTxb54ltkKD4ve*55Dx$Q&2o^<-X
z`}TW-Wj;WUZ}8X5&5#Q%qrUg2CtV7(@7|x}9u9S1AL0rG8tt3!cC*gr-}=VW^vB3}
zfPxDlB(Jo#cZy9P3CN^NB^D_N_HRKDNnlq?TT-M$lcXA=KzJ!qixlf{vs*Cp1%gXL
z%Mx0*P~#%Rnum2n$w*dqzqif_D-duJ5u4Fs8)9OUObvJgi3u#I<6{K9Jnqm!v_R@x
zbTE|8Sjgyorg5)l7(b|}3cdZp?Mra_PjNx_Mvh>m{H1Lc>v6MGY-2e%F2VJ$f7Scd
z*$=ApN00gl&MCnLy7shJ9h{GQu_u@=kEc*W`ovcSo8g78h4tWB{cP^@Pk`N1aoa>#
z>vi9c+dR+Ed-+(-d2-7EY+1sf=;t${*fMN{#Z!>Zq)q5}ZvC_JjW2yoKJ)Q^wfNbm
zpS66H19whT=FXlfFTZi64T2E<xaKLzlrNKXq)1v@+9W1vsjY3$e~S=c5!C2plM;_-
zq(JRUL0s)mA|}O&sO;N!KpuZ;s~l=BkYmS=TYK1a_wq~6wd;iM)dvIryezmxQ6gh+
zQyPgGE?)esy7vPio8m-;Q=V-W!fZ;;F!g@wJBa?+A3f?LxFtK-K-c<uKmB+}HYJA}
zP<dhG<U&+WJJ5ZPz5lN6x30LfkAu7(%a(e6RztGC<h1ZY$*BhXqeF~YDwu)S+}<T?
z);%L@)^CutPj9raPSfkwYZ_sl4_dC_DTK8eo_az4xb_8EgV@6J^5hzg*C2k*0_r{U
z{5ILVZI3+i<g@a^rk%lGF*1aG6#wu31Rq7et3L)oBiuLiySfTCCo}^rN9f;suC4pJ
z1=bVLzVBzZhV7a?jPZVg^(Qy0#^0;8t>=FGYq!Wk-z@_k{j9SgIopU=RJ$T0xBrXb
z_HOFc1R*C7QNwU*-${g!Gr|EK5X_y1jUrEtWA%+PrD9TWlwUB&`KK@5EfXhII#omY
zzyIx$`RBYspoU~4>XhiXV%~~EX|30EOq~<0hCGzbSrC=ZHfNHMXEEw%I-@Z{dqQO2
z#I&sWr{j_;)I1#oWuw{_E{A$J2Pa~qm*88_9b3{!w*(20O-uCX@8!4m-Xc*w2T!6=
z_0l<oQczIf>JUQuWw>lgU0t12R8&X`VyGU!=`HWi^<!Hm6miRUuz9Wt8c<W!rAelf
zl1^iG3l7~t2m_!Gz3**u$%V^I9KoB1b{_7MmTbAivt5$x?3815Es{)Xx+^Ii9qrPU
zOi3p;)YX9fo!Z-4>^?GPTCgumOeU6>%b&bxxy-7FNNH)QUF&#5yZrl?zk7m+^22++
zWcPpY;6eHSKJsHJub3ehpEpzf_Rp`7i4!LVwFnvC45yFMAFv6SsrI`y&&kxO(}Uch
zQ9iL$HgDN3v**k)_eV{EY^bi2$De%CnJsff91(wDkxRp6G4w<$4~})9W@(q_HW7Da
znntX7^XJZ#`E#br1uGWI#TP6^AsG_b2P*V%XuxHAm}&L_H`5Gz&YaSIQDh_;icP7i
z8d%kyKfn7?<xuG94G=;|K7fPZ!JsGYgMKX~BND+35)F}LIJj9Y*i2V6jTtZ&W5P^_
zmbHt-T13hkM4tLwoq9KVT&$r$Bp%0WV%;7M2zX6wTn9Tb^?EEI-v(%UZN%Cv0=^{u
z7iA`x-GbLxBTWbyJ)obW|N1`d`>!o6(mtC?AtWV*nJJovDq{Uxe?g3yP*Nn9U3{($
ztRRZi96l~bJ10mio06y+r{fJR+V7K+P9`O(?O=8cHq_0gQ#z>0NFo+h8xxg;hSI_U
zDJ?0KGQ7`OueWj6G3m-gt!;$4vnE>^?l&BQv5_;6`YVCiGHSoZ{QfP3j4__oe*I7C
zoZK#H3m=GP<s;gs|8T?A^5Y8^o>KVcf@$*PD_&&jA6>9ezB^~C{I+s}_I14=d<wM<
zKG<F^xnr%6OKVWu0K4XoEsZxDh03rG49;_V!ephYsz&x7I3yc4?~)fb?Qnl286J8s
zU$zt>1H*55LP%c0t60OEzD2TKIwrxuMV*6GR?}IDCUww++5T7_1d$~O8SLw#euN1v
zn9bjXJRMMVWF*y^k<LaP7}X@@!bL?=Sr(U~L{ti6c*5;P77^@;i&zi4g%)kjg684N
z5oyh~<ET1YC50F$=|D}LFcVxdP<sd=qX`HT*pS-?+XNdOS#dL2Y&@bMKWb$-2k|8r
zEp-BlR>13=J7N_ku0*u|AF6GXw3b1%Nv71+K)6Xdu_dea0CoiDA;zq?!lD8xD=C(;
zvJ#m%p+s6*JEfsr?Vb*P5U>&Nr57#FUEc@2J7<90ElVO%AQMV_86jjOKp*{1TZ?@A
z+4b_Rbx+BEYy98OKP%tf_=4QEaifM!^4(2a<nGPe<nB!f+vT3kJLP+ucWKxy-`8;O
z=Dikvu(?WpxOu<)Xv+cl(dKIT$>tjQ>6SzCv(1O(H|zGv(=`p=DA`Pv?%<AL6a2A(
zyr7Pm3#5^-80En)#HgdVcCdfSA=zJjNH%Pu=rVj9kh?$oQ+q?vK>NQC(i?uu6GHL|
z-qL}MXFU;Vl~iY^2`VPAq_dK0&#3XyK~W&In82cOs!ffOIuF^ThOVq+5IRv`q_ZU}
zZA}?zZc0lu6OppQn3QTLjK`!v2Q~@)-ivFSaSU>TIH7S2`C;KjzbNsv8DEncNjB3Z
z6(tZ_Fjz|4x@!!?2qB{b8(V0=+sC}fa$<n6;zQ4ToP6Q=%XEAKQ6?)#YLCk1LlIH)
zAqNjPn81=urlhM2LQ9uhR-^$!u{L3L0m}_zv6v*{aT8q%3L&}_NNI7gl$939)_o0n
ze{pLc1G*(kupx&Il0x@l<01_fYoeeaA(a)y6kG@yLC`;cx^t^Er@AB?k7`guP?(Tx
zf%aeZU(~6PjK(OF0zD4Wb`1YU>u2rBj*G1fyY?rdT86ZiwRE_Sj(m;1?a_;e0**Dm
zN1hA0SuHpZc|q)Fwpg8@J>NFM-l~IAb>N`w=dxq>$u>tK-K><4-#3`IfVn-J?2Tbx
zKXLyTLi&T>@`RAQQdUxEvqU@vMG#!t1WSq_wq#QxT`gHjU=WfF1Q!S|T_UXw852pe
zHoL_ME@=oZ9T`b>VvTiHl9~t6q(~i|Vhu&=+!Uyjlh8p6L>2`2J80j;7Q`mJM0C&;
zm1x=tFUZ5&j-shHnLRlo=~P-nMpAn35glj|LPiJhX)Qo-Ifa1zp%%=aZ37YvwmP+Y
z*EY1<j5h4|lEloGB$gv3rAr54IL^Xg>3JEAF$+cwiCa>n1F%9Jkd>4qq)2UDX=#B>
zC@t1=QWA+JtbJT(a>XQ3YuDpG!eIGgA`w43UI|Ue7y<ngp()wv_J@N&0zoCAeNg*#
zPCU^#qYi{m!<j%ji+-$e25C4LmZ$B&&RAJQZAQif7gw(NUS$nL5r`xRkx=k?sAGA7
zu;R+yIf#AQ*YoX$!@jD6a^%P{d12#rt*UhhA!i&l6NC_wKPo1cN?Hdp_T{gXPDn{t
zdy@$*PIM7zZA?pn4rcu97B9NAG&n&frl;ySNYY&{=om;+ok*ix&(rD<QVP_;!IGjv
zjS~p!{9rZ<L>tU{!HgFOEqLLo`9j)mRIiUTf)?quTV?+2B6UpCwmBz6mzdoUA!IZF
zOM(!dEn-1Cv4!6Gy#j1eMa3i=d|<$nR2xzl&q`ZIr`ndJo7s{=46!BYmO$zSVG|;1
zwAz<fO3mL~Dvz!{Pns7_l_DLO6%`graZ#a^6c<WqNr6l*FOx1c8(!2YDoWU0hwsDw
z4*UYJLD87ZnOP~r|4L{=h{xH1j1x-|L4eSLnJ(DeKdNah(~c<_q#=lEeok~j8J134
znRaA5N6XO1VUL<Sw9KXLToXn#Ahuw}#m!hjaK<JVdhg$o+pk6Ih3ngKKVk2_8fkCu
z)M|PzA>@oh!G#c#H}Ir(_O!{iSAu8O{3+7Wc3dLZG%gTan(8x{jf)4!CbnSHTzh47
zmq^{=3}*M50F%*tTULaCH0op`64T(951G)SmJBmm5F@Wp?*qoo>OgeSBZx3qt`tkV
z8829Nq_?2gtd|w%EpSVT(rF7Nh1^$xkkLk1yckN*U)tM40}}LoH9p(+)JjJumJcQE
z%|t1UA+|^)V>4S|teUT!DaT&5T%r?-C8`6ktqW$!(evj>VL@Dq3ldUXTwub>q=}^x
z#ULyg2w`awt{T1%&CZD~xUIs1tdwALUD_H#Mhp`nAe^Z0U~wR}U`9$V&%_d~tZ6Tv
zXh+qKtNqu4J9eTA>IL<aX^C_s?bywb(O}lc1vG&3oiXSR-Yx{cTsCrDA}DwDkY~pO
zgbuZ5h~bM-bRp!-!*6*)NM1Q-{w(ze+_YUVbym4_bW}?^*@1D41<Yb;s>|qrMF%1n
z*QC?~!P|>8zolNJxjrjJS_aVtlVvgp5M^u(q;88QF<S*yOlXNjZMF;2g_;M^C9Zjx
z-2zcXeI7;I&qQrGlBUe~Mbe#8oIWDwEShDGNeX+oq|#De0>y_AGFm_vM!y~C$BC%n
z9G8c_URT#(0~XjN?8B1Pehz`9rKLl<I=bxD&*>x#jT#vpG(|P8d)XqXf5|yozd#DL
z<<fXUN($mqQ&}MgFPbmKMVb%MrKnKi(U^|Sbnq2iqp8`wdp>+G-DGvFhW)3KoZUjm
z8Ndl9f%xHt5eP5pTp*ykLe|jUZ0U^8H^%|#Os*b09n`cg-qdQs3zjRPuDTqy#K?Ri
z`@!q#v1C#6)J`Cn%?X0b^T+NytB;^*s}r<$vY@{xwh%H(faxHFki38=wNoq0r7#iI
z0gT%;E*6W*gega)qwSbPGCJ&lU!p$1(Zfk8F4S{09l<go%wEy)4g{6DLs@BS&IsPR
z8iUKDW$-^B)Y!f&8l0HomJ8X;7Il~~o25WK9mpjJeufKzx>6GFa?hAdgh8tFxLm$G
zZOanyc9OIXw31!zGO3IkSrRf@@UK)J2z&Y)3^3e)!yS8S4ju~1vbH1$Pk`}eqR!3^
z>FDe<!3A$B!yZmawM&O?IagXPnk@xtISMrtLvSgGOKBn@6AKEYt+Z6C&YLR*CB;%y
zkdUrqM(tTVca4UIX0<S|HeoO<bN7@`qg9m1P;epSOaRdYvCTkHf>|tPH?VvM%X$=N
zM<8B6|LD%wOw0E+#<JVG)Q{0TWT=l~q7H)Q;73n(742M&A%?(SSi5M;9rsv1Wci`G
z!MTGCgpknzM-+sRyaAB{Z}6BmZIbPW;8}XnG-+zwBiN9|1Qrcl?IQKZ(^6Kd4oO-o
zY4CfwAPv!_?nu^_3}Ge=L>0_bv9}Cq70ht4{aQ5BX1SyyQjm$7m=f0-UW{>1y!D(U
zuH!@+Jx!gLq-0w5$?DZB1aBz9QX=f(5>K^AQ4y#46Ea%BzyV#hFT#Th?74y`!Tyb7
zJ|AP9oxAo0buv<3RwOO$U1p=wcm*_Kt&dr5U6ln=bL$1tIln>*^s1QI0<ony3c;n&
z#Fhz(gp|b-5-Ti{+C?)YI<Z6!*SFb*;r^P34%ezd3vRL(7zSb1OnF&?c7~8Mfc8>#
z3LvoPf%a27MvM)!A#A8Wki{}+h#wl`7=nk{l^|b@hO4J}D6@@n(Ky<%sk~@ae*&9;
z<F@*Jvi7kDWbLE(%TteOc=Wy?X!?=+WR0fRJo3LMgg*{4tbO9wb{z}uZU`Zx0DjXG
zLh=fp*j}<?u{j}lwJMl0W0FLQwn}H)aq|IeS&xRphf?MkloUqX(jtg12!ZI*-k6mm
z`!mu~j~Os-bKIgtM2a=wZH;lvcInd48I?Hpc2Q5q?b+hWoVXIqs_B4Wqj~BKVTMek
zt4@|qKO}SKO|>_Sq}6#!rc*L^N(rAj6EX&{K@0{o!9WOaN3(sHGT663k1;sPW^4xA
zwjFz{4Cho<mdm`!5$Q~(O?1JAxmaG*ws3+R{Id%sJGoQ}BQXob2+^1nX*@BJkO^^!
zEpbi9EiTf$=4q28J-JwIjT=}&)WMrVde3md-Fo7Qn3PW}q~Jox8Ndl48FNIeUwY9+
z`>$KRqcQA-2F-AJ5LGhW!Y=CSf#pY9)xm%r@@<>wf^^Wh=`Rtv?24;o+RS+trq7t0
z3o{TjFBc=sn%^^hl7My~Amg@tAcTw#_)Sj;$tw^m=FgcWr3E6L9qqYq{R^(0D#z<K
zNyheaaUuxzrL3yzlHy`9A;m2%QuibfT_Sjevxbf)k;bE0X{Z%x($IQLq^mJ1nO2+=
zvDq#$b!OrkLuhegixXHd2ok*wze%o%EtyWqHf@vFzWRLIvjtDLZH7zBahW}1DhEM?
zj3%@nJ1f$S4Tv;gn!guY>ZeC!?OV#^{`03uO-0=D>=pIe=c{Xu%fW*OwQfdYv6$R+
z#T=PjQ6`-_K<P|&N!<mL<<KjaOSCX11z9X3@?uL|iZopsiQCMU(uBrwjbm{s!>kvz
z6`LEn<mH#lmcxe+Tl<ZTjdGyosNS|)qToT&hq$&eb4EFB4IyWMoG1dz5*A%xFKku|
zM3+El!HgE|v`%z!<+gMXX^1u{byhmMTw5Bn#MRgKptQJUL9RY58M1qXuwn4@J{|;-
zz?Rsxa9?&mgpknyzv&4fc?AQAva&L{e8oZ??4%^w)oJ;Yr%#l!S=*$gsY-niY)a`w
z7i{&iuPP~}WmzdMQj?@U41z5^!UnmBHQ*SpbhcMJBaK)C-dF^&1+!U9WU&yj<wo#7
zGA(Gw<(t@|ji+1o%N5Iy%k-I(C8>^8I+ZoSW!8j<-TRoG;ZpaE-2K&`$eOwV(x<}d
zo=?c>&}-n~#TE=IAhtj-J+wR~n{F<Xj!9AJ)ZV^!R)uVzTWn<*2z4e?^1Da=Xy<iy
zcFN-UGi2_}Vrfr`9Jy+)9KU9v#MDm2Gf`WbSe%VXQ4mTYyl9MNM3dAul*Kh2b7D&@
ztJiC9mpO$oX=-Y+_FvezT{^o`Hr(;|+M7foF0*G;j()*~Hiev}Sl?8Sz<Or{@`V0U
z-@*wjh_xI^2qv1gGKevHjI`g=CDNuw1ZkXOEk{u7jsvk6!SZm8{;(5*a2j}<bDGVN
zlQ9}>SUzns8CEE`5JK_}_Hnsz#WG1`JEfze-8m@AW!Ej1rsNaS(N-&xPCGG0or3nZ
ztnA*Kl0-pPCQXEZ;zSb6a6yb&E)ZyJDH75USoB<**`n>bnJsRx1hGZOGUnDKn>7>X
zYueS-liH6-Mf5p&`KvFtr&RWYT)nE+;|FBfIrHq^&p7>kah~kUwem8#?LD{1%F5u_
z6V5-CFXjH)C1ix~!<5`$0)1C)2n3hC*A&a{mzLs<@xdSieOhF5`6PK}@gyAC(!yt+
z+b(<d?6LE~tuH-K<RvSlW$|>0c4j4(Qrpp`_DdToP&-qUjY>&2CdHY!6l;27EH0%{
zH?yTI615pHzuH?Tf4^*s)Eqcq?H)aTTz=7|_f=SE_h?VW?TNFyrYEL`ZQ{hzkrQ`m
zQwYgn{So%Ue*CefgZ)|DOqZbl;@D!J=khI`Osb>d#8pTtXvbPKp(XgS{;%z7Ss?FN
z+ODY~ruL+wa=J{JHpfEQgmPCWpknfjT$vA(%BM(7?NMLYJp^qJFMH(vuYOa$5Dxb~
zBgcbMG6eE%pUJ3$f(s!e?_dy7Sy?I9T(m?7MM>#sZ*h)AJSJDXe6k#EcwD+V8zicZ
z3<MX1WM@Y9?CX-2wv0L$5h*E-n1OPe>}D-CktG)(y0~BhjMhygbg)#Y!z&#$bu?yz
znJsRKk@`QH-yqVuR{reIR_Hy(OlW~)lEf45X(e{g+`om8(TN*K1pBpUNU9;&`pPmn
zczKcL>re(N3&t2eDEo^_<k4l7(iMwHb4$D2|Lfn|lApG=Hkmr5Qa-(EsZ8sPNwgy>
z@y>`8B%@N)6_vttREkrYMo6nY%EU})nGlUiX(Va_@UQmO$v>Z0A<4#isjsh>_V#vp
zaQ`9MRXkCizvgmjEiII^4$5r#0R~)(zqLd>O<P0AnZm?b*Bk985MQJ)7T6Iz(thh>
zvptA=<f)I*p|%Le?(87eALNB*x9FkE^O6f35)Bik%#iu#Um??GEs!bGW?Psuf0>-K
z>=M*6Ai(%CA7;)uN6uM#v8Lw)wYqV3((WS284l`Y&AkuH@hfkU+u!pyLC}G}=2LJX
z<V0ehP=YieWDL;M+98uli-Mz})7H@`CB>(H{$R1CMWrROW7}qF)j<pPGr$v>!jb}+
zFttPWY^;{z!Wj~e7MtJ#4+u_4b6ZB5S~5~pC^B)P4uaxvO!PktsLW|`X}oDDs=x4%
zCtjd&fk;<ZR$7{~($#@VSh9pAM0$??N_RF$SN$5f<(8>3efDI_cfUkB4sVm|uDwFa
z%SXwc3hjsFg^l$x`GWIgZgG$Ya{05Q`k{wqM|+1<Z+u49tkbYdWa;cf@{?~rDea5(
zJPEbY{*2sh`Td-y?X|D_iG1T1Pr5t{dqmI<u8$`xzFpszw*Qk~JgoKf8dolo$y)7r
zk2XT*18d`c`MqyHxNb>MOvWz5Wm6zv6c-oUfCl{hfB#PhI$0B2+Dk>YyndoI&xt#`
zU^SeLXx;1jaM1guGa8qJlS^cBbDPvw9h7JyEAwX0l4LR|v&t*vn(|UP+|(&G?OB-=
zOGt49qDox<ZMvB)B@(kY6~&Sf6J0hpbjpF_E%M=WE2XHT-Db^T^W8&-4#||sQ{?xp
zX-O9qNv&R^w5?f+TiWb?Uh|rlnH_9yYL*u^?2zkUbg>k{(2WGNDP)W=oIVPKh*T;i
zpE<f8Q*qUKh)D#(XDsHz#3G4Qs&Sd5eu)N|sBt-By&p}>L^vi|2canLLRq0?OA92T
zzD=Z5%S#fH)wC38dx@ybePNsWA}~@}nK5Oe?Ap1f`*_)fl2AL<+1euec5RlHrh2sr
zC35sgwRCm1+dY>}sF1><VyQn~E7kjVO5L%;Qd&Ae5(R})QaVv<M5L{?$?CQ=H_EIz
z=U95-{5f*Ld5cZhh26<3bz8LG70b%kpJ)BlQ7m&WaQzna?7IW>{~rC><&|vIb2n=H
ziz|XcksS|xQ|_-@Bp1(iCk$vC6x6@_A%E?jbp~~Beb}QOZEifIb?`TLU-xA9)GztA
z&x5(<IASO^1rKBf0^@{JfiqkPA;W^7<#N+Yu9b9aopf}x*_%M%WK5l1E*HK$DTj{#
zPTE@!i|7E#?b8ymkm}0Hq1v?UuIiGy#*{fph57|DVPZteD<U#czk`d*A`&mmN?OZW
zTGDd-Xj)pEvVx6xG26wKC21VVW+dHqM3Rk<$s2Djm)Y~C+S4hVhu6oJ#glT``R9zW
z*)0{a@}|qw0nqr?;OWw>I6fKupEtS3ld8Xw+pZLQg0;h)*o%5uqmGZOd!sDX95@<x
z?^-0c`8IA{Bs+5F?~(iO-6Ko=HTfir3<2AGR%5>jZsWA5Y<$xsX`6zl(PmN<Jk{0T
zZXyW|^;i$^v|9UlTQ(x=7EP05S1pns&PvI{&#gDds<yUPrWF*)KQ3P+|1@`sOjQ$g
zyfLkI2~V#hQk>QSS(ivdTT0d*Zk2V_b@C_WQTfD0GbGy5EIW7ZwAnJpjvbRrF1bXe
z7A7PCkyzcUR5UJI&bvUW7tS$T6R1K)X>nAdvC-s$(Wa1bgxUi)lf{X&@D|K|1hE~%
zgMjVH9iw{G)lokslEfSm9BV(0MkS*mYfpmI1JNv-;iAWQ;FHl>?gvewU6G=R<q}6-
z&D^p1X=!U|kh)_B<<W<KCPxqNN6j9zXgTU2pib@KYRkurmx99X!K9zzVhs-$l@;2@
zwGTeDC&)OFq4ocsOuq6mS-NXasII1WRmjpnfEm~}xbpk!u-wL%_q1gvzqh{a(LimU
z?4C}KQ?<`zv_Qdy5Hf5O6&1;X1q<XQSDq)ywk92zG}|j!;lV(3x$?DfIok1nG&b#&
zOsZWl)5Z2_G4VwkP^YH3B_l_Ur=|K(Qufy*WnXnl_G>tJI3-7qW~8w`Bc1KRk|R9@
z8|dm##*AAu-7Z~CyCjkPo!s)K=`vFXRNfhZ=u)UBTz&BhshB!jx*!IT9FrG!KdCwq
z{nEd3QIH0EWX(DW9D;z#MY6O~2SB;?#^E%a2Is^Oax!d&i~ffVaBG*wWy>2UNwU}t
zg!DfJ{aJs*X824mwxo2ZgZ&s%DVcKdT#3BtO6i<CRlZl;C=YFVR`&1TZ*LcBJa$|z
zE3cGKox4arbIx?Rxw1qqDiB!^Ny(gOS}rdU`N-0V^0~|A$^~TwvUlfB*}Z$W96x?s
zcI?<;g6%~YT_oo(K1beFUL=#NY9!jyX1B0+(GuBy;qqYchCx?WDkc_5Y&6WK8$oDO
z$f&{AGQ(U1F^onKLm=rsM%@$3B^~VB0=>k<6-`GYZXYR2Yi5w|d=6)h43z7yw#IrC
z+H9Bki_Vpj(g{*rQYP~kF0;5d1qFpR(**%_j@BLsN<>P_x}Un|d>nthVPTQH3PQxL
zhkNYda{sQNxDN*I|Gm+^z8E4)a0u~b@nykYB`32DeUzVs6Ys4rdsHt=uk5eQ!PqM@
zo*7@?_JoiT1<P|LPMj!LTz<J+Fu&4?F0IYEnJyD6OXa#Z&5>;7!*clOlhV<8P#u}1
z6I~E=%;Y!AwKoiDaA`M##chO({aYZiAh@zfCMl`*!_stYjm(<<q`cuR%cOjAso?2&
zN&}vJx3@G%bKN1?yI-$aR3UqgcF8yIy<awL+39Y6+<`UOr?dH8uk&qlH}7nyb9U1r
zn~v+t?^fr9kU^n+8tlKaSa!Z_f@CnrQCnaG3JfelVv7x+aDW*lDYwyOR5G$~^<tTJ
z@hpkN;u4)uDqZuY$@j}z<);U?%hS(1BUM#Zwlt{bK($OrX5<nb@Vs<#rCeW8A=giu
zDCfruZ28c(ZQEqy#*HS_?AH3f+PX`29y~1f|KG!Q{@l6qrDMY$xvuTFEZJQp@un6V
zY1K}f75o_(ZAE12l!>Eb`Qorbn?gn>W;@UqO%QQuH=_kJRx~e|Rc9ip<%f=O0&EWK
zkRC%^vHEaYViC!x6XHY{{iVn7H?VOx0?zlK{~z43$pn}3imCnX$<iO)Eg{`~WY^0X
z#o+{^OEB94!TMu(Q`gh$|4SEZd+XdeJ9h1{<8B794TxQ(0T|-FS(_E2UkL*+ki8<~
z9SSalkYU9yExO_Qm&l?ih0@tvXER;8Iy>MQNGu+eD_^!uE_!97G(`Sa4jp|`T3Zj;
zjF+gEo4}%egBMdEymW_fo;o?H4(V*Imd2xhlz8OV^72=w<i#()Kz*KwJsnS{Qzp6`
zKCnlsw?8ZO$B#;VL!%Vw;HpUnMv-Vje*4(dvUNxQ(_}{ko37g*C;QSr74Wu!hed7*
zIZs2Lu8Jqjq4R_As>MO^;v2j3wQX7VaL6$uWMH(LOU)IfW;5)qAsSmc2v!IA+RsgF
zv5=O6f|x9Q<@qvck#-uKf?x5Ni7wH3Gvtx!art_xM((fLD(jzqS~hRqEE_g#u<*hQ
zFPOOU{PWMtbI(0zF$9-w+qcUD+jhx6zpzujf4o(`n=O&=bj0KxpZFK~>}S3%tsSj0
zZDOG;iMGp<eFr2~*PsJ5H~8`QJ!j_RkriBMQwZsSi4q_Z*agJimf$CxAF78<{4)`R
zNHDuaOChWT%ZG9^UC_O?4raEX``c@z(T-w5jZ#-zE&F$Gv2-*Rv*kex7hlll442-7
z?MHXZ?mF)6i$TUnVKY#?z>tUjzj%=>t=l6z5O!h4OOS62U>gRsb>I~4?WApjlh~_)
z7;*bdMw$`)wkL#)SMaLk88c?ct6upESvG5ewACH7Jzd({nstEWoSw?*6J_<y=g5Vx
zI4)fi?vsPZ9+28&>!qn_r*yQ}O1cYAin|1RvP5xCx=Yf@7U}A!mDc86(x7!4j{RE7
zCOsrCd1Z^d;+At|ini&W_TY7osZ>f1Y+WxKAHPqU8tWyYj?u*O3VHZ956HSdJ}!ww
zLMD}0%7cGcC%g7`PuCrJ;9S(pnuo$qU4mmcAvm-z=u>!l(${%?JP|s+YtJB_5_uNM
zO00qIaleW=OGv1L6Mlj;DCdQcUYNLI5k?pq>#>b&^gp!;S;5<j)HbBBgeWbg6~%Jy
z>n@by$)$P%o;162?fe)vyDX9T%qh~ibe8<GA}wFe9Fp(X@0AB@cFN;Bx5)ZU8%$_<
zX3Hj7vv;TbYReA!#)j>3$Fp1In+NNqdg5e>R8Ezy$|;hX%)M1u9bMBcnuOpkf#B{g
z!QBZi!QI_mgF|qKpa~w_-GaLXTe!PB3s}4JzTdZ>WB<NBmkr&$dd{w{S+i=4QLH*S
zRzpL~{yw=UOI@qxU1Oy*iH|iXTHYIZ6tVM5FQB~?JUV)+*oz$HdfE_AxsQQ{?><l-
zB$?wdpf*2*WH1eh^&6_o!fbsTcNNK*7ZHe|#C8jchG9hh9Vx8Y)5+N7a}ciLV%W6%
z0Xt>rMhlTq0PUp%yA|y1XTZ*EXtJ~hZaVRntUix~C#OD!_$?v{Wfo?3n;Q{hIpjwt
zEro6H+iK%aZG(zUGZkj`WX|EOUdFt;=6R&1UL6-L*yuKNzQN&|M5i=i-NFPTwmX^5
zk7aO<n%&1%V9<Xz^l5G8`dGT~(@93_$Cw_Q7Ph_`i9`~rjE;Fyz1vyxUaG*%9~H{+
z@wUQ3v$T45`=rVnsz@A%RGC@#(JNV1KvL+lR<rB(<kZ9Uv}>1@y4;C*bDs87+EN<n
zk?2F!U1`0fF|B&t9E1A;TVM0+RoFA9tpWrc`VOaKg$$kwl@V(B?$bE#Bpd^(B%8Ce
z+yk7-<xBr4waL!uqEp_B-8Mkz$g-MT(7jwk$|8KdP_W&^FK+c1%zgfuKjVt;s_pm-
z&SWCSi*at$>SHh8!F?U3|M1DRsTDZM*~4=mGWDr&aJ?2#jJQ#6F>-fg!<|LC*ZDT%
zsaE##APY;32*V<>fI_5{dGQmLs<D85=ErvG2v94zl;4*@!vC~%SPjMd1|f%SIS<~h
z=L`#5y1ZU|<^$%Al8kPnWSgm9txS#_=ZJ|_47uHvt4J|_ZNBoI1Y$v5xh@$dwM>C9
zWH0EQP7zk54IjuK++&h>YMZnrE_bRH#gN4#|5MKn!{#Xd+Cna+RFzs*)+GvlV75q}
zeVI#TswlpuTe`jQU{<P(GE>^JOTNSf<J4bOnS(6Ba8KGkLt#p4T7&#hm_x$qETMr2
z)~hj^h8q=6PQB`r$Eu|6qB%g@*9WLCr*4DQB6t{)z^2tG@ed&%MMVW8o7V`^tptX1
zdE)>mgT<=$ba@6eLqm9K&G(K<F&nqNP<qF4T)!c}%13tk1{bkjFTn+SA|;AR)7oEt
z?KB#+d*=p%5Z%5g_EsV^RYj#tCPu*?L9A`6yM|v--O^0LqW|2~L!|>;50h|R-&r8p
z0JGSNz*A|rPMq9ggEKla=Y5*Asw3opbksH;tJ{&ZI(r%OeZ5oKzFB1w5rmYa0oFzO
zapZF)dTI8=W0QS>pHqE4A$Gfc6l0&i$tVF@pWcQiH3@}kKxXp*mAZL4mUk)_smUS4
zN)ojTHdIzB<oG{XJ$9|Xh_r5D7TR9PMIPk=0NNpaH%p`*k%QBZUS(m$nxzv=JnD6-
z7};)DGx+*sqiM`s;m5gW&#kTvT%$c5e75SNf2`O|kD@c!0yZ&XEOfHx_h7uX>D5QG
zv}W~!L*g+%GG)HwQ&v_c%^t2NWY&aO9j_d$Q8gY!3@|bWE&g<48KullOdRNEJN^be
zfnwQ>E1h|e$Txs#^Zeee9=Se6rjXH;RTk!v(*;HdeF^MXfl}hCR0LI5(h*7V6LM%M
z4{ND8Lvw0}vD&Ejt?@i@Dby;1%PbLIQWhtd{8NlwttE)R<>+YC^ls%4L$)cCkr#aL
zL~3dYV4&V90}75}BaP(=3^0ZuA#w?L>a49#)1EHrPw0E9mT7mLp}QsHHRI0>ReUvl
za`Bu;qX|{4R|(-}G2Rt6uiF8(>P)d!&5jArdkc`_ebYjg)cD#&_?bVBax<P8U)h{y
zurfX^bj*7#7d2o{es2@Mrr#a<L02l|zi8g5CYSR=<TRq_vh_ghQ`>kdfuJTOj&3Vx
z!sqaIVMu5F+1kger@4t84R`*_ke!(Re7X>c_lYL|5TztV6;gkZp-@v`x=?_BJRaV2
z5wNDwXzFvAjbLdtSf{Mqr3$5))lti=uI(2dTE@g`Xcx4UitzG*{=AjRFiAp$`r4B?
z*RwGMV<2<*r)P3gAhXbXHow+Y5<rrDx2a6<y51Yk;&CyZY(%a-%=qLz&S_=K%_L=m
zIy&7OUSNH$5My&vs&p9Q{MauRCws~|u}QHLo$t3Y7I?^vra=;7h>M<zR*F3JDrB<v
z7`V7~5(ZBjG0tg;?O#4b$d?)D%K#k_*@wydhCWf+DiRTsBRR#oRg>Ze6dOOhlwNc%
z$=!x}(6v(zgC3dQ_5Nph9r0grpB5Ri3ESL<%Vj8?+bboBd|YG7y{@dXB;a_&49~fa
zALb#`fuF(%YbKC<0HxX?#I16?oM;#aF{OoxP|jf9qG`+MJe;9!&clQToDi1uB{shS
zey!SPm5e6GP-x~xVe!N9n~ZC-$48CfL>K0|4t)|J88J5+TcLQ5rslkG<ksONQPo84
zw@I3yku6dKElZ-f5*`*!-CPh6&pM!~r-B7D@iqiUZk!KLW;LCUwwm!h$x}NAkrCQ4
zYLgbl%B#1w@=^vbF#o2lrCxF*c_$?b70Z4Y?E_Z&C7Y<-)$&^MN8K)EFL>FsCmO-4
zU!FN>u1q6yNJU-UTogeQfPB?j+}rObSxOft9r+k77ML`tsbKJ4{J#2W$v}$VXq(o5
zZ6SM!`?>;$8-oN%BqNa6iJFVcAiVHf@B4yvWJpuQX>yk(TTt+)<7qVm{ttXV=o>Ua
zzDyK(j}sc~?ZqgJa%X335uW>}V|0d)`2p{D5DFlZKTC$eAfK*FyR-*m#RDR_bS=jE
zKv7UrDr5dD+s4W&zBk;au%=U@vU!V4(2J@7hrFiXpiT-!8b&sv8VgO7-u#zQSh>6B
zm<sx0mTUX~8yP{Sk#GiOUaw_K(I(e}ixO5Jy5%Q5tBj^QFOS&yY`%OI_fwEbol*5u
zNpp$XR^+?PrDKbGQQN=>6}25~-v>$wBc)<*h{95xNwAul!d#S<2|_BCd^YRk3{Z)u
z#xbb2^-RTzai^;(9x?mz)lAMJ5kbp);N0k$4KEc-*^$&V+KCg6=?%&o&eHy`)=xKw
zwYE!aS}XyTSS4xBC*4e?Uo3uBl<FrE+5vnhrczS?n^juL<kO38-do?q@maQ4Ig`+(
z-8}7&hC|v<+f3bh<I?t<0sNiT<4SfBi<tr$6-~`_7v7n}dInt<gB)Mym_J;9V4>)k
zTT7Y>tT6R%Ua92hGz=J+@EcF!3laA}D;otih`>1^b!`MGM-O2l`|KK81iMd`->J4=
zX@RW~9LVTWc&?dd-^ym(n%%5tdH&qrvPD$ixw;$`Pj$?IPVQAOU19aVVM8;)_uyRi
z993Wmlt8V=IQa(8GNh^l6zvt<k4%S&%97x+nq1SCfKs<4W*XmIDxrWj^{2T8=flE%
zRaa7qK500nTp=||nTUKey)kA-QtG_!z3$Ee_Llm7G|y=W>F;iJATN{u#x01myz&X%
zWubEeH1nLb@zd&o9Y5Dk_t%|m(sl#v?ndD1)$iH3&q+@lDJio-V2q_Uo1}7s>wsFf
zZIG^|ja_m{s$zOca917?OOM%;uDsc9R_OK47GheQVozv1TE2+mv>@uJFdQy@^sRvI
z6O;nlokx#k(qh}@hKQRm$DjH6qm7-C-5*G9Z_I}b2N3jm1l*3)mcKgBmuq3ihqL{;
zWY_+^q5U`e6i(zV{R&=QPw@K!TW+uH6q%fiCF|9XmBHrLDwoM4yT_<$>(dHoOZlAM
zWEyznC#S@wRSdxK@btEXBR-jxliaxCY-f-hsy@WL4ITG~kJY2X`0l#&xr9I3JS#r@
zE(jAHoWVf-2XSaOpRr<nZLO&BIKubR#UKILGkyL^LY9(5Ur3S=Unq+stEyUtGH=W#
zbvh^X+}kF%LKzZ0M#Q9=8=%6AxRt05{wXO*@x%X}Z>S{$wF0-uTw=@X`L&#>gzXlC
zF|pFwiNt%bu$%jEg8`)TbR9#cc=x+(+OSxczb2XHuYx<epZ8FkAM0F2khYGkBFGne
zcUKUr8g51%fVOFm`&GL{Or|UBcz2Efv3Ka>w(SR9e#Z!s2+y}g6&2$I6vW}sINTVN
zl$0%thzxMlE-X_h;%V!U*ZZpqNT;m(`4Ub9Q$K+1A^VV`>WqIFCXtp-u`6HIVx%^P
zL1xOqqRUxWS}N0Mze<Or@0&r?vP6TDHbMv+xi%r!<bg>C4^KOUk{fIr?G|tGF4o+&
zP1+AN$a!B!;ExmQ2|#Hf4@VuQ7P_la(NhHga83>MDO8mVI;{ZO6Cec(kf$Wk?O^6M
zubN+@v9004_n3h&yHdtN;Agbr<B|HX;d1;N5zT*T4RS8^O^7vdk``&$k|D;jmz2Uj
z5$|<+u}bi^n$88hOwFL_RdxUk)t`DGE@newS#_+%sPEHuadb@poSy?YY60*M+eCl&
z|D-OBh)hNs1f&nH2A)#yE|szom|OYp7EP{VAWx|$pbiZTXlTw0Txr(~B|(|W7SG7B
zY<=8%@u3F*4vqjL35!Ay4}dC$_}!dYpelso`YrNT2E<YWp+&HF;V6*_Y}|SmkSA(;
zQf0Nw<Ijo)y;{h>5=1ar0XVQ~<QAcq(n%Q;li*}Urj&2rK4XTaG3qhcX|MfRB&CGz
zzdBS5&>U4*ZNzluWWfj;ovHFy#$##`t~D!6l<TAX5G8~C3MG2cX|bN)CV?X#DuDxS
z_BwcVDXaIPy<;qu+$e0c$^TbyMLj%IS*0c^D&+1y@#r&3=0@$wa~Y%GYz%W^Q^)Qt
zmhMn<I8cx?9g3#zF{Ai;5LAeWruTZ>^{Uf&zCs!K?u1cwrue{l?nq-~Gk<Qz^Ctdz
zj*%Hro7D7~O_vion4E#Uul6^<Y0kWy$-OudX{p+t?Fh~l2>%$&9J05E&7-Tsj4W?A
zGgSh#?6Nwa^0u<wh$)2OEtnBeKl?P*LzSuAF6l1JjDYV`OtG{?b{p<KT5v^{!CIy=
zGD;6f7ql13rX9HP7H)b*C1a%w0lMlLf@vZcZ2BMVd!YRw7RU3$r}r<SN1sk3q+!Uu
zL3^CQ88cUFuF$WxjiEr{Ql+HgEEKLH;ULp9>oCDrgf9%45aak{`x1Fsk0;G!WEdW1
z>VF0jy#FM5O=+5Uh?!fT0Y!mi$nyY~*)h;|QG*jZ%}_B-r8J9wPCU(pS%-Gtz`J5B
zi&csU^1{4(=dmIx6&CFyY5a8uI&l`-E^pis6vZOAp{*YgxS_f}Me_w5H?*0L>|9>?
z1urvcW<DVS=$)&Q@$R;Oq|;DBRM%KJf?atzs;BQGp=;0hND<#{(0FaYHMt7g58<Nm
zbcUpnQF&Lb+6Mw2&x;bd95qtNU5n!4o5=Xf5yxfB8>fgS@cnt3UYom?&^;$<Zl3&N
zVs6!{m9Z>V=7BjoRlQ+jlp-p_Vh%5w?%HcA7l3*CkNu1Fn0bE1+>^jzU<TEDMPXrK
zeU`B*O-_-I|B$9few|t#zx7*`Rt{_EQFd=As;a&F&X3fT-=%R8OX#B*0g4gnKosku
z>PRFja&6U71OdM;b;IEI!p>4zZ9X<U@zxo5!h=2v>?kWfD=ju^(kib*gvX0;A;!p`
z&2qUs{cCxR0h8!jt)4l)n^6$!%mAPcxt+1uNZrW{7L4BB>^9iXHvo6mH@T$`VSMpP
z#MEPmAx+ODO>)o&|H9v4Uc0eI0Q}uwEF~N8;*f|P<4Ib}b($1jue&;F@wx0-EzE|Y
z(}okTnNut&=nqYcO_wuws@9&U0I5eFXdJdPTvSd<hRz$x0TST|c+{PvWBh_&PZ0!s
zYYd~<lPRN29o?Mw{%0*XI}VULC=~$z#5P=xg@ZkW>VIRWRc+YWp%)WO4&;aJeK5|t
z1d(7ZaX2@d;$D^gZ@P&&vR&ErPUfcl-J^(ub~RjSb2aG#z_DDV<1O()h`9H_TL?kI
zMPTYhgi%07My6`@z1CSz6&uVn?Ww)C%S)E-qg<UQscLs>Xn*KuZd_2DO(5OQzO+~U
z4b@alvK{)dpoSUI7S5Q#!t<hMeF#`>2F+#)BCocI12nLibcJg|(aZ`?;GcFKx9r|<
z?hVdRo`^w<+_~~(#B_`0@wn^_ZS_Z)jU>|sd)ttcTCo4+)r*A%jb3a^q!j~+!dGw`
zgnZaCAz411q{cP8{m6`&wWgnsEhO5*QuT?NzvMcY$iaXGt#<>iF~k^=G`4OyC$GvR
z6;WLM#*4Wd1*e+yLUv?y)NHFSlCv$;9|8CLze6SuCdLxD{iAwSX7DnSRgl*8yxWq&
zsQXzwBAC<cpu2O!iVH@%ni5L~&M8a&?!A97>cKU6Xztt=6zMiFV}RoZ40q?^=U*Vu
zxY2J8J^oKW7e%GHfXq|8uM;N-^8u9{ITTxz00=US94JEK{kv7k<nFtGoagRV6mug-
zKlWdxRHW1k+oS{p0G<QoL-D^A?xl17s$%^2Fwx>Kp5(uWJGl1WWrscnXYM7M(lG+t
zU016t1q%xHfiX`Gj08;vI_S%EEGpx~sq|<)OVt5Elhq<57*KZ2+tcC2a6trIdB<5@
z;AX)^>=}uzd+vx8gnD~_qWc5U&v5T!yLuo356f_*<fBW*sxVNeD5SlJepsSUVSsxM
ziGKSX#9R2Ius7>#9rCmM!}0|ehNxs%-O}G5AQZiV{d?wLM;;Pwd{F?cr~%?j5}8;+
ze3g8zusFta7nOwC9{%@S1;QtqkSqdV9?{so;W{Yhy(CeH4qdRU*^U_It&;Bi$%_*m
z8vbVz^0DL$2;-p0pU1OWWu;$nt2oVArq0mVI1cjB*tq}B%n;3c{Q8)ETFAq4iwq&@
zqe=U6a*uGE*w6-W7ab88RA`{@0B&f#yQ5*><k$G;o>va;2Oe~1=S9T_-1wfq->#@6
zZh9r}UeO_u;_$7(Su!&LYV37)`ZED=UG#0|9}tMD3*4KJ9X{JpS|MO<7NPh77%_~w
z+#UK8%?^_2zqiO9=JyROb8+fT<1@8q+F6+94jguRe1Xs>FH^$~dXX{bLX&Q1%^phW
zZ(RIf{$WCcM3J7w<a2+TR94k4S|p!|x08ie&lhr|2#_j|5A)-l-u?6FX0F+1m`T|(
z8DJq=t*dWjOAyGnoj1Sf0UA5xFurS*mMvA^(h~&SeW(6O*~%(1^5YxUSSfmq-NRQ)
z54giz-$xqRIVo01h#&&b=)bcX?aGT;pb%Q_yIES#(9){(>JlkUF_c0H@AYsL!T+H4
z*?ptA>agKQJE0Aq*;?=+QS2lXs{7Eb&8NWyoic?afsD^1P@8ugeqvQuU_DH+y&FM9
zQMe%wp{qKzyR+2=lRH^YTE+7WR-1*2rf2y~E}iFOqVQ{<rcjneEtZZ+fz>7U{|?om
zBrY)@mAL;oLiIwq*6)GjMtLYB<R3#~V_TZ_>~!I0ykC&m`4UCGYAoA5)6c4<lBPb`
zONiPxQ?_+Al8x)d!mZvUdbWNDax>kH8qDvREe&aB8#*0GX~X4&_xcjgr>1aRM-uX}
zcP>sF1lkEpD{pk{@uD}~-eVMr#8hJ;A4v0=5IX0N^20SR{2GdgvvWkopv|%l;>JbO
zv5q4e&klEoby*VzEN@2W@k-e{iJ7>+L5?^yn&=-B)RIz5y=_qNau!d88BW4X(qNPs
z_4D_x;^jnTh#UnwpGxldY4iuV8Z=*F>d}b;5{y5g5reQ&iBhx)a`a|EAiRPV=iDDG
zcA$EaPb@xnUv|X_zEVn<;VF2e0+CTOV95hGf8C>LGI~r_C1QNSsh<ETZ;qR)8|*NB
zTA%Z*5Ak9~s>Z>kw9C_9Ly)^67uxP;zV4ArP72(W=zLW&FMZgR5v;G@vXfjjo>cm=
zN?H(bknbu6d?8T(npvN5vC((x!JRKDS}g$@^8&Z<H6|L`?&<?ODZ#6S0Wxa(R<k~r
zShQ4CDCh9(qFM76B5<q|;zGYOgMN?tvS6C!X;GtnW>KZ|oiK!F*1OttT~iZp6O)GQ
zj7l9M`(ZgZ{tlo7zW5QEh};R)?-48hZgTE|bF=|CYo`GgD)zo~^i|EgXGJHVKda>@
zC3Py>fep0Ns-lJ?_UfHCLNZ>$gqa%eTgZnG{jfvO9I2iX){$^R)(LiIH*snF;8`0Q
z8bquOs~4iyBNl@16f9)W0SER1yeVi0iV+dw(5(Ky-alSh(rAmLt2>Qir`w><Y(JQg
zZPI;X;lfbz^_BVCNyVEpcqO^c%WvtYN9XQ`=kZ{wLCWWuHy0yi@g95gyt#M4sCg><
z-*5hAJ{RHFB+W0VuODP1W?;QCMij^BT7mnGbfrwBj~9aM1q;QwoXzQGea0X1gF)&D
z5%3vL)CPhhvGI`Uw79F>qkMj8;IW{^Yd^<R0sa-`59iQ|)o#!96p#8kjVc`#w3KPR
z%EAiMuo^EnUM|HJYiX7e0YSnvg5AjCS57m>sk1CCOT_`0dg}TQCZRtTlYjmCMKZ^A
zy+4VnA{P7?XJU$_qMZz<vW?>p6S9MPSKQMx85y6{>;HT5E7IQ$2pSs#tz2JWv*WXW
z#<s(tg)rPO>h?cN2H@WSj}Ag$^ZeJzni<Rdkk=w~*l-wFSAZL4-k$r{mxsXsejf(*
z9~0_NPWuo;9}W{h|7!j}`SWy33ggV$nDElJ2mH&XEeEO)B-H<}bpfXPX0Gm5CNaRc
zkG3@=n!ut?9v2C489S)J+Hv!*QzthJ=H%BCp<$$Bp*Ca?wCWMqUc2Oa=nBuAL}$Co
zV*Jlq(LN<bTHrvYMJWv^r@Vo+#y35yzuK@oK-%@Y2?1~lK-rM=G3XB97%7Gss{(Tv
zq_#emD<mY1j64BY%zqc(;eP^@{~lf;{T=du{u|H#&oc6#LyF12hW7u%%P@!OM82c3
z!Eh@rleiS8z)FejYx<eQ107@jjwHS=jrK!Q(4TI#FJGWbJ2U>x`~IcWne2!;;+Ag$
zrzDAF0?KeW_0&L^!-kc~rW=HqhK2sW=V9k>Z1mrOlY0FVH~i=D{~Xl(kCzQFCP-6A
zXAcRRQU674{`cksjQ#!nB1hsdbbPpf{o;TA&Ssy%VWpDGt`#3%s~Y-$J0BVvn$2VY
ziI$d@H39mq)y|I-wf{?$74L)`0@QwrN7}uv8A$wijS=(y4<Xq9__Y7eLH@sOj-bpT
znf62RE0dQf9K6^+lSyu;=zdz62ut+Tp>|r8;L2-K6-a3B7;`vFH5#)}l^DgWOM2<a
zKtmd`lR3SS57?Gz^j|p-w(lR|GZTkRO?$(T0m2-*OreT9LENC**W}cR2?bgPhI(%r
zF~JdK?5KWQM<@+yJhvoor)U?9NbxwfK0Q6XyC<og{EDAH$@pM*Ej<RJaqqql&CIBb
zQitrMC0r@T5>zA^K<u;cuA}e#LJ|m3dIrSFlp7e)TMQrHwQS9}1Y-ci>c4Y{%Vr|s
zxKwWz{=A?kl$@G6v62U~gA_|-5oF559%RdJG!v*ygSx0Bvs^Rezg^v?r(6vEP)kI@
zUSh6H#VzdPE$Dw?0Hcs*u9K-fNS16qqayf2eC=hTD;{ye;B102<RiI}YL3?)E+&up
zM3$9k<lsGos4)-KJ8g3@H~8Z_c?Xht&mYhW;;ZYgcTFk)sCP7#G3hT4{S!RtqcO#a
zjN7=;<3VvJ1K}xQB7oB8S0*VnRhc<VUV@5fn6{K7JJLuG&l_~4VAG13L+SorplTIq
zMfiYT61P%PL|#+U@S%|h_m-6GsK3Ce^9g%elc2cN;YV?qi>jt3g+uG(+!ap19cTkd
zRJ!x8*#Pq);<!}pl=%z}@YUeuT`nlA6U#>6N*~6}>^5Q*rJ}Ko_J*UrkV6Zd*}V2n
z_HjhBS8@t};v3?+w$N8}6p9G0@28PclA_g*{|jb(Jb;BLFm+l&TVskQCsfl4y<W!c
z0)iBNxyG{TombwoZ78u|Ok0xXhYZ%v_L>@H0RBWOo5qxKb*0+W50uAn;eDLJ;X>q}
zK1r3Y7purb4gxUr>6~lIEr4X3M0*S_b!Bs;Zm){}R0C}sEs$Qre!&+ck|I#R8rWa^
zGjaY}M0`0Y&*V_LJgo~OK?aj*Xwv^7h9np*ky$c$W2+qw@CoGWonY#j6<y}+qwYl#
zN=M`0-P1L?$yz)`3+}K4U^c#5ey)RI<me!0S&#!|n$mA8MMrBiE1e!S<NI8w$c^qq
z?c%b0F+k9B=Xm`&_v{!`G>nkp6p*XK=d7V52p1vB(KWe?Qry-jsWl86oyZ3G**{22
z0OCD80k1R1zN)whE2bz(Wgki9(Y*kGrRN7U#wKE>3`)*V-<x-AiX_6*f6txveO`>#
zWNgv~y*VNmPnZy{bz%*{Tgbt5n^q80#hf4u$qN1Jymzw6rQ*J`&xoBX?Y|qG@PhyB
zOJpqn;GBlDV}l2~*BmlZAu7xi8d7CSr05`;A>#88x|oV-WEjd1CdAUDbNpG~-nth*
zN)ZwbhsF<DUJfQd4gXkp^Rudb?WS^eoyXip)C^6Fq>%(rch+7jkV!HfPNe*+Q1y)o
zAn;dX(IiQBDP%mn73rG+onuD6i)ly%5k|1qq^Fi551Erz8g@}P)x$Y45Y7J5MioTx
zC9;Ekhv18It$ZUib}ny|LCd}7FwLFa!$v8EBpVH&s&`I;W&eR6gi=a4Jk)u7|7xTl
z+g&X5NUG&@wzV--<F?GyvYqdt4btei&OPV;v6gDbw;LPR?7e36cv37#vCm{+Y&EG~
zalaY&l8Mjo<GZBCo$@3ITs*lrO9NKywE*N)cb`899NVq6irGWL6}5csO!nBwARZ71
zclb9nwi8Zh{3ZYUw)K>*$ILGHCqqS;?SY$0_9>ptT1UKlWj#Gcm;H%xyYErE5;~2x
z3A>|dvJw)ZyXc|{*$EfQuP4lqwNz-MT<i$C;YtOW!WDg{^o%I}G0C1W%=d6)>HR_V
zI2L1^-TWoYU$v?)kd;tKFvNU&YQ9Vxa1;AS=AH(PX>!;v#8`qCsrOL39uu+wz7esm
ziZ~n(ea$1u1)FGA+jADl+<40<l#xU>+7J$$-<;0dp7-y<!_K?~`qAS@#X>ip{N}`b
zwCdB^#>=x7WOv@~XSb=z28E&h@V9&;35V;yvQg;68;}l&`UD=`Fd-7(E0`3G)|d=Z
zWXRp6A3C44?2pV>=oD5~PFw*zGJH>rMy{kgn+QhxFc~!!JsC_9mSc%p`_xK!hEk?X
z^k7OUP4f_3M(v&zjJ~r#B=ccwBJ<`vJNgCn;8spV$>VgmeAY^MM3c;G?J-hZQVaT%
z)sXmSDCT!WAw1;NBH3t3%H{qL>W977aN!r0lFuY11t=Ppx^86Jdn>e)d3b=YPv{g+
z`i~Ro_1es^-h6(YN#6}>!T}PxCx^~!Ui%pb&d(1{qvRpc`nHXcyoeE`o`&1HvV&WR
z1GXO;5Q|#6e|%NKh_t4olR1S%%+mbfPI4zhTnUoHb0C}H4mJCHW+&O`!~_b>h0+Ob
z)zmMbHq8CVpjw;MFf^V>8j=<B&lg856c$*AUhU)YCH}~Ka_yz%7dQN2=g}#`?&DLN
z`#GY@s-}QT2!S-R+9ZrYYSL*_4sxT?@PZpPn&<?H5&DkX`WnT;^Pr3Kcv|pRSG3BP
zk!$DE086;7F9v=+p;hl|6m2}GHMoZGJL~3P^m95xaNw9aByh%Dc_7c%c3$Wft!Qkm
zJ>@(nKenJXt_A;4OH;Q|6p7{Ag2u%~y01u+EgBF~@no>70u{6}cqq6(Wv6QLPcv>v
zwuWnH>SxPQ-g?uz5&sEWWWaqO){c;@xsk34r<4Z5D$KJ@pcZ1naI$&z#B~d@5%K#*
zo06iUt43hT4dMgsE?(vYCk>~3P)FVO*{9S%4Hv0XrBa;tmN+BH>&O>7ZlNBl)K)K2
zx9%|Z&|5dx@oBR=L5zcKf~U6JtG8<Ler>I&uyfupi~;LR<(ZQ|w!xmCx|hS@?jtqH
zA5Qtl2<WaoPI!Qv9GZ5E42mf6Wi=tLRmN_QE!Nz3k0Q3WjvsfHXrJhl6h@$`>i0nc
zmBAcm+e;R?DPPLeZx^L;9261G4})S{Ykr*F9L_Svp|N>Nnxm%OXAA|tMx6&R;QzMy
zL0V80R48`viuR?tr*i!3u&^yM=fanA-Pvi+6;Pn!*9B1%9%Z&jv(NC$wm4OBk^&Wm
zTZni;p+K18%x=bkx-VS+*z4eLYX|TuVebJCob~b^>br@X8<jpm$@EuEF$LRc-j7ox
zB&cq`P>IIoCL<Y%<cZ7p)>g5N%NA5^djh0BRsDMUszx}aq{j%pJ3q(PalWl}z5qJ1
zHF#8=fa;{&Pe6>z9;Y*nsM=0bYAkLaX+?*mgQ#cnnih@4F|<WY+D+fHKcdG==D=h&
z#Bp4S)qFaf#Uqbs)=<31*7?l}W9G?d8^Er|)OtYXV|MdH%r_sGG(W+#R`xW^MS-M*
zWWa-OjROFh3C3gq8p$L@rsTNDXlm{3LA%n6Z@9>v#(b4o_)zM!Z08X`)!J~DGU2*f
zFND2vACuce#UJ`{nL@HUsy%>p562U8^;IVKh9?3K&S3RXR-js}9%m<WbQ={4wnU16
z?)rA62E6O<s~wO}L~1Ht6DTj_H`$j`Kh&=({(23Q;GoOwJZ;MOHT@kr^sWeD0crVS
z&1A0=Nv9^SYqldO$IzzRCJz=vk4i3`1Zb>UbF$X4%((>A37NJuU-SKzyJX-D&OFCm
z=(0o9$#6ftheOk>zM;t%Qt%yaUb3@hVbOs$hr)hW<u`!z0o8n}aE?m&%Wy$;6QX&G
z=~#|y*Cw1@GqP(1WAOuq=!EFs{o_?E4lP<V5$xL@Cwt*-30%eV?aqmNyPcp{6i}Us
zi?uG^qu+oCbiwK)6LVVQHpxV`7#yz5Gg4Y-H#cPx#$zU;I30rc$fxJiQ0+HPlxUj1
zgm4UK+Kwl)f|`2BIn|3n9OAhnBcC60A&<nF9c=LjL6nm8>gCljuJEM!h-0EM#x6Qg
zvVIpM7B`p8{ppbyk$twMXd!5riuDS-high$gEl{F2xLZ|GsAD18h1H+$Az7giD6{1
zS;=93#&AYZ=@y}MITFGNy31o(@&L<eh)**b+rURepJsxt=L$|%;^Uv2Uv1?~cj{cc
z&zi0Rf2s2{^=1%jk|uF;pvUTIdE^KUARJuO&`aUJE@C{)`IRp|SrxVsjZ~!e^T}>q
zjk^@RFK)f+0{N+7H&K7uoi`}v2$%~Tlni&NhfrTNdc27LGL2oiyJa4-yAFD0QS?=|
zZ+3}UgM5Bm^gB;Fp5O#T2ZNisz|^(OWw|{Ig3L|h#k0IK(S1Zr9_xNh&$k8;xA@s4
z{PUQjE{6n%PL%>S7ItJpvVfPbvda&W^jIZ4-b*}WU8{^Ug+(Mojnu22bM!EZ2lrjR
zV#WR4=X39kpoNuqd>^XEoqLk(9m0i0L;?Xds-beNI$JCBiI=%5f66MK)nmDGTuh_}
zA>;uV^uZ<jsOvuI2O5XxYmZE$uS!9JD>Ex3_&MPGTksi?fb+wWixf)E!^|7ep~D^l
zU?XQi*+1Qkr4=FLM8ULw_)y42&oQ|``=>{mNgQoZ*Pnt4ntT4E7qt7ym0!lBi`BX$
zg@^9fYYyf>etBw+$wKrt!~NsStwtuUce4g}`G+o`B=wxBO)Xt{stH1SqK<3D-6svJ
zsX)0&4{E~rw)Gb(4f9y=!S*y?Fc=Z`h3^iAD-*nY^BO*Km?b;FssC_*C?vLve=Lp%
zk~re<)tg-`o-uFO*sLF5)}yJd7u_*KyrB@d+XXZSd5_{g>)a|>Rf1@k+b@FbV!>nV
zlS8wLLW}^|IUXpD$*8I(B_}5j{bg_f(C2zHu{2%h$bLA_Pd6t^b#|C~{J0KQR`5CT
z_d<LY1w*%^N(Qba@?JRLxkaNG->bPENR|F(lH&U>O2u(k#|Ca~D|&O+I^-6rU^s_1
z4@k*#>@e(N-1xZCFaRG<J9^<OEO7nVeuSgCn;l*}>ci1)&?{v9P!Kk0{ZJd`VA(9&
zD-d2Z+84RYW+dt_s<lMXz=#>thW~=JCWX7xwV<2LJVO3TOxR~I3i-*8XL{Q|?27^<
z@&9hOy#^I0-4vtH06s(`#gXB-3#W<A54*-lRP`^DO@=O7&ZkSf7SHc@EB)gK6wiI>
zk1NlYXHAt*?=k-L)j%$}A`Ln#&GN<&!cyj%*2u0C7P};gRvon7F5WEY1>81h$eOM(
zUS)#=7`nOwIQX^P6<(=xr@%V5f{)p&3vs)ZI{Tl+35$K=g$NET92fk0EV`E%Ef`-S
zvF9B~e_47yeH~i%r@BHxKK^uiZy#9Vyu?A>XsMA#nc~f_m!wB~SW=Ognr*Y&J_F-*
zE?YF*^m?V+ax_A}3xI2qj;p%#^`EzJGSk@rs9WaJySIA>)A<0}#?s*vJslkzI?P+E
zG3OrJk1HA)8fmNBmT0=_>)v$?!uNo}u%@9HK{YK?gZJFXkNaX}v)}<7Kw96!!lLV}
zlbHqXjHr*-+3hSKw>(yD*|1rW6dJM)m3i9hVV`YL*F7N_O9-MIj6F%*Zt&sgPzA($
zsM8FbS|~aL@;TQ0lL%&&@{QucD)4e<t0jBM@%+m+d+ygMsyydxc2lY*6r0WGqD=d}
z=>K_%AgP*Ulh=w|4@e`-!##q~))_I9`hkn+cm$XrB<tPZxA-_15+i&77lM%%mj^|G
zsgo5E7%1bQT)^j=n_E^k$T>7aY_J~7*j%r-y1z`R=NA*?qFepFrJjCaXf<E*VONC)
zal(bNceK51mlwZXZIoP*;GlC0Q*qeDy;=oU>S)9eXb3vpqIWjIBcSjwByf0WK{W<Q
z@Sj(j{J2*wm`b7}hVizpHy~t`9ZLX&N>42rm8g$BJPw4JFb)q51upw_Gr>=-si9}Z
zdN0{+O`nCJd=Rkxy_fGhJcJ^T{eRvK5Bm7)=lZsH3B_m0JZUEe3tF*?e>hQu52UQX
z?O9{smVC`(OTaNvkNQsf2~j&W;e*7SinnR@N<9sI*K_yoRfPvbnowJ<sQQ>=m1qA9
zY5P_SfK#aqE)>Plbqv(?yPa#)7zH)h$b0sT;ny+ubcDoB$4&}um&j`gpmwO(jU)-!
zeLKDfEawZ}ZVp{ISk)uo5G8Q@a25vnCj|O2*Y{`FE6!1V$MFqb!70$Zz*(%MeNgpk
zs$tEYS&bW7*5~Qh!utBhH<?Qix2K=`e)kSh>%`WWMjO;m)bZd>CBD+!FYAEHRDfmS
z((W&x0IE0?&vgr-BnyVbQuef=<imaG#~o-DT~0Buullb$;?&i)GPC;}>!nVU+>^x`
z1NXBPW`Ko~X6M~*w#>BD=#p!@R;xPOW_CQUS1Zw5B)@F7Es2cZXw@#Szt}9HzgR7i
z6X0K0)HLEU=}^B7(7<UXwHGPy>({QC^VZZ$1wG}omnYg;_$<92X?VQBG=9_PT?;(k
z6IneFuv%^}WB1Ye{>9Dic@}q)BpAFMD4^<dJ1b~$d6Uz#eJ~2M`{cMN83x)%%DRLG
z5~$K^PC;QPwxXhuV38bfDys-3n!c_hSrl=3-giRS{WfR5k;2o(Am-V-;3sL1rsJd5
zClSK3{bN`+C&8l)nBc{u2UjJJhYXuo*b)_3a|6e5sZTLG&pPWgW#AjLjg2;DZ+`h&
zYQZDVoAM)qu%>mL)t5f_37G?3jeRK2jVndz7u9?Z!vNT_S>iKVYt(S#Iq=RlZ@P}(
zU>xI}*Q?dSyB8k^Feq-t3GKw&TM<H_Th--)b42X1wZ7nYUdi~vu&H+Im_-ohe@CkY
zbk@irf@~DKhDeg4@%+wH^d|YW$dE=d!AL%%goopG%l5)$oQ*#kuHx*tu8`2UeU<HD
zz(DNtqMM<Tm;ey8GZTW2g=sF0;qR<O1XE!N0V><~%uKVjb}#4t4;s>+^x3;6U!tz=
zp)$kjg@`W?gzZKeTu#<K=P+%=IQx-3_W(y!-l)cG%ktA*<hbfpsX6YBE59&cdD;Tf
zc1_zdvC!j0{8H5xTNfF(cD#Jqc=C1Znw@8Ct#ozDhY09U<uuc!Ty<S3^eL0);rOP$
ze_p?<@j*C_SHSLaDqU#OPtvdU$l9xBwHxmRBDjdUe?ox~1MSCYyngIIz!<BFdkR^c
zl#wZ8l_{KKa&@yd2s1*LadWq36kv{FuR)DAm%R9HVMqROX$Qri_j|9|98pPX`Obmj
zo5XhGLbe|9X*4ciR;fV(JQ;B_Nox>&oc2d-0SB5oU15lzRP*`WNx0vwp51=kV%&(6
zmqDH9olv1w){aC@4yWaY;7Xkz+dm1oVLpA!zzCx%*^ui%NKj7%G-P{L<RlcGn|bJ%
zHoe)kxif0|Inqt9g?_X@kbMW_-t%JFQpkw@?G))Avz`@$VT#!Y|IKdB7D2q<9f?(}
zu15uaR@PTuzB5Gq<MN|og&`whLNP)ou0?I~xQ)Y0OraE?lSB9W2JC~cV_9y5Su1|O
zISip?5r0D=RNSLL`aI(mU4GltY<4fwwsZx=-?Vy6y=dilo|g&T+y{-*<9H4_lq`^w
zzq^yT%*zd{X+kD7<lhM<5;OH0Zy}>}5|~$28BYFlvP?TWLUx72%x6F+Ycf+BOpWBu
z^6{60Z6e{PLDSjS-m8-}@~g2<^4il4Cm!8(hHO1Ob<{0cKs6MeIZe+!!|tHX<9uyp
z47+O~x{1}lZgpDNgBWEA3tu|KR>VPx>!BHzQW9m_{cn$fc`n$afK|63pBuN|jbqDw
zs^}jS?zoQJh%R$y4Xb8HvG0csZ7&U{CRfJ$a5uC&7ClHf=-&#vBG^_THiesWXZxiy
zV~piAjK53=oPL;Egu@pMf_Z^NaUm^bh8VNHKw=jpi_7E0;zbA}SUelppW*)WQkx5g
zQmxqhBpnuhKj6<wGiPJfOVyoToj>rIev#S^k~4r(yp#X+Eu=%Av8ltW@&whqWpRIo
zSQ7?k48-<y#q-;b>(AiRS=%BFKbr0(NlBa*Ke*mNr%BT-s{Mm3lg|=K{`y}t;b$P*
zh6S?t@$FFIP(F3sZ~LGz8BPZMB8^$L-lG~w%?3i53bi=fDNa_qq7^d|D<n)J&Il3<
zaWkidXPxnOt`xQ&w~*iCe|Sbe+7b*(L?=t%I?sLw=@)b;Y+p=;$r|c>S&Pgmn-GmZ
zk+*kLUhU8_ucBrJ*T<Svj-797uPz))SQ0kyFuba{g}gq(?%m$>e#cxe&b{F9bj-Ty
zNMe2a<oJ=mCjlBYruXM4a+HL*yf|e|1|97EX?#Y~*46hf`_jB~W@L!s$>eUxSKtcR
z-OR~9Bg}VZrWU`%QK+a!YJy~Hx%4RF2+!hk?f7XjQ9peyM#*wS3Bf-32a23YsQP7&
z5%a;P?~~8^d4>ewNe(bqIs0MAtyR_UEtu6;PhhY~`11}eU<M-Yx~ds_G3^5k#9oFJ
z@3^*j)wv&zcSf;M#pgPR9Y;Uf)@`R;U6P*U*BRPZ1)jnCG$T2q=CVd-T5Uat?(KPd
z`M;R_#p(`U1F_4^^)Ye7&GjTd6SL*w#R_JvS+Dle!*9H$_D$NQ`kwxw<)4R)__>L8
zne(G}@`|H(<9LmN<jalC)h1w<T1=zmx>}pTYwY}q#_{8dnA6Pp;X6h}SPxG1gF9t8
zP437zmEE+7?49*8OiR{L3A^Fpr>kM#SjTnb`x=p@h!*GNiu8&ti%Wudsoe5Losm<;
z*<55%Y*NyH_o<PXyi*rsVeohgHNt_RL}W4~^_q49cW-%yq)Hw(3_kA)y);lv=%v%U
z{6v{>{u%jl5ZDlDl8dtgUL0|GWNK6?U_5jdZkpN}aXgbY%G9Kb6MRfQ@iUI`tEuw8
z9)A(U9Ts>?6yfF4_c-mc(^wTwXp6&w%ynO{MHo%z<2{=sSascp<8xN=2KKe{Y+*$G
zw5q0A@lVF(ai<Wrzp)!a*33WVVev5_dWnIm@qJG*F^Ix>ze+;z8mM9KhJ$y1AnRRS
zm0^FTTQb`>ew^C#3*Q~o!Q0U^{>GryDVoZpO*6VTncVMEG~BMGYPz`s5U{T#oQM1O
zW&O&fi57j8@c0^>`o*(?Va*<|b{lhL?d&QVjxAaY*Ku=+7|Zo{VGycm!G@~w9`vcV
zw^Eb4{=}1~qt%j~$M@p!tUq6vZAZNsW$JzWrVWL_NzXCOv4p6vypOg0P}3cxOhK8@
z93-TC%jd6n+wXnjdIR317pl|+;H;~-BJB8LHBeGtD?7`2D?FXM6=v>YEEfCYMo*%j
zwfWuFBrU-S=|GQutB3Fh2`N=wtFH$rm<KD&gbzOi0>wUxbI*i6(Sd#?`m8+kAsoDW
zG>MZ%c$zibT303POm*5C+Fg~)Gohrbt`3QxA22JjiQIzoAX=HPx&e%c>RVOkM{mpa
zF+^g4xZ}7v7oFnX43fNZ{XVBWt55mNgU%*mYA?fMJ&IbMsN4;OGjdGe@^sD6WxYel
zZ32*sX}aAOUo0c*#TVNvTK<LUemaMJFEe3vNL1h^L`zK8aYlI3c29j4Is4{bVF3G}
zD(4&7OK6QMN&UlO@hstK;x8eRT>oR^NST?5(8a5jHEpd06^6Qf#&~I&(0YpPnVCX+
z^i=dd@vWK&iY+`0Wm?+k;guzJ)62xrD{;3v0tZE_ZEvjx2Q<A2A&4))`I0*89P6}P
zDiN~_(OJ7rUa8<L1k>JbX!;GV@56ld`-V_#$)^xm%?J)$=KCG!_u)A)oyR+usmVH?
zb2p@mwZ1+Na(qK((8%pjo}lPIzhvGO?aZ$lU>e6kxXz3`cqilH*TC>6fWlXHnwCY4
z*erf0l{6=0P+`v{1Z;mUIB&3i+Vi<({4RFp`rH*<HD=)U<zDW)K4(eh=0UG1!{3T|
zqQ{D1FFe6r@Zya29^LzQ(vpKRXtKY9;PpSOUbj~-1}eE8B4pehcBR#7bZAORD0ARM
z(9;aY5kc>R6q$(A&g>_hgH5RWNUEp>CT?-b!@#w15Aw?!D@X?+e}m=@a7vW_ll>&0
zyP}I7)MrQ|G2%HY4{XWx`CY+~qE3^*7uW8a)2iERjui)$G#{u47~8}QJzC<nDzHrA
zdK{^T-JfZ9p*!>PNA+UL^i-fS(IIr$InmF1iV5jF^N|v;O}9|&V%g;`kr-e)s52sZ
z2q07R)9e+xL$dkAe~C)_c*Y3cc@5Ae88xTU4VW}Fz3<6aA*4<DfLJ`#jtj75PfB!)
zAm&U49}_G&=#?vQW*fJkCL4tX3IQGD&$ou!yA)dP6TVsj^<upBFrZ$!w6HLk3_-uv
zNaokqC-1tMj6nf`Gb2@9k@XO89W<9-=OER*z`?rvP8Y;Wrzk)%4y>k=>cdg#b_U1U
zb>p7jB+q}iUSj9FY6n_|xOuZ<>F_s!*L>T&@Je=5376Qu<urQos|wl$CM#-@B+=~;
zhg|Vs(9@)~wsJ1D*yMJ2S<ddA);i5{A~UU3JC${OvFt6XxOzs+JQ)|86zo#YL0sd$
zSwYm<$*}lTvDvcEHOxNQZn$|^oSSxgoSWumlbhmpoLhJC2UKiULA2d&kt6alUTa|x
z!@=PW<H3~*_dZetOcP95t=glUTQYgc8o{?I=oK_Mz3QQOU;?F(duZPCE2W14_bV8o
zi>ad+8822)ZUTku=;KX21OWGp2ZCTS_$v6h@puQ1@XbE=7i?I1a{F%Pe%9?u1QZ=3
ztrV$u9a39yX<ws`Y?hA-STH7$73BU*aris4E8cvZjJWg}*cYNn@YIzO20817i^9v>
zNY4?aZ9`tzt=5}+8@49<mE#8zY?hr@&o{Vro7giG;&O!ehMatzx8Krs>%6ajC#rqE
z+Zt?hgNi%#fy8u$WrY(OT)5)4pa-;v>zsYEGq{<!A6#5<e|fsS`iavqlzLAB8M^fL
zGV};$(5qF#pbS+(`=V25ws^&cF`egT*f!NWC)(m`gUqg7JCiZbdGy^Be3yN7^r5bx
ztYcg}i&nMh;Op_yO2g6dvDx_dPgh}F?IH*W2tn9zq)@CFf+O_n5ALV?_SZVL-|?gR
z|EP0l<JtyxBn)lUw-PK?^U>3`(;~Z*A<$wscH3n|b;ij%`bD>LwvEf7J;UsjLHDp4
zH;}R@Mh1mEVxgIj6HnjG^ScWvkO9Rbpd3wY!XfAnpgx^8_!s3qxJYm4Hs^I+7@!3`
zcavTQg^hZ!tC2J=;=jr3)@&Ps<7};qPw6W^WV=>{<jR4=n`G;2S3qI{Hj{)coVQXs
zLn+WwJvFl1_wad4bfilfJfx<JhsSn8E&jNDL;*;AfgNAW$G@lG|1o^i@aUMti24~z
z#5NLzq0#a;vCdR<vpFDBm_$2UEGu7!@*Ar@MvDoPN-n;rh-$Q##D=4zFam9>y6JtP
zDph0NIhCr+EmZruQO;XBE#iS3MOwzevfPHCqRXcTCcFMen6p#yKt`3!V0TBRD><NR
zsC@D2@|04TP2QWWm<~?7JDF>EQVZ&=f2%uVj-@=17|vd3CRqKz2wbLf-ERw_Z`|l^
zx~lB^k#M-_x_OwYB^_1b_p?6iKMOl%T=%2$6jKx_pz2SjOG_7!Fii)ANE?a%424cS
z{5(?Q<4@@(1Q9w3*#{wkn$~-2^m@&-K*lkxwN{Ud&@RCQgVbCnY0W%}paON#=2tX}
zX0$C_pq<0tWN-U6;W?bMH-@{(??XU2Y^l?)Z7hRb3cx~Flvn;x?(8~@&~-a}#E2WT
z&BfOI@!E&I^OzHxYLql%J<IEMp|+lrh?C<ZvgWxaXJuv076{9(#ZsbOZ<zq-JRX%6
z?*QNf0pR!8q$N$mM)B9|Svw)KrOB>t?n8UXHsk1U0gyN>G<URE0)ic09MPdXTx51#
zAiVmUFAtKveRPPoEb>9n^P!>*XnJ3#m~41+l~UoRVyc*(J-bav=+nA0i?@7&BR~1F
zMYtDldYc7k)de+2GO2vzs-aZTJm|wg&h|l-9`Ewg0dd*(7CN7{th<-$;ysu!&_0PX
z_v~Wg|Dqu3NhI@dSj@W*6I1LFL$F3;>jWr0yFkvj@_EkS<xBi5p!;-~U0GI^l+EV>
z3Ts5;Cy6*I=b^K~&v))gY{3X!{JF|)ZH#!5f~m0unq@sMWUhhcS!8OW&rT_th_+p;
zk+RSFLN~m}+h#5!6WPJ^R6EL4hsz9<l!vB1!V~X)aPZ7*j->Hqp{R9Pb^*F9jNGo%
z$7|8&2T6#B{`l(G0@RumW6MN5Cu<e135EB;uPSWJt-3E5`@!O@b&MD2j>x+2HGU)U
z$d)M@^*49In34xb_D2ifNQ7Oh=z3R|IAHOgc}F(hu(s)l4siWV>4}*$z%hX}+SlxO
zOJm<NAelF}+gR~Xwe55x;mGYvL4PED4&!mQGKH<v;TR}S^fGAf<)P=Mj>To_VZg!E
z(T%`1o{uUb9q8Lq0cYn9_duGdEvK1wRnM9T+iZd=<+KHzHrrQNAGqJ+xapqgquo#d
zyC_$7fE^@oze4U1(B?yT3g5=;SBOf;YZ^2<r(s~{1vh!dLorw5ti^AEkc|C_+AoT+
z+JLB_ebJa%a3-4RllgeI)lvr}URRkY#qydJ)Ad_al-YWx-_;gQ*W&xM2AhSEWBq$x
z;D?YB0U&_B@9Jp1P@7=vZdiXmr3$B0qFfIDY4X!iu!B#=T|fhh@;wU;Uaugtwem^;
z3(M+Y;5iz$@dXL2PqSP$@7&d!6D1hqYChK*p#!M;v``0ApRp48#PnxUb_wH)3^?4u
zXqcYRj(8w8aklvp{Lwy!_@epiwi2#?kgL6VR6o-}KxgWl6Y^p}OZ@0XiCgB?e$_lf
zeW1H?G{Vzzte#D($%62axUYcXdIO;IB}2EX-+OZT(%`X<T<nCBdjG(SCJvg#mBDH*
z9!1C0sg52(wl=o*fFW-z;D~7xiNM18{t(pY6azrG4v&tUeLm$8;E;tx(|sPX_&nT~
zp`tFRgYb=7mQ$OmK}yH;cpl(D0;}!gK9^1VmmDAaI-ks`I?wGX#P4gC4n(5u_N(l*
z{x2@I?yEp!%_*AkLHvTp11BpUXSMGrHry)o<KZ@XPgBaWT*NbuQ^drxttA0+ptyM%
z3%#U*%<sWdbi<M{_}Ub!i`Ij*JJ3$Q9{b{LtrO%-rX*$SDEPhyccr2^7i}Wphz@)-
z0SI3?yH)c&vMloIjB-9yjOY5iv}p7z@0Y4<`Rv(sZCOIBvB4Y)v&1o%>Lf^>*uIy&
zo;&1A(rQ0}E*i9L(CM37cMeYMx-4z|<BkcMYA7!YaXS|Quic<p9Vf00kh@G<W&cys
zpSKIt%vrhgP{e*lxfIm}(zCn;fQWOszPBf%q)O#G0A-($zKNl)g5|Cg?>|o6G@Jm_
z<Ykv$nc6$E<S9Jw3zl!3W;}Xb-wUq&VHN~%x@7chv_X6`Gt(KVrZ}ASYV=?8#<vkb
zr{iHphstuNGW?tG-e)#1ktEE|!~8Gm-YTfhrhEI0;O_2Du;A|QmIQZ~jZ5(0?jGDB
z1b5fq?(VK(<Nn<|&-?zrs+sR(s-~uDPWA!p4ZHj9UcI{ex_--T)vs9YjK?xp_7j5x
zP=l}Oq7T2Is%p}-(M}qb)ZdK4Ga<R-hT%@6;oNHh(pq<UY00qWOD^i^vTx5u+sBhj
zzqXyNP%$M*>pY!~!?R2uw<6>Cvr&moaZ90<9FOKxyt>q8b8J?{O677uyRwjHGZ%5l
z2x9kFy`l-X_%7Uzn!bO=6o5-_)|eX@2sXbUYeC{Xr`k@P{M_><c{GZsB56F)y|IL)
zn$bLvD%#bdYJ?aI1QRbuN&E6}e-`F$kRT7iyBjw|^v+un*L$JXiZh-z`PlU*2`MlT
zD})KJ;dFugQQ%T<svXpzgF5e&G^PjJ&p3OkQt}ZKhS5M^3le)JcuwSr1(=dMI6zEY
z26T6@6@fR05J^}!lf=jX^)qcx*Yn~}z4bf4fxe$S+;J%s@MiL{Vtk)q2~&EnXK<{;
zGmXkNk~u(RrG0?&1}{$dV9KvAs`iB6PW{_gF$$fQ^)qO|ifq%k3FSd~9j_=rYwNj<
zPy5fJBWC9|s&z6dT#1jOw4qkZ!MUgvG}5nxpS`N>WAd8-_cQ0%7zr{FoN0g4BIxmD
zHzV#)PNo+D76P;PCQI~^9%Ql*qZK`g^&<KkR*cnbY(k|JYo^~z%)u{mykCVpd6$ky
zTMJGM`#PK`tMUu^5)rU;Ao_)08vr^tY7|O`;ZS;#GRP*QMglIe2qT{;Do@>*tZ;ij
zS4NZ*=_p>iF?lhSQHJVU*7X>9AGhFIo7L4koqZz6`Px41Wk#3N<!cYrc0G}SR8lO*
zt>4t?eP~4VyTU)XwnbS|6M$o2x?5RqDoo1!sw(j*&7`TAJ~};iiYg2m;KZ!<@cuO9
zx>0_6Zj2Egq$6!HJF$`)msFlGQ#zWezHx>)-&t1~4KGBLMUT$%@OS-Sj4@>K-5pAb
z$p_aD6_#U#8I^`Ap>w_svEuEp>^64+8cbY@r6sQ$rh^6S<DNv3%1FE$)3_tq@P@AR
z?oqn^y11uXa&TR<(i*=_+~2RjALU;Wc{T|`--fw7Un{TcpjR^kc7uO6a~mTm@tgi8
z54F5!R#{jH#c46TOlm~wAAKQhX}hQK_i;#p`n@{~6~wWT4effCKG&aHN%)cHJKea5
zlU+d{lEaB-4$J4U2N095)Bu%<=T7Fzr*>k0yQS@8!##KilvbjplhCC=T9d%3sTmU5
z<GY0#ae1lYNE?qIk@U_Rx&8HK;eFmNvMl(qjO?EXdDMq$8)T(N>LRU#4pP|$`K2!(
z`vJ2LHp&;0gm-snRo_Ke>aAf!AWfSZH&FvH7e0Oo{2J0%`5K?bu&@0-gha<3DZ<xO
z$XuGrAZ6$9s}C7FkXNs<Soxxh(dX|L4jop%QdY#XtF?V0TdbvL`V{{QyF=oa?iHS!
z<>1$9m&32%g*dt$tD2<2EwLP9RSR0>w9B1tx}E(?#<*(hnSdl~G)sAjvsAZsKIT_A
zT7_eI!wR}K=#_A6EtR&L4j}CF{d3z2?T-Ne^IL;Z$KwU>ov)(dF5aWj<0Mbgc~tYI
z|3i|W<4)n0;VElCa?~%p#fz8mf%frr$`XkNX@ar3no;Q?6LtJ{%F9TUlYz+$p4h)l
z0Wq<E!f7fYGwpzsiFg}x6h>Wh2Qs$%yWCiYHW}b&cU8<~wyRn?*oL`-<roN@Km!D7
zc`G4K76&u-a$27NZ6s0rF_v6X^Ah<SN4YO2`ldX&dUt>ZH{fIoxw)uCSJwx`jY7s<
z%Yh`Ojr>~aqm>RJI6uK#kP!G<mKc+cWXyHsORw@u!fnOIJSq<BIUj$H4I##xrA!#Q
zNH2Rz?;?O`>5z#^Vx5ZWKYmr~(n4#f=NMdz;sE^f1(fK!vNhw05T>n8&BtRQm;-_e
zI_4s>GRra|PQopf$~w~020^lL0Nj-64qrbU5EWqEhyYhjRb9dE@0v`+llJ`-8yymw
zc)XKf!(wlC1=jyM&wP|=aFrU>5ljR%_-Ja@pCJt?7npes4?iy$#GE?%@eRB78+h{T
z1*15a!rYGAJ=DFn>Xf&8#sBtv-6Prziav`)UP()6cs?etew8Xk6sR0Ax49R)&w6Ya
z$PoOMr1<<d=IOExdRJADha&6cg7m&2i#V3)>DRaRn+@js^Wfv1$LQJN@p+Cx(Q(e<
z?d7GNRQ}WIrb1O0;=_cWt6!^&TW4-8g_qeSmv?Fe7nu?h6J30~7SVwy(*Hp9GL5qZ
z_v1&LbkT}67P`7Nu>_OL2Z^bG^#o8-c%TGo8sf(`inPFNv=9OvX?|+*Tc9+zOGQ~a
zRiGxUGwFb~ph?iKpk1~M3yLI9%fyeF`i5bAqL;|lEdU>;SLTDJ!NQ&ygIQ&Wu4*R;
zGcRA9FfX4DtbomVvNG0g@%8J8)mGW^Bjx_`Zx_qlmzCIPB47n|bNk%T$1UhFlh3!E
zz&UAj+r(Csj&(tZA2|Wr(*^h93oukCp^5Dk6DB0=$_=PD1~D?_A>H7rJz%)PX2mjh
zvqBPE@+p5GR*9^#I^3%HkXar1ZLg*O_N+W{S8xA2YdiGZ;<w!nqerJVPq~eD^%Z%l
z<0Tn>r>R26MdbU-vD!eqo?DgYA%Aj+6H&u^m?OnBlw`#<&+^ur>WJ1?MYCbaSI<n(
zC#F5CR-v=IntSkz*4|Ky9<SEg3pMNRczG6MMY~H_>rNb8ll8rr22X`pp&Av%qLb81
z$Lzk$@`Zns%XX@1(>}V-l+k+9UzK8JX`kmCr^nBrcijFdX8O-_ZUne6R0GrA*3Y<!
zSIOtg<@ha#4jF2`Ss@t}3L*6-iIc@qzu5#+<F47+9g6F|hUGGAeC7UHU6PQl#wTow
zfvNQ}Er}$JwS}Myf+ERgYglYjJS&T99zz1@<<lo7e$gr_;H^a*8Sz-Z3atLDYfdH$
zG5?K4x((S%F<RAqU7aJ)b7kJ#_l81n!aIulpF?h>_7~t$81AD4_@Wz)MI!HYHhOBE
z8A%HBKOg?)CL;`v8d~#ttv`9~L#9}qFh+v$zHdgAH~M9Bi_@Q&!i4b)TDyHuy`A?A
zxooT4dFrQIce`8%t={(me$wMY-MN+0dp$387YJ_u!V0E?q2ZnS+Z8f8I{$4|k#h^3
zw%@JSwt$(>|95<B@^Rb+glXYBAlxe&<!M<*g+HsJ1b>8x1}u0(&CbWaiJ*uVrcD$~
zQh%o;#2}`*4s7;el~~y%_tm>t*qq1gMKQvcWk_2bit*6OXV6+$pT{*P0n8SU=vMnK
zid2lr?Pi`9WI(N9m0cv4Iwfk{6~Ct}?1SXa<wL_kmcFjH{81QRXpCfyxO0l66%DV4
z^b&F=Uta^Y7t=L8);JlR*Dj*{6apb~nillFipXd%rmx<K262+y$d>(Sb}XYYz18!<
zdhi!vlfjYPCCS-xi`Ep1l$}kr7D{LmmW+YDZ>!OLlZu8?F}KFzqLLY_yFI#d*(rDy
z5Lf0(eK||_D5n6>{x%A>q^WTUP*3tDUnV$~2!QQaEj6{_E#fOZhQi-X1>YRcDC3zo
zn`xXY09EbV%U@8`<J#{_?nynw5?8{)GOVuNXMLq?5xB>+Sj6)5)ySi{4G6>v=D&kI
za`Q~$Rux{_c5u&~{h+<oi`O$yZszVicq2fB`DI{8>;8{o5VrM?aDijkB4Hm^X}h&r
zi)s4bdL3&w`khVv(ZtD^j)eoWHB>`Urylu76U-&Hiqb}A5<gp}nkMr5<ufcSW~%YZ
z9PMry?}v9)chbQkZ^h;7AeoDsn>88Ru2g70eLAwYUFiq7=fR^Yun)9r-}cI&!E(Pl
z!MXZl)_lqvo_Gwh<bv^4&w7<v1UKHHOMT6n%R@8NlQEIv)>%!jtKqw28cpy0WX)u3
zQka*^oqc9?(TykC*R5=B0${7Joo(ax^)8_9Hv*H*qXxFw*{f^H6;yO=76Iw4Ad#EM
z+#FG?xOf5Bw@KE)2YOA;*p^wQP;NxJ<e7}T=fYVqmT9F$GHLCB)8Wy>Q>mlahV8+6
zM-F8&>d5^Qsj-}0cD?YP0#KDOXiTa#+PkMa`R7l3XPZbTQ&oq@YKy%u-(S3rQKgIX
zw&Y{5fgzLN=sXiTVU(7$Wp%)mAHzW{J<L2O5~U>q;M|s&dWt+B4LlW+dE{MnTL-2x
zk@*{z&(OP(jyAn@?Tz^*zL$5~{h-FXog1E_JH8%%U}<`$a#iFddMG?8Zk6j;IX2n#
zut_NRhO7rB?IKU77Vyd&5cT3C1>Daay3W*0bH^vY8a~BWw2JFeA`h>+^ZR%%Ct@Z+
z*|B(P=yk)NHSDwGWh<PuYd>e6z6;|r3f-)yO=$wRoqH*+J<K({>4YKsUj}Oc!U~aL
z2)$$!LF^l$g~e(PxIXf9D@U}pTh1IB+WTo#T~e=+`=>zVizZw_AIBi*Tu#POHVr9h
zY3C<5ro&?TV4S5@(%a$6^#nlN1Y8@C*xDrUSo8xr`1l8grlW7$dRiKq%Hs^?hiXic
zWWn$F%rwgm$0lSSuaDbL5|)zKk4cJ|;?%m@Ei8rbjX-<=#9!2Bb+C&RH!UI{8XTAW
zS~7|N>+uo9PzKad0|k`|1Yg_UYMQ4c(kGzuiu&ja#*{cK`P>HE*0gE)g{4rD$H~do
zw#n)??v9(7E<)VbtP7B=`yA5ksC%SoUriHB)fWqqT@=$RCJc~Qc>BXr1@kPO>PA^S
z-L*f1M|A)z4;N`cRU_YH*!*zL9#+#$i|g=7s_Jh0eCxMQaB!zxU+D2->9U^6YALTC
zjw;0JR?U@je(TwlU|?hJzFuF|Qj^{cJnMN$Pz5g^1?TAb#GW+XQe@?2L@$o#xNmyg
zX33vj+R?XJz|_R`a{<051t{R44babqk{>xjl!q30Y=iwBWRKlkPKNDHj%38p@0g0u
zt5JBXAi3<Jowa#gM1Bx%YV&qbxBpqY&-5J%N*h$urILOAjrBYga90gZXeYT2f2Q)h
z-+~wT{xDTUuFTX=XX~`f$-uI|;SEbH7_T*C9Mw}U?vUp5(<n;#R)v~Z?YyC-)u$g)
zBx)A68>AM-gIrW;9hP3V@QxZI*zLK<Wr?b3-rKHJ`_h*I%M<V72>Cogt6hou^`ckK
z?G`&T&gTwHKD88Ey(<8XOq5VQN7dwVNYJ#q1thM4m=1@%A-|=Z2Hh?c+?3tK)~Z`o
z)_hJ?G}wKr3D!F1fr0ZmD3w9I-f7V!S);h5B=-67c9|d1sUt7GYbj*y%4cojfxUNE
zTzGY2qgW3=&z}I_?(T+pLgmrKBmg1e{=)>-2jAWRO!+0CXp~A9m?RQpr2U<3F7o0p
zHK;~&1EY}>xyfX@-V@rRiX_`X<=EWgyU=Avi>t<3hjx|9=k-$oeiy^2`aq5q#KD|G
z)22Nw*THb_J5je)CLhwQ^}nsP)VVi(Y*y$S43X$z1%-8A1+E6jT|nOjXcSzXnj44?
z`Sm3b*1kdHP@WqOXX8lT7|#<eDmO_bAxT){g0G=(xzBz`?Rs${R{ZjmI6JFKr+soW
zSMssx7k&0}G3I*nlnwGKbpH^2FWDEkCM0Kny+Kd1>pkK&nAlWHNj_F3Bm|XCp6sIT
zQ5?)NY+s~Nd84!BPjHJ)VAY)=_;Z5k;?Fh5wsC*6*~}(RM2`c{mxF6RT>3=J8_M-d
zb;5TZe$|q5zvDYmVLk_wYe(Vo6uET7V>99Hb;L)Aw-R2|sPlEa%(runA_nijUVd`B
z>Cj{JxjSzdrej2N0}zq`!OR52!Op%IkvR82&O-VV0L;to#&IVCF#t|OTbTk<2UP7k
zkK_i}UmQH@^>2nMyszo*=Nj5gSk1rvRwqs4tw^{P_@49BLHuRFm6)lTdd^c+iu2>G
z6`_(gZl=z67W|Lh76?)+onbNY2J6opyp$jP;~rl)Ln(s<j(aibrujw;g**Cd03WvB
zgdyml>e>#54Mm3@z%qXV4M%z7o@`e)u6QM{H5e5cSMI<lgokqAK?^}td&u-se$xzL
z4{gK*&E0?6yG_89F&2sC^W4c^xjeZ%<3prvbKyy36NV8%O2W)xSSYHARkl+6oJY|R
z9iHXP5;5Q3)2PG$s(aZ+0s+}i?McM{#La>>fld;D0B=(t<|x&?8v2>W@q_F}GlcUh
za?lqp7jB~bW=PEFihU8+p@wq@!uIF0rDALf2kty*PkX~pr_U`U?GUMXALI-WK>%!A
z{4ZpbddCKJ)=sD*XWJ5-VkxCqS0`z!_JF@<hXx}@&vg!9eV4?0|1la2c6ehm0v^mE
zChrUQ#cGrA(J#Wh3=9k$+mKtsd!uP40N1qI>(M2xZcFbu!fKOX#G&b|`FJNzmN7Qk
zbB7#!|5}!;2g>;6EJh`dvZ$m=zpf{!qmsHdXUS*Z{OtY?-{0iJO+tN3>%PNB5va}t
z_z>DS4+bY5|K|)As&AdNm5U5gMa<!U7zn$$zcbVlaleZ2dVUL5S-AXj<2AW0_cw@S
zf6>_3>r^<c%`bfRSEPnxBNR5faNipJ4kT(@!9f5SJBc`2syapLcd;qdGW5xBN_t(-
zWE&5u-2qR-KiR9d517>oPd5?8X+h}t2c}m7U5n%oQHCCd0*ddFF0Z)JP4Z7uZPOy4
z-g4a_-`}A)x^ljb6Zp$%kk<~*r}T92SytRX`{F6Ngn%7g`e7CMXw62o0|~V@e$mpQ
zaQQg#*MsESp+6}K9*Z;{?%~v*yRK%GD%rbku8b@7pD%mJI0Kh(XJ(98GAn%}kADZ9
zZ=)EXbenYUZ}K5e1qKGPIPS?c-7Hz{nlO2!j(+j|3*L!WT#6%M8qse;Jra%ZMN$3w
zl~R%aI)U%;q=v=g#@cNgf1PGt+cC2B<+`F_S4_~mz1tc`MBZQOUM#lFxuCkxpsv<A
z>ccRLeilI(7mqr4vI4r2S>OH^!@ZW_m<TD83Z3OMikS61%7>^?Z~Zyglfb3O-+h&&
z6DGN+q2eoh^LxqWAxHMTB4QwMG^EJmCoVnzQ)KiV6EtRxi!8n5FvX`D`bV%Dg$_<I
z9NKpRjYSnTYSou*S%(YPa~4!cU8J!(t?uQh=D4YaNm}^!Tf(LXGr`!1wdhk+^k^9e
zk(`ykdBlTHE$x)@fXQ~seL<FLIW@^TIn98R-Vgp%nll``#I|12<!Yg#oJnFS6S4ml
z+Tqu~UP~lrt}81&o>_~-fqdg49-O~~-6x--WQ*o%nim1Uja@$;dD%V{`)UDciA4f6
zgE`*5y0@lEvDq#o@^!3)P`luK;D-9Rq}{3W{CYHPYg_Rrx{<ng6=WEL{H{II%~4Co
zD`o}^+2{w)qxgB+{BUE+IYq&lV@>BHC-ujaNL8jy#HFb7rRiI*z$^sFE3M=Rt*7jq
zhRP4!xiUW8@E@k$*&=nzB~!{K4Ipx^kO0A}6vV32Y5~(dT;cO<<+kAqz0(CvoFGZ$
zCdOg2Voo-)o2+N^Vfd?>4kacgCcv|^K3#ZW7++yx=(hrmIOj_TL-&gfQHRzV7Y&)6
zD@y6e-tuSS`Ux!NjYIWw=qoAAN?bXwS==7SFXEiIp?t!(dnYBOn9i@1=7)GOYxcvU
z^8|~c5@RBq^rr=@?#c;v2o1`Y&ySFQej=TOF)&ZLSewEd&h*RS)CRhnK$69WIU{IW
z?=G1AIm&HI;YbaUF61Iz40*s=5-1PmBr8yYzRhWXv!KCuy-k~nnbR7;z?RBy6|1HU
z)Ld^9hpmUJvHN>duxXUOh^|GolMH<g1yXDD`ttCsrMUe-{YY?{qpj#O{3P`H>Kg%f
zmqhk<835pc=U)fYG8`R}ekKd@U5PqY2O%zh75I*>9Fv&mx>z2(3!gJOSqX92=zWp-
z7wgB6{xpZ6eBG_WZQD`vF@oLiEA#PAbOODzOsRYJUUgfBmZQh^ZxtO~vx)7m-YiEr
zp$!<TZ+Gf94IQgdJuZ-koKM4y+*99w`NP+#;t&+XvoulA>b;a&#39_c2ov`Q#iw9?
zw1=$l?5jF|46(Nb%3H-ouRBU{%wi1Gnv~|}w|?-@k})Y6h_fI=l>f;%JoNZNL0&`M
zLcMDihQ3A+RP>9}x#E<#Hj*n9)HS{D`{2Bgc~uWh3RTVA_L_8YH5XZv3S3Zq(|LWc
zAr^nM|01eo6}~W%B-dwJ_pWto@u3CkDSt`_EwWD@s7VL6G%%2P+b+$Lq2q#d^ue~^
zGw=L~w9InQK>Uvh^pW{LyY|S%1mQo+m@8f38N)rzN4aLtW)r!qXa>gf8JNP|g?Ul=
z`?SJ-*?h0Vz`{Tnr^hyFT|nnW#$Q8XD=nOVzP<`3C~|&&5s<X%&{cRy%Kh7RmFSAa
zinpdB2JkNdoGhAl=c2h`kPbi;Kwt*$@K#;d85&kymSJxo`cXu|lf+dKF!%>SAZ(~l
zAL}9=|7sq*5&Da~XQ;mRhnp-l&C6W$N>eo_Bo}Y<>Eu^Q8;ev8yxxK%(pinZLkR|?
zBfjP6x%j$80I$8V-bTs-1Y+K#JT5?sB<Un!$_qwOS7I%dR1Qt`s$67VnsjYH-m~c{
zfSwD{l^G9^%I$CbP!8&{hBth|jujIYiH_ZcAkv$K7vidC1CMevS?f!u2h01^(SK8?
z@X))#qh(Mg7gGS-sk~UK6NII2*Ldp>K#7IGZV1vHCtt!tS?l+k@(!p*<Cw&cKjdva
zphM^cg3SHgy~jV&^MY$MJP#tVjo<2P$R^XrBDZpoP7i4oxIE$=PSk%MvouFvbeA%o
z5{pejie(bONksgrjvxfXt(t8sLLa!W6@V`FDdn>tuC0QUFy8Aui<v)3vlv4?m_`gg
zQgtb*EvMMk4g`T++e*)9_1JR9^Apv&_V_rPpErmkz|mS%yRC3<aXFZ6j6$`Zn^E^Q
zf>Oq!%#2wVHquLbinc~^$EoXuUR?x}0L=l;F6f_I9zbe9@=Tod8le6CrAau-XnPL?
zURxF<BH)J7I;YdS%h$GB18)rYy1%YJ3YO2qvm|uQ;h#9a2lf+Fqf#Sw_h+shR;=3Z
zPD1gY8Y$nmGu_m46J<%XW%?JzyjMDbbt%?+tVeyU?aw;CWd7bmmp3oi0Ei5064)rH
z7v++><IvI${Z4bfji6ar*wewSfpcrMYfeTOnE+5H3m`hFV{$9I*4Xf1Uvt7jym9K<
zYl<yiU%={w%I@g#hPaXN`3z5)s33hRTamEm#;Vjcq!4A*lZxR3O;+{28_9o)#K2L9
z&7mozr+<x6<7C?Xyh6(<%5!(B6chv>hz&6B{zp_0?gxMOT;UVrh|sNl3+9BRmGm)`
zICqbJ+LILiMa|T7IPR|PQF#sJp#vZmV{9Zu?3(s7J$4vu-NLUm)^9yuPeE3lLMHF-
zVcH(;&o7nE0#nvN_k3B=?^iCi`*$zu(stLq6Ju`%zNEH4S<=!lvP>4_3+=Qnl9e&I
zm(RUUm$Eu+2NJ-bqM3?8Bp>S?n}(VTokxlrO--&*egBBsixon<)J6I0eqjfTA8U1G
z%J;j$aO@8(CzsmN49i60>S@!O9ePLw5wiyMan>%V?9=RXtEL)K4Y%?2=R}ix7ABPK
z#tyblX44&m9_<|l%~~nO_B+Gys#^>IS2#)12+@}DhFLLo@|$N3hD1jA+-(>f?Ii#+
zkGy~16$UK=3-%(^BN{uVJJUH^_jWqP+#gzRV`I43Q7&1n(v8c|sn5+WlQlM~lafx&
z%=Z6HToyVsJ_qH`Au<qRP@`U}Xh;PUpxT>KV#umaQro-LPR8SkjM`_iJu2azY1*YL
zwhbHF51;>8nLgByOqv2tdx8y&9x5Vjo}n&sY~kISEd&P_u06pL4j*RH<p)U>7tjNs
z{~Vcz_D9o_c_r}N1c;fz7jt!JW7ed`Go6`IFu15L=jCuJt0zaSwt9deoNX4cpYwf}
z38#Ja{uYYp;@5=?v+r-$EcnFT22II@)bP>0VZ8<9qn-V+1n_}2T`XaO_e#?!m))f-
zT?NPo%kx7S38iBrp~c|BuX&hbp)<n=`J+WBs;6N|$%RmPNFWlj*9}ai#CY@Do+Yc=
zG;0y2tiC;R>|hP|BST=-q1senFGM%W8-`+I$cQX6(0`g#`Xv6x1P|LP!l~rO4N=@g
zMX7ifvRIW25-&`qHgiutg=<ikKRT5*S=YVfj~Ap~5Y9E~<Bx54rq&4v+y&AR_d|xy
z=pqtCjI?CN5zJUg7;R7Nwu$BCnY=elDZFYxD;z)KOiWFEdPF)nAn)~Sa;(+Wi0(q<
zs9AB%UYa7(W0G6HUUBY8SMUI;dw6@S-#Xk%4170h1i@Jkl1K9yrfuo^JYRE!yjx4U
z0+c}gYf%A4S?k!F?p_(wE$hL@_eMWFyq+%lcU{K`;)Cl)lkW1}SU`i6Xo|fcH)UZt
z<3HB1wLgKb8wl20q=Yw<aP+|^-A)9SxXin4&HIs#=U@W<pxXnU3#^L3sIA1|rNGnc
z38K?!bxY%4Vb{(L4e$`y^RLWwRG)CsK_4D}JlrV`pU6w1IA7y=529tdQllw@(C(E}
zIY42acmC&zvrO&vioU(!-R%hdQXayPq}tH;Fapsr7bE8C|6Q|Cv<3cd`osdpBn*O#
z0d)@EWL?j8&zG_2ZdbAZ8gkM`0NXr--ToKy?Oq;4@_us~ndPrjb7kekk%0!X-}>-7
zXNNSSARY!VGd|>F&-d7myT!-jk`a6}kT33y3U?3cX92ieFApeM-ZwQ_sa#F~0AcXf
z$3w`wnTjklERY3s5r`JvFXt3`tPYbKo-g*|ZsJd$dAjypY~Z^og(pU9s`YX`$YI{~
zESCQ(bU_(EZ5acIDnDOE`ZNngQ=XN1viHWpSAFXX23^ky7AtKf>fslX%nd=#OUU|<
z*Q;Q1w)~D6U7?9kD{bv>WR!m(tF13Q-TIep<1y*JrT?9P{*J%z+Xe<Yh<C>bMFE{<
z?LQ12fH_m`9PGJ4{3^b*>@ns5%ZeqhsI2Vkxj7a+5ayT+3Ea*BM}0Wj`aiBNvtG5!
z+aD~KOWy^6q}r$Svsvt_TfH7{2G6~3d7JL{(m<MmYr0pq>&qk^-U6iJs#wD_f&0?*
zM5CdMOc@uot>((5+75%1Z}eV3@_-SNcaS_gJ6mnkkF?m~(?P)FGyo<^5vjyMBJtC=
z#aswXWi|WBpw;YD0tnIi!6Y95pFccc02_$Gh4+IeNGh5WU~pZ%B<KD%PoI(D1<z#k
z=LrJ~Yan4L6dbku@}<0Wt6CsS1eHY>7dFi=l}1tUxt4(6{mZv<ZQ4J77W}(V>&c7a
zp*|-1#_t+rrM`)VW=d2+ijWB9@5E9RJ+1Pd46H<k3Yp>u;ge+Pv0~xjiIbDF9KU=k
z(@b1;^aaM46k-%fb7y&{UKe;1P}#x*V@cl;1aXJP)rY_x#sF~2{zqZ;oh*`CJf%9E
zx(!GoalcWUHvSz$<;ZT?48k`CB=ZCqs8ivw)wDPW{7-*-zz2EJOA*PFFi^@&?vvrx
zhv=rIcfuGa>zVu>yZ(Bs6yroRN!5q4I|ci5gQa6-$;ag_QDlsy@5%YO{6H7)1;UVf
z-h09kZ%Ez&ta5>WcC{nwDBABbi41-Ov|%F=3#?RZu>2Iq;S$Gz8BJjp1z3_v_(G&v
zC|dv_>I1KD(WE!-JL_Td8p29=6zxj6cg&fZ!63-YT-&8q@w3NOq(NhHa2#FX5c|Bg
zXw@4U-M|jOqImoVW+ZO+{<|T><{v?Ryzo0}W$(XYz<V+y667y#Ai9UmF)a;<pTIxb
zGqpv3tkqd17gV|SB+#nT%fs0Jv%N!qGun`{CP4sCdvRQ934^IN!nBK$;1((u)wKED
zi1nt!2N8D>V&HZ|@t?-Mk<|vw{WyRhFqta?K2>A31&pys>i@#OVE!MF*xqobeK;#@
z$rP#<Kq2e`*=;8t@>F}nzP#9wUPEQtkpBG7sPO@PJ0qfLEH^pwIr6v+6PXcS=8EQu
z66nC^0KjNA@WK4@rd1Iu$z*Q!?LV>a@3byBw`~D#kpOW2S^_Z9(%#Td{5kxjUjKmL
z`rgTdGNvY`4D|MTeaAm!!3yAu3`}IpbE7U{h$tW~#iIjn{g=NN)`gDFM`>{`2gRMw
zd1w6>H?oM@A|U-!EiH90M_^2su!n;K&<Ss_Iov;gLnk->D#ih-Uf|nu0o*!n?pkVp
z{~Ke^fBvlmZAy@gr0L&{nyncf0LIE;Vm?s_5G!k`MS=G`{mUsOT`-SSbqYojV6{<^
z90;8#1fZj|0qHQOgC)WqEdKz#Nb_Rmka$>%-~@R^6at>NW;V?vr4$#a6$rguwvmCy
z2|ye>Yp0p{<s0_Yz+DaAV&2~}PE(0U`=0hCr82qkt%so3a$WKZ)!YNJ<w^6?YPvE3
z1|K=>KdmrvqEg%rUw|UFP3F`Z@JF|YN{{ul)660zHN!2kQWdzHi;?Hn$?38FLbQZy
z05sBmXI661pFbyBM1uEi3K}O&I`b$Bn09=7c^;b|vQDMs^x0Dd_i@K&>wDV&?>}^#
zIzN;yrLSrVeZP$WbUcCErSjPm_7XY^<3Dt_yniUD-~gWwSK+S+nV*{e7B~xYA6(2x
z_Yii(eO$!5UsUs^oL%$>Pa}7bC+n5Xmik=8o;71Zz2^VgZ_2q;XdHh{s4Kdg_;e0@
zd!v-iN?H!tU5GTaqsqCgmf`eMJB|X0nZlLH3?CuI(w9GyEytP@H_-Pp&HsK{v5vOf
zcmQ}rTR7ar1x5V0zoVxr-r6~a@^3q12Q#-g?|u}Es(3Z6Jhrv$K*OB3iOhNbK^B-B
zPCip-qB}<zYQLpz(l{ngSOoXoK2R^OyO_8hRb?{oU%#TwIBz=Iq7VvYtla+~zwD}0
z8`ytpa@8fZa!<!@AMc1SRj~IP`|BAL5FsBlUAS}dV=2K|?_OdedA88=dz<$2VW$lQ
zM*&qO?b)G=UFK3k)6)2U>x=3t$l`7VpNuDD>gGiA+23~-dR~|D)g{{Y9M0{C_}S~n
zU$0;Cunxg+AUM(}043+X5KnqX<Fy>$DOqK89bH51bw?x24G=*;y#<IEdtV-kiVkgu
z_O26+qhB*p&Up+!p5DFt?I0~C{N*fkT$npXwiMlQe}W*CTTM5|EF<C?Je?K3f&fiB
z5WAQ>JhbRe4Bd7)c`N|1J}^#8Z5zp?=qhPZ7cka=h7cgctrbE@`WuWTCLarZ;yS>t
zqwN?N8a;Q5M65=rqg5L}GEwcml?GV9SDSfP_0;5>d7YV8yLmh1^2C7%Z)N&`;T|F(
z@lg5%ckhvQu~jtDt|Ra_+!FWhUN-V+gb7xt@#8QAR8QAg0R)!7C&4mUUX^=;9YIkM
z2`01N!d7U-Vt<PlJm4eo&R}%V(8f2668Vc^SbE^ev!q8L5f=mjWM<ZX`a)TP-UUkT
zGSO$A|M_NYUS<b-JtpgxcS(au&wbb@td+BvIGwez?cCIvi4rETql2YmtRMFt0T#C)
zoi;5_izxd>*!v~x<4I07$8MRW>e_ZPNs}W~!+ygOMn^gc1~8j&i6s1^KX|ZY121uE
z#FR8+=(W__@Gt9BZ){XyKCFBRxZlw(X`6WUD>R)`n+5M>M!U|M-_IV;A#WW{Vmh$S
zDI3MNkn|U8Fj-wbU77!<p(BNN7con*XS5Gex9*0&ISLwJi*;|W0R0aDvG5Y}ewcl&
zi)3+pYqNC(6fvc>;saP&0SI4L%KC~2dH+FZO5g^DPT!IBDZFqvV@;n3@(eV1YLn8L
zy~+rrq=|%6kG>>M*$J5rYj&``1C;Z}cWaCMg{$5r?l;-Ma#*uEu2U!ARF*x;XG`Mx
zzazn&!PR7EA%f+``!sMzP6NiKMU4+6eZaiN>hQ<fSK^dw&HEJ()8TOuS^xGgglOK-
z@6wFC&wdr{61#Vxh5}*OfYerCh|u55QHfXp?nGKpAgqD9Xzy*DZ014i0`O2{Pt^Yt
zTr*FuBn1N?w#w)@wos@ZZiFBNit$k;qK5&{_LYgk2t;#L1;V9-SRg!G3wbyk0ZR{k
zURUAU4nH75L?#?fI1B;P+XV>EkAF&f#-m~~D;3juo=*CR{|OKnDk&kd_M{yN!Eges
zo-P3~ng8c-o)AhI$Z?&3faLk@ZUhEcq|#W}fT3_mycC}U1by#+q0lMdYBC-+|94ra
z0(2q+ofCx!NN>v((&^wvHb3tAzvEMm4XtW)mdm-p=kMYMYqyy=3@*-6LOg)71c2N8
zZ|l*&=;rsI5fc^T+_$oD?86vIMT0qZ#opE{c5_9AfSZ7Sp|Uvd@yj-8VMQ#IeZ5kn
zi>RsoXI<sYBHx*LTa8I6^d>SVGGp39jT1=#*xyHjVo*%e^pJmE4sehqsrZ(q$OF7S
z_$73JMv05a5%`9^{coo5|3^scKP&lvnm{rBe`EvW<p1aQJ11`rClY5<U_BeaAt&}5
zPUYYOh-1*eb9+lj0E`ysO_luL{`kN0N#D|~|Mu4Z`|Q^LZ~mL{%=E9#Ovcz{HhYV_
zfpnhOFwIz4Xn&>CZe#iJX}d$zSiyN7K^yeLfo6{XwAGm6|2~==|EF{vlRTclG%5I!
zF%}Oo4s9@>eau|S^2e@7gppK#h`$p>E_2+#{8hJMEN4<!tD<0iXhJINARW1hDu5O*
z$ZwR&ZTHVI*x;|LZ;;lImW~mH;nwL3iw64H|6h4_jgFn00J(!l%fJI;>=zkmc9gGd
zpeiVIofrw+DLgV1%@49cRq7N}Xn*Wi3dr$9JwqwQ$}>p7O(kS>VcK2*DTx`4qo9n?
zP_~MI>kHlKDdA6lB%;Z64f9`64y`!bg!lwq!&UAyH6L8d{}^0Q4Y=$#vLw3%a;@*@
z+1T61j%09;24q*q8GZq1msD?Y#0(#J#WhMV^BX>k7+C(0L%Cc+TGCZC%^1}9p$hVz
zgG&a|P3rg_)pnFEO1}`^v<5;%7UKPfh(2Y+(kt?(KKj`Ez%vXW6$ZW;W&GekxfeUP
z7eskDx=^j6=qt>Fw`)^)PKvtD6IVvB_x0~!Jx21Cr2gIOW+FI0_wc>(xbO6PNHC;D
zZ%B}VMJVcdbdfQd356HEmH}}@vSUpr{Q}a+iC-3k3;FPD3I_{?>f2<9=xk;7_3|Hk
zaUk+}Yvq;)Ng`eFu2<Y6kHu6Z{q5wU*_p~rq6w$0Y|!qd>ZU;eZZRGxNzY!_&z{J>
z*%M0ao-k@2(L|>t(2O}Bv6qK%t&IHM<i_ZJ(*aTW%a6FNWrzDYB9WNjW6cPM9Ssc$
zq@%V?BG|XN<o-5C9r_k>j50AJ$zEqa#m&T6PEOFr1=;1!(MIAj!l(=E^s}Z+s${=s
zy<;{7BnK=rf9O;6sSqG=(CtY&4^kL#Lzr;$+0Ta`#TeH}swFFc{KL!1*%@*;gbdt6
z{JgMbjYS5ljYGo}Bk1{?JGK~#e=bHkkAlWuB6mNVVE?DLp@|DnUym7SRfCbqXm?Df
zTGj9P`7g9!bz@%J^jYlN#LoZ66J!=Ze0;Y9c8~pdN=6&PfTF=>Jo{-80gLnK5D5o<
z(VY4nYm~=+pgnRmLyCFcb{%~=>WHT_q3Z{PfRwg6GBrLXhjnJ&c%W2+RDp`0G|hzA
z+VxmR^>a$L&qCn>95_$&y*)i(sgHi{TP%)dNt;C5;Z^QS+-4h|7R^^S-nV$hfwTT5
z-@DXFdenMs`^sZJy-NPpjZ(HVAQC`}ynA^{W?P1RIDs=9Y>kVO1ZCg?_Zuw$jj8rK
zaOodZX>X&KO*ABYM*zcQPP`>ss@ot9E$zG{S2<EF8g08u2EP6%3`~pScaIImRqdbg
zV;_P{!^u-ja=T0mNFa7?{-79U6+!)pVkf@-T=OS+*=->7i2Vx1?K6=((vs_GlVhHe
zwI3hx(Uq<p@?94{+FMAxdSh1`i`}c24hYU2b3x}q_hOCk!6v<13}Q5R0BUP*w@qeO
zIN)nH?ZEEhs6(dxUCLzosc?KZs4%JLdV+d?qFV|qSCA<iXik=CZia;1rO&gjPA3&x
zH;%$OX|rfM<O|;P-b3kgqFPC2yGsH*-rr?1k~aGh{0f!lqpta|TYhLTdNbj?rJo`&
zhwyKkXw>cSGP10)X#?3bsZR?Ba{*W*ef=+Vo#Bj|7w~<Y2DOA2whSNISE2*?+QvVA
zr&BHnTGZr|>=AP<NmzsDIFh$&d2LqP(fV2}2ZM{)NGYIj_v6Gjlx9-BHwkVLOeUWP
z@KXa(KIA|UMHR5a4duj%8F39JY7kN=+iZpLa(HU}tbNkIkCC^V6itqH`DZRXP}#8q
zTe9!>8Z85a>g^wuMW;DRA^k$JwX@wxgydkyoi6fl1-pe;O^qS$JkyVlgJAcCty9b1
z+s^j&wP+CfnN-Iqm{6>4ijka9$Isn8^NM+UsUHJSPd-#@7yRiB&bGh_)PUdcO`{I%
z$b$7dG)hu`jTocVWG8|u@O#xc0&YAr*Y)ScFw={;ZD1!u_y2u<;uObgj=(uG`M(K6
zHcmR;KZamPmvlnz`U0_X0jjB`onC~r*)3m4@HZIdfcVCssR?_o^66~Q0`mtke29d=
zK>VG+;n>U)Qq+9ZN`iM4BwY^gPL{Jj(h^Qd%T*B5VWcXNRo~#n-Zug$qbvZoSpv8T
zx8+X_&t#;QJMCv6kn^vx;{=e*Ei7XBTU>^6{Mj9}mk&=4Vu0GHfbuP2YYVNU_;-v(
zjp<;wW70rCH485_dhN1WT8x%^qrC77khrO6gqAo4#7u9>-O&I$k#ryp1CER5Ah69z
z<_XZ<+I6N=W&tq|ik!Zi$VXh+G??7?tjd3v%=G%<DK<i&Mt%qj;GHX4!@@Jt^h*X^
zB-pZ+b;#LuReh7OBEwCTVk51xCTYe9)#j4lnfyuynT{+al@$@N;qd!?P>+9s;Fw*f
ze^r6l&-zrFBwB~s`fr)K9p9pe1*zb%7~?d68a_LN@ddT{y}e0MQAifHw$tEk6;&OE
zua7rCVIS4q>fwqQi|L|$G3@BugqXy^gX_xH0TbMK>O>VgQVQg^oH8Bs-zFvV;)@I9
z<iOiP`!#Ng$0U*5V8K)=idy>~_!*&#iCEBIUTnbu*vLDlJ3N6taL!>@l`S-@mYm&W
z3>?d(joLTESP?>Xamw=jKQiJ1^&&gOW3wzG1F&z+X{};M;ZI*c!xC!6_ZLW$quPyD
z6kr5&Gje<yKy_8IRmNsbVgGN=xuLv$91L8%8Dj%${4KkSW|>JA(}lxzOzu^^M$B}M
z`$8l3-BBio?8>IBx>shFZn(gj1%CJM!j-j%CK43sB^~Pn!jd+Sfa^t|r|cGj?qws1
zREFQO<H5n%1$%bhqbLd85$ItDObcY@cFkYD?{ILh=}WorQ&y*-O9g5~@vznx!LJ!R
z?IXoLZ$h6K0gmoLwbv5u*I$B(iUO#{k>74!#nx<Y-CI`L1P92s(dNIB)^b%r24iXA
zL6MWm%a4MG^<LzFg5Lx9w%+mdnzia=z6*xebspqFb8wT83zj1MK{SqI+_ERF((yyP
z$%3yX43gE3c8Je`&zUhCRaA{sOOA&Z5la|#)TXLLu37&iP6ThcLQh}OkvPxA!)^kS
zI!Qt&_U#Lo7!HDV3~^?pAC9x<2_W7M0+u@n#k+JnybEJQ6xWzBRGuFbTUD1VJe4xi
z^`$!1gc^Vx#HsdRy?XI0F6_;!M+>5Exz8;2?j%WtmM09dCDOp^xr3W+%dJohrzfBL
zewyDSTp&QeyxAS{Z{?l8dTN9gE<aV}N=|=PpC7YakH}7wupUJIf}U1fm{ZcELG*C_
z3^?ocsIhgOm@zP>g_TT8p|9Vf&%U7*C(Zmj-@R@?@bq<Q4A5_6vxz!gI9n$Hjwhlq
zNgQ|p)A8)!f4%sIKg^shY-Kp;U)?HQN^osyzpMASU0zQkZWd3?%<*Bad(31n)`5wy
zVYl?TxoI3cdp!42NO`f=7_SF9EN1$jvUchVbF^SVhOHaW1*_J^2w5KyBZ_u6Sp<`)
zu4Ie^k!hd)dXhWhcT6^L4=8Zk?j0rGia<(~U6Y60>EApiA2MCRGzICxyipLibW_qp
z+=a7gYx9kPz_P9aZLIehXYsaIRRwcpt^FgkA8#4b(EfmP>7M4;-wo40o?zIvqhGg!
z=jX3gfh{%}M*j6J!B&MMty(+fK#}8rNTPf!0<aHOVviQzrkBKZe!C5hDctv*6D1|L
zJt-PL)E?G9^(Ut7Z4nTr+qjS&hzSR{7jJ`ploH1tPMZx}Gc_p_-LJk%%S5VkaL$Uq
z_OxZU6AAfsjU-Qw`F&Lz_IwmYmYVf;?Rd;oCx1D;eZ2AL!s3A3wNx$7I2K6bV||?)
zhvwMvs@AN4p1c#YH;Y_({%E_8QRl;bp`qb*%rGW#rbiwP=@Z?v-Z9s7V;SzT6+mn|
z?44X=^3d>$p#}Q>Es-Gl=L!U?U9-Xn4TixR7X^w}$|wmg0Di|{4_0U?oGGNLLl%S*
zWeHRlWDzt6ckPoR74a{q<hZsY{*1}d-!Nv?W~+C2-j%e(Z9_$<<>5K`I#=QnTVXAl
zfvUeY>yQD9psR#RNbyzHWlct-?EdScm3AR<0K|Rf87_-JK&Itw_P*-AcQVdl-D;;b
zfN9-36CUx?>LBUpFe)gx=;d~OLDzeFUFJo8NB8Ua)n|XUjJ`$o{DWUx4o#S0L@16l
zvrO&|u{7Ik3XXh4p@m#kuUI7IbrDo#v9J*ub6oF-uw0sNY+*k-r!?x5=S}x~#xhbH
zY?BK*0(I_ynyjv8D^0AIS44ZB`zs!8Ow)Ve_G8%lE+q`^{k-!XT`P`iW8K&dI4Uz(
zv+?q$?Q$MlF-dxlD@X#whc^pRbgQ$mXGby)*{F=V4u7X)nYJ1)`tyqOd+DZ|U+h)&
zZVPP9hON2vZa@}HT6*O<&C(J>a&bH+ySrRBcj%S+U6*~<DaW!?ud`02r{?^iyk&9@
zlc~>%ic8B0oh~V@WE{I1UIes)e`apYu|b9^3RgP3y4LIa_1wMYAIdLI`-f7a^>uA#
zPrT&*T!m^@zVjK2+#0Tmb<DD58cDg#Kb1!3jSb)7ZVTZXPl9BZkb7j$obrI}`w6>T
zo7dDsm<7~k>qX*EM|VRPd#S6@;70Xaev+@5lssKFgFph3Ili}zE?A)rab=xGAry&H
zMNvWzjoqT1-As>M$;pOq`&0_Bd&>VrR<Yybq-{nVoAk6R-*dJ&T*(pZs_NusAxaqB
zv8IIFMrIp=v}ip1wor!4nmp_ehFZ<tQcPyWAoqMP-oe*`cbMBAWdGB+RKb5`JFHV0
zj{|~SuFs>Y!*0*=5_8eB4U@VX&1|=b7=Rt6y7q)~%~oum+S-;U%w~R%JC>7cMVJo}
zWjp-U@e`zETK>FT!qtfvcIYaw<1>lWPK6vR18-Nh9_3noeo)IhA1yGDJAO;(7~Q1?
z-Wa|TUtgHQO?Az?^<29)_AxC-7js7=%~<8=$3=SSSMTuVmvK+bUjOkPCb);HnUd~@
zIpN?>pfE-UUM$(GIfUFzr5-2OpAHFiHPX0zI;=#D<m_h6M7<8-SH<b5d~5twyee96
zlyq#;eaUgi?m#9nV{)CD!j!CTbUCJUjX;BG@5DOVO!bz6gIq70IEez>mb}L)J^zW;
zu@oAPQDZE9T?MDX)_W%Rj$bSN6w*U7v{uI*qRbXsD2|bdmwGHWO0Z-20;dFW;1^Y!
zKn|^>I{bEqV{^&KRdAM@Ebph&6)rk_S|@9Tozd3Lq;hvuM|lAhH<vw5(7FH+Yct;}
z5J|1M{YElJq8b{-l$+T)2orAFeE@4RN(a9{T>Ckc%~#Pc>}3+?uRM2h!i|0P>@UqY
zFoX-xXT)ah6N=v<<err7k*C_I|9~jpxi0Ycmos}jl{;C;?XE_LObeCR%NN>)r_T=?
zrA|tmw|{hlad3S^34W@|6}E}y$u-M}J_P=rp1!$mA>^suml^kEIhbGFD79{3YSN;1
z9fNQ-MsRrL-IW^gS-=ih3Q~$paVfv`%s_xnaoTMdb&SN>^Z3c@!9N9>I6zaRnB5es
zPR#G|Olp56LgL=}%!)9Oz`gdFSdx6EwmiL*))gntwOmb2KCXTn5qIk4?9RlU;ruQq
zm?(<!{AE17XiucV_Q+gIGg}0NtRHvf_{`7>!(CBPdiwdM2OCC?B4Z9yE6;hhaO9Y)
zmqwBzb(z#s?s26=lh(?$-cXf?l=q9u12|&8ZT-tRId3nES}%%(T-wp?bGF`Nx6@gh
zi<tEye>;w`Qq^2^$Z!}F;Yl&+e(Lh_Bq_)bY+DpoHW=EPdLF8_n4^VWwDo~-zD~8n
z;_>Ed0963WRLz7d6d-7)^C^X9**b6Zt;{`7I!ZHFF%T!$s->ryPnN<oWUJWUfn(|7
z7&zu`GU;l!NzBfaXoQ$ol3Qc?92HNoO=GcEfpTJnAGVTgwQT1+o127?j`8=-vcp{s
zz4b>pYtCf@-!alfu5J)wmz``zioQ2?hxQ;3(ON6a;^*s(MgykYLUe~c-U)0U+bCRN
zf+VX3Zi5QW-lEkvFW}kOG{?A@7K9Qb$Z<Kw3-S5<7g-1r@|1xH-k+(3g%AO+2T}|;
zj~;)DI`OpP6SBh2sv6N4LrD7wE`2T}Jbnb|NW36a@?dhjaA=+|3$+H#c?90LvY&o-
zY-IC?;e~rt=P5~#&Z8)KnOhLhWFfYydyw^_pfFSkp!2VUXA6ykp=>~0%KIng9R$oX
z=)_BVrQl#lXEMX@a-AjAhq&!9XfU{hL82gGXstbQFpS}__e1BWMy;B>LTe9%KUWs*
z>NaE!zjoF<4fyB`PhV_hfWv_OxB9YiYH?t)`~0!4Df?VN$tn$rt;0`KDI}cn!Kd``
z)6X3^x~5%Wfb2P@Rx1yp#`%RYgAP5o{18Z$D;{?i=9mbQjDN`){sgJl=FFIEjArxU
zyCp-+lw&i&`eAJHrCB5l3r5du=;yIm9%iOcM~d52UY~HE5l_tLvU8=Kd@F^uAoQ)g
zNfND@pFXmW_lj3^7bkjV)YYS7uM@Zu^iy)no`@|n94g`+#;)L5KD&hhfsi~@TD+<)
zQ}VChDl`K(dxAY)N58(C<msBj)~}_rdIqnxO?KoWq;XhxJ`R^slu29%MIPua4ij81
zB@GYEi8bKhXU~IkHG&ZEgMKB_6-X`B@f#WB8eVBy3c5pBs_xKwrNv<~{;@fT>BTJ7
zy?Xdsu5SRLJGvvLxwDj@kF&|KVA{df9gQ~9q!Q>h?xD=_DgS9kEbDs@OkyG{u?@8x
zgfj1CrVlEyIYnqX*Wr_60}<?0C_~F5bCt=OsQaW~i<M-JVH2FNcWs3BzMuYrF_E__
zaK^y@FM$&5@G(ZIEO*<EL|!=cflfGe&;OZZh>`|=$m_Le)mw>az-niNM4D&C=Ldy&
zG^EzHn6!BO{O_k66W_mEnDvRr<?R@<YtF4S*qj!5%<t)^20dE{Y@<Fn3+)|Yt9XTS
zG99j|ttM`1A1GyRs+^6klkIrIW-_z7x|w9KZh*_i3Mvive*d0!Jo=`4lQla?;+Skb
z7PMMAU4uwUd8}O<N&$-f#5>sQ=oL#%t*u8;sqZlQTU7LhyLHgEPAdoy!nmkLGQvt4
zshAq$#8;z!c8HprY_9tLp3K0$aNb(XNcID*1r116&qhINkxFbwo<>*6e9T$LLe$!C
z@nQZ8I%<^I=rvmhn|6fHpP`HWmyh<t2b+x+C-3i!l_AHZ-e;lV-^xojG<<+JDSfqa
zA?__q&%eyvS-?;|yME+IbMVxf2~OpdaqTVS+ZZo3oN!a97uZ*=*E0=F7*qdY^<0ov
zBN|)X1FEH$j2MuZb;fZZAKwr^Z4L3*O<e)$j`z^hu68AvRFo*w5T2OhFW2XR<T{;L
zZ4=Uc{5fC4s;0X@r(6HbAhUlgm}<J#?^r(lrs+G5&9_bH(lSw+)0o=Ly<QPgS9U5j
z`N>vs3USR&oXn;aH})~_yt1oqiSnLYN>jgG>bTuUuEK1H67uxZ;zPX#6<$e%#@55N
z<++{Owz$*pJ{h<7!~)ipYBUJMR0{FLH)~keISA}}#-kKfU6z7WhrNm3i3Abbr2TE&
zU#T|mYUHe_ft*3D6g_@<@6VCc0XGPEZ~EtlbrM&gI+CjW_5DMjRyw>OUq{WXAC=Da
zDZ_YTmcX6jX3qG&_}uUGd&1YX(ha1vu$Hr(C#Xl3hiXG8*rupZ{mJ6Q+-|bN3gOh`
zE1&n5hTHR#s&H^y3tx21qM%)bmM1RRI_w=8;I<5<YPE-VD5jIR*Gtze#V=IWdoD`D
zP#bM0gjyFG2#CePm6F4<+t~wVOtVXn7QP_U%e?ntfM`d5FF+~3LRFaeZTSc)0%dv9
zRF&=A0PHJofgQUg?+&6WIx|=0L512|JwS|QepWdFN_Xn)!P0U=c+KNWY%ik-S{kp7
z1V6*t@xoARpo$&ujN!AtpPp@pxNI>FJS;<zi&*YTDzm%R^?x+Cm2C64&T2yEUBU&)
zKGLE8g?xT~YRh<*2TriAtm)^&GbjVDP=0aD8JKshy{wI?>S#p^?DDJ?S~VW<Z)9p-
zC_4m(m*v=IYyL0p-ZChzwQUzn2qai=cWEHFJA@z&jcagscXxMpmqvnHa1HJb!6CR?
zkl>sqd%tJC`RdHn{F*v5e^%9MS?keTujjg{sKu!ktr9UZu_0CjN!2n*RUG}j!+r-E
z0YY?HnBtzqSIpJYV*SraBOK)7HcBJ@6+A{Q(%~tIi4N)jias}lJ`@^i(SllR1}^y9
z9_qCd^xDpuIgY}jqW84()*Nm&MkFW03>+#pLhBt*h5~?9wfk}(KF%u9+~V9fVM@ca
z^Ow>kH#$kS0IC<PUUF0Mf;JX|HVEC5<kL5W_L|%_0=OXyw#f9*@=tUR<_sKjZ>CZ)
zf(k#;?BG>U35XXcH7FFdoOA1MbpQsyYy^RpNtF!{Tutpay+8<mW)<C>Q4TvEg)N9j
z^6+F|`3L|w2rqMrcU(*P#kXocT#=Dcr%9M%Ebh)vVXBh=c8a{DfT27)vw-ig&1eAF
z^kNCvK;w1Q?aa@(X-?xEZ0fqTyQHGjn!t)AcD`)Mv*uOY?3juqedI5Ca9@d$i)%Bd
zPoD=R?<%uPgfljnYCX+cw$DzNmR4a|;8&)N7#UFd^Y#Q>XjZ`+vS1yHlBm%Zfd!?K
zwmFrCl#i8bMMndVE$offfAT08A6;O6kvP^UTS)8d^*ykEM_jD+8e<;xe*0<|YO7In
zMBVcpP8#;b>FP{XP+r^gQZwsITDPwhTti(H84%LXhq*X$#ktEj??D^@0%mE-7T`^k
z?<Vp54V!_rY8=$q`#l(^dJrp5`KPRYb4)i_QV&E~SiAE=M(-|IvUEr(HB_b1bCQa!
zlp}!#q<2?;IIUJ-2SVA_0-M&j*H8ch0*x)|h;h3VC3N4}zWS~Qh3E&Mixm-p=7#d#
zn}LB+zLsA-sTpJ2jxEy2A=q=kPJHAo*&bKDLW5dE+0NrmeDB(UTx!*D#=Im?E7xo1
zZrr#ELSu<UU5FKwZU`oGg@V<wFohCVJb%3Z)zH<rg}%c`0vNcm9jt9@;{xaj*bD>E
zlUWGKP>`C}n61bwjSflfa4aZ&icQgy4Ku05)zxUzwmvr($--cn&CD`ua2JI{-NrkB
zi4Y`vcqmDVbjAudCPheo)1PsXK9G9ogQjXrqoxtGYG6poQ%!ZGsnk(vKP6h15Nbw?
zzs%-|lKO<oGqvqkaOw=ii4oF&Gu6Q|%wN@Mb@+i_)gCS!!!@1xU`-bN0W2IhZt9`H
zNni9Oeq7pU*9ldsIcNUnFoS<a*D@+utT6gGLnFb8i?R<`%UHxaExVWWwo(=f-LV{%
z6o3!{DL{F{4)O4&d-hNLC2!5_*p!OpW*7Gn`8$wQy>Hz%%R=E;z+rnxB{K!fwyH4L
z6JgT@<B{A&Zgbq8CgOzYu^f4BGu77h?F2JLn6tPndyY(Qi&{g_!?IY^tl)@76F#=A
zUO}5&P#XokieQmxG7;NX*v0h)bpMg*uSbO;Zcq}c_c?0JpAv)s1nBrE!{JnVLl(2)
z@Qmt3drB4BLCO7;1ojJh+9}S22Zy9X?t~9njoA4G1sDM#NPYcE7(PGVn${GK)rIpE
zg~M4pDB0HV;X7zjFcr=AougrkT{%z1Lb><(&YKI}<}P-(e#FY28LB6@M>o%Zbkiyq
z8d4cl_O9GS`^C^4@(!FGD+2o(4_W;4YyBKTag8SL1HidY;DrVy+;j3^fI?7>3Vt-`
zePibyEMOfhU;%xb21$NSk|Iy5qcB>ECzu#ij!8?5olO@NY6y!2T!h9~sxZdIJFqIK
zC=|`{P9$%Gn#oUEYMqR9REYdF(e0&K<ttA|_|v>f4B{743UZouwA&4SGnt7mQl!C>
zY6W@YDO~2=7cm@IieMgu<7R1yKg;_8hxVCB6&0)73bQ^S5&0J-8}nUWC8&1lwP$`C
z5i*hTK4q27Yi@=K2u6&nwA$#n?^57241Qne7%C@JIsfUTL84Xvdo-rN`8~N+=F&tL
zoEHJX;&R`p5l1>JmT}wOW-9y#^ama;t>|^T$fz(QdqzCcgm@2G3FST4MUv&~FN*x<
z0h9>1=<kJJV|8Ar&-9RbaJ0adrC54#FQV1MLHwubGB^H)entl&TSWzu@tAO883_Ws
z#U<_`aid=atko1HIQjlz;mm0TQFXKPL#(XnbgL50;j{{j4>1NAzY{60S>v}?5&<)!
zG$&zvltcBAxn$y%%apZ-+Z_}o#Sl^*@n#eL%AJO2)>uB$0!ev!;GU6u9xz|?D#umO
z?`p4ZQHAXgn6Ki$MN>YQLwR#tY|yW_5c;m#bV`Vi>yptGG+h><-GBa0bTiZ-nuBc2
zhcns0tLP1GjV!g+nsx(CB90LiVfQ?equmq^zHC*4?UN)N8wH`~OSAE)XZ?Hm8bKem
zI=FSW7Qtbw$L$@!vlfi!(--`dXf)p4iAywz`(++C%9@Cg9XuaR3+tTMoZ<rsfr1DK
zIlmQ|8t=M^3)TGV?1((Qepb$WGrVJ2!p@=HK>u{l1lAsi5O8hQ#*ID7eAk0WJT2$R
zEgmt($I!(=BYhD4Oe=nr(Tv$fmJj$K9PZeurTr3Xk=~|aiL|fDwB#&ORrc`AP02z<
zf-{1VfHC2Utzc6A(h10?N2`6Qp$f)mZ`H4;K{v;Sa>S7VZ0E8Yk>iDdVy^dWraJJi
zth$a7^tg+<B_?GWve_16k+xDYkVJUMofP^-euxwWwljE-44EM^!W2!2=ND0jy||d-
z<PQtoUL>&FTVcC+l?ptsmrH|&!a5&Kb=p)cwz6FaloCalk48TwbE@CoBTPH91<Hvm
zr5Iwqje}>VX!rF&w4Gv<!54!4M;761y!y9K`3=}ZU?fRhJ+>-&`gEnhDKAdw5gqfz
z2!<)xl)5l;xZ%-rV#Va(ENR>Yh&Klj_{Rm5)Cn!x!z5N@x@=~E2rDxE<3LL%olAAf
z6B9>BQOM!CB7j+QKwV;no($!t=n89dateTPF9U>4%{c-(swP`S6KcV*ftA;Qj=;qN
zJP8ocvNVv;KPdn)6bGuX0a=DBg@}Zr80B(?U?WTN&eVn+O+~+-$*~JaCEt2N9W#<o
z>6fdB;zivETq|h;B%`a(>&XpnXZ>JQmA7<t&7ch)l2R>*S2|GwJTN!g4-t!^qqe5W
zdv4d{^+qdd<#Amu#sap@r?bnPfdLPWg9`kyv5sdn5cD)e6?eR%SV7v{xj$eW7Y)fv
zL8Y-uWa1T3;q-#`^s2b{$>h=T<DzNe8@}k?G0fkd-UT2%_@Q#p*~Jcr<ixy_x%+TW
zY|pOg6no4TelH{VlK&FyEyfQuLX-3)n|C%9lUsG%L*thrF6o9#6LXJ0OhKw-+>6Ue
zD9pIX$bU#2dUMCNBF8LIkhN*|9reHkDN{*esSy?Lo;(owiFb1Edo80(IubFSCwF-O
z@%!Lax{0DcWoxPMz~6L%u?&4qy~@RWo5j9lLzwTjT0nITxnLK#W5;1cYR3XubxOl=
zcK`6xGSca`Fw+DBLHzW_9Rf^S9m&KVWmEuZpSy%8%`!vuiOE(Z>W?cijf;qv*<b5t
z^_xHJ5#nNl<ahKmFZ19ZZS|>#5rmqI6{x-K)N%WjL`LmaKi_DxR=Sm9<+#<sn0$1x
z)hBNLmWU0^znQX1l4O4qb7Vhb9|IX**u}<ISnCk2SaNtHWZh)}oM`mp9ieC6h##I8
z%jQvUkr<ljriq*G1Ull4WniUATujH=DpqVJ0ssP{t8~2{gwO!=O%w{0FysVthH2@M
zxKbUz<fw^}j=e8IJpsP}8Ys~*91lfw-Xtss%BpdKwN)v$apl^+j$;xF)4``27aP@u
zCytV=<=}u(_SNoySeXVg`W<UOS1n~6nM;q~n)h%koi<Ufq=Amqc=`Igm4N)h)VB0E
zLz<7AO1i<=2ai(fvOy7%1oJy!EtT=_THmYo4l-pck*KCkaTZlpcUD{U*^Y3C4}RiJ
zfx!_5BW}0|I-k3{h_z+Nr;5>AM9x<p=v}SVXtgz`!igU(SUWDO+%=yJ(GSs(It0Gq
zuHTxFSEgzOU@HTdT+9%5>E~my5GpEgSDs6wB$3ctQ|w3KL3kJ6=BKTsS*yQLp}#`T
z2S5KURHMz^(#VBwuI6|fD-+u)7|(+(;Rm>mSBjnDR&~Vj%?eJE=#ps2H9GmenYj?!
zON;7U5GTS4?@kObnl^5FvvK={Ys@JWBZ|o%G!oogoiR^dbBfE=k{Fs8q%Rz6ZJo$t
zV5k#U3$6h*a&*xUkhN~Qim(1GHHo#Jb;#j32?-Y^ozp}fIAlz&nWUxt3>ueAg>$aB
z)#d(5&}iN~5a}vTjj6$Q@D5d|1&#GlEJ*%fg2xcVVO(a!USE%6_rvs{mWR}N2@!P~
zp2re2fL2m5`Ic8*B|)aaDi}*#8@WwIL!V5Bt+sFMcG>Vf)zv(y_z!_K2~rGde@tpY
zF6GFJ9{6g@`~_br3@2#@WouI`#b01^2l%Klvju(hWJ`&y0#q1%1O!xg?4DZq^T7-=
z#j{)QX>avxa?(HXiTD<AMd^Nf^B%(B*IZ)l*+0Rk{;xcr5GDIB-Fzv<@hRpcX;NnA
z*O6w$%~`c;r(wfV5;Xs063A)xM%<HXFX#{?r*eHMT`=7q`J|eLB@)pFoAT4?C1_cJ
zHd>NhopZQZ0gD<BiApU(b#bHr?MxnQ&6-%Z)oP^e)Z3!0?fyI4bWVx(_kei;v*GTb
zfL^%xhfh3{bz6tGQ0>l+B$=VEp!asM=DQv_UEgVO!d!l86{`i}x{P-Fr(12i1g-Mt
z#I6DimPJ1efqZ7#kci=T^=b-<88kWwLI|Ck9OXZhC{54K6@tI2PPJ9)Zd3TIGtOM9
zaA0-M?PEn*n#EO&*Tg&8Eq%hbsi^703Zww`5@CRXxZn-+=&CTuAq5hbF~#iks2#h{
zHeEG`B~Zc=_1&alfm79OhL})#SzADzMzE__Rsd`8A%T2y7?@cSXn_)``Ow~P%@u=S
zCE=a>ks>hm3F{Rq(xw0yAMDk}TO)%|U<3f79H(O4uBjd0`pXUCD*&hw@%1D#za?LT
z<~mHqsXq}$f!9JLfVu8dCq?De`kA*}?+QLLYeh#X&3Rt*l2rpJ=J{#AYW9vGB{}!i
zQxgXD1_#A!i`E$e=s3ewtAwRI!ah0_7BL8*iQ4xdFkK45=J}I`CK6I`BS_o4tZB~B
z@FOaBy`{9_?1-_|Z#Uc~?UiR04j&~zbu+eL+*@{V-Tss2J)|Tx>E>WRM8BSd{Zdgc
zIY=Z#u2Il4oP)Ote)`&nf%&!98fOC#(766g+)w0)a{o1vG|3W3lN5hi0x9F9RuDZq
z<II-kg=xLrcBmxitWF73p@|424^?Bx)+%yB_!YdVKuTv4ERO@X5pd5%S2kIYT$k92
zm7V}I?VN`buU}pqlgC7(f`-3UT1{rPA8v8^xmrG#7ULkYjR#M@idsA<`)gD!q}C6b
zsbWL#${%7o2kZ3jD*{dU$D?N;2nr_WHRB7Y5+OtNEccQ4#(Qz@NuH`Fg0};nVo*1x
z9L4-FIECrU7OjIApSfIXoJ|0|*&ZV**qKnUBJ^a@DO}`62!Edw>bl5WWL<mzaiIcE
zwSkMjM5wOPtt%6onuuX9i;^3G{_6zjj<twyZ4X04LM+46z9+&Sxo;B@GYvC*I%Az}
zCvG|)<;Vf;c(>lv{m7+=PTiZOTcNUma~wE|`Mo4MzEZ|e0h=3AnwE|x)3h!eRYj9f
zqF^&3oHW}NT!vBN`uk@2><1jsZY3@RT*nmr^CuPnUEI*ISe`N}vNE#B$~4}SCr!kG
zCQ>Ql%I9EQeojvjw~m8~ITr&|NPk5SMYDx<k6~=9Yl8qIkB|hTM;()AQxmjdB+n{-
zdj6Z~9-C)h1r2zn3Vi`<tDBaI?J(6Sr$PgTHiYsXV}!jx>m%4<CO%%jqPJ+)jE!WG
z+)|qhfpbDLnt7(fe}oZkT1l!{t<ItQ71vrzNav;&rvfRxE}Lg=Kp1>8qh{(7b-3hy
zMLmy_P?>Ko{IUPJj8i>B$ah>mSI6$1Br7PsQXNoa;&t_Dp>{52@;+#3h%GO7qGsP`
z$!n0!M&y%1sML(Q(kd^~)A+4GB9Z;)X?97J3Y>uZd27L~&E;N6n%RUtKeHdPmssSQ
za$$~751}`oQI3fDg)0c&dmai<+EXfj#&QO~KO+8&sH_z7R-`Y%Lg*qdC2t-zMPm6S
zp#fQRB>uzX?Qx2n+vyQ(3S#g~3+l!+s;Tz@!Y6S$sLkIGLEDRDn^`56UdIu?#fU=Q
z?PDu!Av)fYrPB)#rp^pu&kp@K{>8Ul7dK|J(`L5y#_o$TUHLUalD!mcWsZk{pvKln
zjc%UzN1`z5luV>7X0fc)1`hji6)F6P>c#bsl^O?U@!66p%Zcgfcy#J*v)C$ZLcsg<
z$1)qnrK8z8(`JS-%jgjfZ4|N2jwdF4IT+<Ctr)!Kfudby*;Mi6(0;P%AbN~m@a@{s
z04{G~Sx3eOzqNXN)IcYys8$5+YFmX(NMYw6nplr``*vg%q@ce3E1GJ#^~3HdsDOyy
zWC$O5WF_S&IZG4%Bx9=I?yn-DL>+x14`d6Yw(Co5e?EZLuSs3Wz)R*6%82i=AMG$e
zrEyqZg6H*lic@8A;O)%k?!-c{KiXOIIA1pOL5^Wg==7&v;|%ah=f8-C_$eOod@oTl
zu%y4$)d_kAh7b8{ipO5gQNDF=vvPDh$Fjt0vdUYVXEkoh6*LJ5U1*zXanEycSI|0E
zVqVD7^ruoPTI_b)(*<f~QIQ71c7w{@#@Ptzc~N9a;SN3`#A!E9ZX2`@q#seL2t>qc
zQXPl(>;xA?h0dnY4rq#uAagh=e3gBecYUwiG#E<nF1xXWz2oL+>ZimqMZcMM;2cBF
z_?&RPqe=MY<>(lR8&5-^%KlO5g|;fCC?<ppT2?>IMgK#uS~2dy{Fq&2a&+%i?#C@x
z=)H&lgUqO0FQ;1bWdcm0hJdt2V7yGIMFuSPNh!m$g7L0>Ty12&JmWNl(em_CI3}&i
zW^>AVZ_D9(jO664Up+BDhQ7)4CJrUo4u{BeF9aY93x;tyS8$|j6m}lj-%R@&h}E|m
zDCS4t8&la`w3~Sv6h%e6#CInl*Xuic53qPyi>zADNv?(Nc(H|YqDQLCobzW~Pw7&5
zj_-|mo{Cg2`LilkaO{WC@mu%3j(0Uo=dBCcoV5KO51%+D5oSgLlcEr2!Pfyyi)5P`
zqmYFd%i-xARRv}=gV&tm!O_{mS(6B`G<@dC0WzPM5ls23wnZ!J!qbM$H<=Yr&JcsF
zh4mGO<R%t^>9zGkS;P@i%&!X=f>{rmmgh?543Pw7QX~-ILy`~WhVK;SY$RcjG5N__
zDt?QgT8UBBNmuH;8Tr^VJjmSwj?2s_cUNZkW{neD>@L%WbD?`&mngYLRU({R*P%Rp
zG$cSX+7unU;ac#dCr#6aQ(#@RYt@@jFZzjvl$$3Jr1A-#(tBZ`n1J6Ne>|BBeM{`#
z&4?R|F7V9s7AHiMAoe(AZKaKeJX;Ys7#+)-38EU8mh7B?vzeoGP1s+mwUKPBi-M_k
z(m6aT1x7_hsWzKqYI|LO<$JpF<a^$}bUiG&bG@wKl>b_fN2;aHL$Uj%rCvrmB2kly
zuzv{;pV_e5*#P~gb!|;0kDrS&TR!_iuDb)21t*}|TNsbHyfVeZ_M&Ua*s|EH%e|zr
zgwjuBsqaO(PXDPWG1Fq?XWWftc?D(wxIu2uCGO~;o*lkACDDitN-RY6G{8|K1B^<s
z=%(pkoWRi5p=r}KeKWyp+@>iOMB?KUv7QgsJSG3*4w(>l_<trucoUfzXJBZ`X_AzG
zQ|)#wa(jNH(i{T<I@yT7Y1mW(Zs+ud`}CMqBq#+)%{joT>6fR^leZuEh<1usdf{#;
z!Se(aR$3SMORGK)mAffNyW`20niGNTPl}HVlqcACB#c-20xPOBsrH8X(_qsaX{V2{
z)3y%A&brOijw;mYok&k;Z<d;2gY<Vhq?ICgfcC3iCP>&H?IzOrSU8ouL-uVu>@=Z1
z=mCmS8SAVDmXX;>43|x3!^88t;wN|<K_MSXiowER-5asgtf)*&jP2^8iI7YqcgtLZ
zA^Ag#LR^&gknx<+*rvf!7U9Xd8Fm<k?QoY}4JtD$YU7c}7*lWHEaA^@3*~a#hpr@L
zN=x;IIw!(X=?uO59YICeKWkP(!%ERdLXinobpvst%$Xeo%@n!{adA*?EQi*@Y!BdD
zYNV%}AIovaXUqV@*$rkGN)WR`=k-Vp;H<buPEOAEjBwf)B*m8$%f*zg)Mko_Y*1*4
z-tmicTprX$kl+}K0yg!&pi=cX(k<_F_*AaM-%aXN>?{3;Afz-0Gk>=$Mj~wwI;gjc
zWo*PvX7#1|CWS)vazr1n)<j6EHS~4d!s`gByuAeH$eJNo<1%{|dwxt)HX)lBxVkPg
zz{6c-yvrq`1W*v8UiFRYJPC?w#3cWHFS|2TAjq0I=xP+7GK&eZ?B+)+NCz6w;X5z)
zGvCWXB|M#9%Vfoz<mtFNjQ>$|9`~EF+PGZe!1{dPBTi}fV3-n^T+rj?D1f3{N0%gp
zPuj<O3T!teB>w?wR(sF0Wi@jUiE81fv*%D^yX_-#FkCu-qs4_DoQ0$}UiKrd=j%_*
zR=oqXNf>?X@S0LQE>l~jLyb?gp?ao9y`z^bbzs<bgdTlGAuii51hkxoPY1)mzG|g9
zJF=p7ZX4sa6h_SK09^>1V{y0A{6}iAw3)#bC^GIrqjq+EoyKFS$f?ig!>dxkf3>X{
z1YuIhgOfKEHz>X+!60H%ULjPvvO&sTzN_gYR!&4U5#F=6>j@P>Kw*rZ(f`6#9xYSD
zMQZn*m@$|j#h&vJjxw!oJ(%1{a+EKTnVS<WhJ=77sa88wq`OEe9r#IsY)@@hQ_^}s
zp^HMv*Oo2NHEcF4L>DMgD3w`IJg;q5!=*G8y3*p^mAnV~=2-)5D`db`03dbktJ9?>
zJOCHgImi90%Sd;#vQi%E=S?oBcX%(@-2s&QkBBFyD#fVZ`ZdM&cn7%~r1xTC$0wUL
zELD>o1$eE%$}BSdBE?+4W5SH>3S}d*<o)^(1>y_#pzm^JK9#>iE<7szWuc6%{(%)d
z8A?ynV!9m}wD-J6f(E~#I8f4U5H?oBWF`eG_7Qn&W~=A+x(@a<lc+mtZ(y=@vYYW6
z@Zy27*Y>;R1iwrlqyScA6e(1*S&hYBBmy~}J+n*AiWnIkGTF(n)2ed4@Q<2z8ZDxh
z%*Q4ieTeAr!5^GNmKpx+$}b*%KkdJ6{KKmp*#rG#6URz=8Xv^{LJ09Hj}>i`$b{T+
z`1O*&zK|3Ak2XUrQfa&>bI#3ba3aFjQH|s>pt3gIL$*(w2;yi|B3Wcn{>(XPedzLb
z!ub+(c0#@K!|p(1wV0;FBW4>SEOdT@_*wa!zQB8r@rXj9n2Q2K{N&4S<_Z$=iMfY3
z`)kj-r|N7fhInq3Ojg>U_~Kbs^Qg>kdaS6;*}*HOrqUvZSr^&O5*<^v*Ne?Mde;$$
z+YNS4C(4uiO=zOuXv0Ar;DpPok;`c+JBRUtD4unw?Im<as1e<{NSUSKLao;KPeR9Y
zN4InjBjNZD?>zLAz~8Xitb?K3Zy&#NU2KaNO_ce9HE02D+*oa6`zYkBmY^6(ZL0`)
zS_wJXppRL!eaT9U&WEy9*-==$@5RVvz|qWtrGZj7N59f95o{+ENj>*r2S(=<)-(I%
z$@6a)rSOmNruV=8`n8wC*c)>yok#k%W<t;NB@<R#CtI*89u~ZTlI=znh(NX2WUP!g
z(RoIOMyqtBKbm1pBk9+f-3Tung2?jc=hyC$XMM#{H=d1?2CzBLijMX2+g7Kiil^wJ
zCv{7gB=CyILAfPyP}zS;-iZ50@UY=?TKAI6c1E9BX9g;jaiJQYLSf2k0+9IR2*{rf
z%hf|Itp@16m*R!q^;qr@uq)o1EvM362Lh@Lf*kQ@6D*bam=iio{bu3DS@k1%Ob!Qc
z_YRnWW$7GO$g2{5KNF<o2Sov;ZsIfz`_w#L5!%{SdCT9E55(hP7he|0{YNgV(!IHz
zXKmYBuijNXn7^<-DL-UWRpOwNJZZhaiRXMpolhL;^g9PX@En7t?zHjn4k1Uad(K5K
zNlR-a2nR;XPC~QnvjCNMny?82K--J6Y1fl>#7sx@XJ;#z%C>KClJjr+E)a=sy=^l8
zM3}REBj?KXf$n^^hx_bg^|2cU$aVjN?D3QqE8BIfPnKvjbS#v#T&Q9R=T2qjn;7S>
zhrNQyG8IPF4_J%*N{DJK>0oQwSN&k9Bm7cI^(viIXcaze3X6U0nce07qS=N^sBO6G
zFh$DG(7j0zL{TOFPK?YRL^bg-;(NXWD7a4#o|h-DQiZB~;F^HYyCC6&hX-+p*P60B
z=_viuF*GjQ<gl)OjzcH1VWY83IKANG#rHOjM~_c+iuSUHy?5f|x=NFA_lwP%E&521
z_%83XSypFX7w?%DiAGd#LM7F5Vq!+KdVyq-VvBp6fdWn8)F*`@_#r!$@f1F~@6zJ@
zQA$&Z<Dnm62W(9{Q&5r1KGCl7QDg)ze3Ke1$XQv9+`~3GzaGL0Co^l(_t<UE{(<~i
z(emDh4-Ke#ERq+kQ77DV??93IN3=|HOf+xj7rsf8>$4TUKyxF|GMnB?wAVY7f6BK#
zG8H)Fy%{<uYAT;0?u?z40}PS7YkiIIX}^wNf#g)P=6ggOUj$j20c!lcH_UdPN?+ry
zY)1^4g=oM{#(jC!J5*yK<qc1kMDYN|6XS$%a&?^qRGZoAgLy0dqMepG3(z!6dp3nk
zGTgq3ALS?H=pp4wOc%w_QmAdQ79818Vz8my2C(h3$B%(WC?SxFylR0w@pC3!yyG*L
z*fWI1r<&qSJ$jyhOnFPga-T*7m)GjBMO_2<wItt-zw*RPNrMhc(8%V4!9~lBy_qBp
zw>~b*Qf@X%|Bed>xMjR6e?ED0MbTp`y3+^+F2we#Sje(6X2{7m{hleByLus#rR~Ya
zER(ke%BQmk8sEZF(_QR)9X9HBc~hydeE$gZFZOFx!Is^>I+)3uOhu3uwM6y9ku-k)
zdCicu!$Fc8kQA%9a5$7gNg}TL)$#X<%_1O$Yx_iqugH54mG9EmAHnl}!R(vM#i68>
zC12Z62$2fVX^JlmMib@v0cX4bJU8$FCjAVlXn*<valDeCd>4S)sZQFV!?K=!E6q$h
zi-CIH%dSnys;2kuFhe~8{eg<fejAjSm`Fl^l)*T`BO)>N7>Y`6JIXweS`jW0cwBWH
zMhe8l)W~V-PLUZ^_GqyVFeK9hBxKA&@5_-%M;92<gterPsop%pKf0X`sV?Is!1H8+
ztYX;o3ws0Wa6B&Z@(ohGMKR{CkwlT;4RnoQebTeKw=Ym1k0?IqJh?(!lo8Tt9f7MJ
z0j$qi-99=asT<PDO(>O>l|`kMY~`$zk;fTb><K#EdLaa%YwaEmT&Rm@8?j`NgvWbG
z!ULj@<Zb2E)zz!rug&@Hwi9kUU53w>e5t=!K$$MQnXQDzo0p)!2%bLN4oxv6AheT$
zLNDA54QHaPI!#L4gQpbrWTv_^s+E^&J~j2?XP`#WR0@TA(3b=t(!wKJX!$2RaBdBf
z$FTL}K`{fVYG$h@1P41sPa=u<mn;teaZhRdq)lzDjxfnp+A(jvXyvt)!y~U&$DE{1
zEv=KRkHf_$VX=IU_Qn7!UEVU&gDIBU@iNsJ5|naO^J?-ibmmV;3MHuv@9KqVB165Z
z>#a2G8&V^cGdUO{^ZP}a%xz(}kizpihJb2eLBO-Zn!4dG3rPaLyV6u_E8*j0Of+6_
zg5A+06COKxLj?dy({9*->#pe;hsE$UTSoSJ0_fNRaxDm%QiQ>FvQAG=uQs2ffzSkf
z@bQ`Gmdx+;m9iqATmqDIWk_+lXeU<l5FZ{JMh1}i3|4MmSECvzxn97Dq<+zy5+{VD
zOJPzh`T2{;qTo3d2BdzH8Ohs)hLdyIKl#`V{{m1-ryCOFg2CYONi<8$F^la8ZzmPO
zU>UT<oJB}BpSFsze@WU2hb@<pW=H)FOY_(fucD%&c&&+uxSTMs5lttc4614gcKJJX
zrDzN2Gnxztzrx-ctx|MoU%+``w8ZMCOT(t9E;BXdUg@NNab~{TcZ4}pMxs9~ltfne
z8_IoJ_2gRhJgB7nFt3)R*GI_pipjn77kEFGK#PV4MQfK)JES?p3x6z(ESH@cvv-ln
zKLUU$KD#l+{HA{$Rk4sPg3>NFQWtDQ^CNW-y8^J|J}S~NSo6h}87k7!Q6GEkD0-J1
ztK1YP$cTfIp&g$p@-XU^*|-0#LJhDl@dq;kK^_TlC>@5z;Ij-Q0MydL^LWqMxD}9O
zAve{E9Ug(8XF|Z%PzPqu>+vEW_e|9jTGIIn9an+NQm`q}zmBb;3yq`Em-^*XO;pL$
z&c0PiiWJq<(rl#igDKm`CUoUC5uWCiK;`)RN_q~8OwmDU$vEw0tb{}%Rg)bKa|sOP
zPvLSRFxX=jHI+G7$x*a>8ul+gg0^<I7KG8b_HzRwZOd+gQC^{TwP&c$VZZj^Ncnw(
zccF*FUA)F)lSR;gK^`XKsF*b1sbW-?`<s&pxl*F`HBVUjJhIsvq7AV+Q=pT%{vphe
z^6!3&IK$7R4+CRpV+vRRde(u*ws59<AU9f)m-tcx67h6sa_TX5uU-<CE?}*v0Qt1L
zmt4%?_x2DDt1+U4q$Fz0z*zeszeTZ+?U`WO_z_q`=*FdGsc4@-&f;fz-;xu)oTjGX
zeeQ4(u2$ZlT|t!v{fMIrI_zG)TK?2M?;7)+aBIcsK3whDT-;}RXOV}xG@CxPAloOO
z*jgDB4|!6|t8fLCmpXF&^xohvmZ1xNwoP9~<>9)g$e4ja3iX2vcohho(3}w1PWuE(
z@b&O7e*>Zcz5E#*c5{sT>m!rnJhhf|lv<T_c?iOnRu_We;*ZQG*g(sTW8i5sJz1)E
zz39Wfc)Xl2kXFR0B648nC=3n_p%@QSb5@HV|E^D_{n#ehK-tnK+vWY!<YFW;p<qxs
zi%yzHMUpRacp8u3X?GQez@{q@4&8P$j4EAEghwe<o;L89OUp{p@%h`%NXpi@z-k4l
zai}=)_+UdbMVJT;jLNZpnCj5t63=?L==c4O@lG%*9S>@yXd9@RTg);zEv2uKoRX)X
zV5TrX0Yr%gqSUHW*9qo-v``@8^s_HrE;XtlGfz>P!R#SFIlMPhR;?=2uUawB9gyg#
zhQ8gePU3REn!(|y^KpKrs^`S8hBFI5{Xe$T4NMnMen6D4<nYj(PP+|fg8vTzgk{|C
zaG!+k^C6U_1hU_9X*Xn7X-DppQI!rUZ1mxO_{CoI!M`n>&hH!zmI3b(4X%p@F;CX+
zBa+Y7=PU6lR;ZC7s+>sjXf7zP`>VW5;X#JUISwGX=B&&<jfpJZMIdhS!q;Lg1tpB1
zM-Wg{V(rM(rY8}7Qcf@-^<}<MZ*OSxBncl-j3xaC&#L*G$jMe%F1rOh0=9i|rQ~HC
zHq%&CjoGz*CbIEmA&|%Gd6j=LO$#c}*uX4&Cv(T>_fgJnJ4q_%OBPkQd!>C*dW(WN
z{Y!oWxiyt2pwJQp6Hp&EyN2I+JZ-}#zd`Wl$Rbl53a@w^%}XrN_9s~Ql>$3wM@+Cm
z3_n&+@W+u#QIUa=*eny-1&pZBnZli~iL2=TlDZiXWONRP)so?9ULi$LpckTf2C|sf
z{hK;0L=i=nU=g&*xNIOZwy=AnzTAZ<;&CfRdjxjAidkIRHz16*bl2~R^edh^-oQG+
z*DYKHxyBOpcL188_va0t!pqCz_5)jNI_@afydSK{+xD4xF?w3`sPwn0?TTamh)vUf
zX`z6o`p5|1Z>NVDf)d^minSP;huN+;x8Hhdg{Xc((0zb)NuidN9f159M~u)Z5mnuP
zh^D!mm9%v{yPDeX4OrYtNCg#^fyRH|32M2Z0d$gJ{WXwTp3$CBaP<q<6h<huxrUPF
zl$$ymj68jp;Yt^zA{NJg9dc}#6kicCJpx=OQ{^gct6eMCm#06{+9Oa@Mq=_Nq9Jex
zDn?nk3RJywvEEMpP<cT}$fT_U9fu?^WD+F5T~Qh6DK~)$yK}~7)9&fBMa8+`8(>0s
ziy(9s(H07sP{T)vUGN|4;Gy;xxHusnNrt4O*x<YOlRN7+sFT5Ft!*)}<TBsMziQMk
zKOZWBhYM2iX}7FaMyiB5)EJI{n1?@bJH%^M5IztaQw!>XqFP??bMdzuATa62xFZH6
z3j({y@fw$Vz=K>5^p21GB^mr!(YZMNVDlk1L|rrwkKZpePc<Y3IU=slfw7OZ0$d<-
zgTybcQx(Z(pGi=RF;;h%GIG6bGf}3w|Lc=vU#;Z_2;&Rv5H^JF1){~g&0pb&uZdmA
zXMe-9|GE8d3@km|uWhkK!j2zb02Nsk7+NeNWj^&rhR`8w*uvI;a4t-7<QL=Hk*y>q
zAoOP(g{@yaAi#$CSHT8>=*Ax)n&W9mo68hLCe(FuiH3hJ`~3a0$2sr54dhqsriu`X
z83?$5{<XCQA0{W`MYI&Vxjys?`yf0?Uo}E34T3sq4G3EsEGgh0J{#*uZ@;;!%8H>n
z9U&fYXVkOk!%T{skTd2|;>l|dA^bD17D}u&V&|7LoURlzp}~ec=|$$hFWP<wQQs)j
z(o@yWJfghO&&mYwUj~0dzUKb>^)bWWcHo22Ia#)S_NLY&6SUE4De9<O-$RJ80%KQS
zi`EA^3a6txMml3YI|o|AJ@i%ftVcs!lFGkiZ7sNX{cHI>&-0J(R5Z`Y`D&M}a@K{f
zZr5XC`MxtQB%XO|9}lJ@-SI>JeW2DW!3d-rYy82gYYpf4AcXRxfDe|?Ly&3cL+dp@
zT5U{CE5}Yag1zPNDf~YlL#W?Sgq&ZEkyldSlkt?<uAJT~>s!Ek1C;UhXA>@y&>iB1
z&V`Eg*jTT~)p}}9tru~`8qW-t1;+J>SLz*<TH1d`DA<bEn?V*@o+jpb{6*rVPy_pZ
zAjvt7Ill7#L+J{;>-LS0Zhb2jvd;_H^3J@Z<9>>`evaL2pi{L`fOD^n{`Att)eQTc
z#qVc)wCR8Y_zZopQbRR0H{s8#y#|BqlXJ^qyin=p(uy_-8I7m?nB~KCz{#1eq1J<g
z!}#*%=e{CWF=spo^9?L%D->jd!5$cMoidanE{hOk&JF1Adbw=9m0ssVVq7KSB4*tB
zS*G0|i2rEt=LvC7;;9}d(xC&_bFpKD*E!&L1Xp<cxmjmklG6)s^NW=ZiG0mYcuI7S
zbXPMcK?uyr_(=Oi)z+;R;^aX(WMHzzRhAOV2~jd?&u`Wrywog*|LF9?&EGlqG*Vl5
zX6TchLwP_>L>6CNlA64fSI~=ddM$PLtf$<J);C0l)2p;O(s{etOs?6vUVP~C`qcb~
znxl_#RqdZe^f$O}*!hJZ^Lq?Xxf6#El$p)0niVCX7Ex-coe9QwmN~{@dFJA_@Mwz+
zd3m2%Mi#B(-!-7$t=k+^@5ef`0ii`(#W*O-`8+;>V6I44Pc5i}l~Mb1;yp*-`Z8*8
zqyW}3F)B63jy(3B_HQ`yB^<~J3#Q@#>7jO6$XFU8|GN}PEo4VN4s0w_Zc@Mwb)u|$
zIkGoA@w<E^f(wQ=ZIK9pJBH;JhLgHyCeluzz1a@oe}T-S*CH*)4qBA!MF^S1{b~O4
z(YD4?A|bv!fP(_(w<+4+WqbPWpV<oR@#tcUd2#1R)DeEH5c7%Yw3=IX!)^3_cKN~i
zbpOoF%aLL{F6W<lb#ig%WPCGh0|Idx*(@d=qlnfZ-!7juFi#{bBqH<{X`&$t{vKbf
z;qL4!f)*xn`1d_;UTz?KBi5pHXg3ZX@L4^58Hn?`!T5Kno~M&<^v0GNT0WOyceK4j
zWf<7d%sK*6ZC*<vT4?u6x;^8y@A(J|wJ>^&6+x$0EW|bF1*V^&_>plG=EJGBpC=K9
z+M;IIHw1;8-F{1R<wW?~G3$SqVQ+rxg??3;ed-23p7F~Tq2|sOmlVz;vS!@Jp?Su!
zuK4N0NyL81uE{q}V8??48zgH^w*8-T0WP1qfmF-w2e&B>l{<}TdvMe)N1OmdVgnbe
zVa)aU&xgy2glH_YMUSi|Nn}x>56ztgb?{XIOTkPMFI9L~;wz3rx_t4hug~J{KI51i
za<<`l#`LV(3J3k&_bqReX>Z+xK*+g&Q|Ct~XD57f_1F7~+Pi0QrxMZzw9~lD>*Tz`
zY-plDv%F5R7QCgz?6+3KmBJadd$06T#}-W8L6DRjX&;QdfS5DZ|5AvNUYJ4$*>!B6
z(cNbp*oeWJAw!-3A<cxWEtkJUjH`*-Ks)qd8E3?&iYrd?Ku092;qiZe@RyowHFb>w
z#xd6U%~RA>BUzv&K4c9AK=?r+lwbcmAT`z~Z3vGWL-%OkCciW8SvfG)3erZef5h}F
zc?!z(yUA*2?=)-KbC`6}m%wAb|E39u{AE^(b+p(qv3nyOss+6K=1k^HewrYAe~>X2
zAB6Pyui7ZEsL|}2Ko@d<^A-PysZPhn$7ZjjvO+B9H;YdUM3N%^Pv)(EhvpxpND7#E
z6_Wptbmae;0PKI8zeVoAduKyNv3N-}B=5=n!Gl-U$*Mhv{IydD+E>(!mky9YzJ$yd
z2-(2pbw~fxUoGTUQ0%`qf&X7+8T-%F{lCL$_J8#@I+gRwz*wR$bNxJsC-ckeBj}Pj
zy<-l^54=Q4Ti^8WZ|z?f;oq?y9Dn7yCld9BNr9w=xDgP{hne-3Ajp~Xh#G?LXRc_H
zH2r$_b#}#9l7D%8Ab&c>fk3+ly+?P0WSz+xK9Mu;#LqAn8KW9AmS2zjX9ABuMZU&r
z;yPim1zHL>9W_6@73loTrf_%;U1S$bjKIG3A5xTWmdn?Fl*j^hITC<pD`h6f4}N4)
z)$}Hw?4wW${O(_8b!_t<u!uRm_3XNa<oWZTz~jT_SbF`VJ2>Qf3~AqCGvdgloLHbO
zq)wZcJ-z?!(({*FD*qg+z^gZS>FA$m8P5MWhd8+!tl8^caS^aLO)^@@7KXFfR0vP)
z3p3YMV@YB$48#{6F<l)aoTrIzG3h;mepOI0KhW!rZUo2y_Fi#CojEF@)G1PZi5Kc7
z1T^!b{pCS|S-FI|LUP~0Sh5oyVyD2WEiDg8K6%5-+mhS+MRe)bwd);RB;tcGT+#jF
zzCbhXKaFyg?L`FWq9635UA(+bnHP(*Wro#v{=_w;%p!K1Fx+!}=38s!JiGge>t}Rt
zcy@R7%&q|P88{IT_-B(C`uGZm!!GKSl=K-dDk&eY^fnn#?jZ@#{1J)5!=!ZdfuIV?
zlX$)vL~@@pivmL|31gg{wuzKh7Bd|@5qR2lqIlqzN|G!X#ddCIme<!IXo+c{6)HDx
zkWWV^HeZhDRvmBvHedEnzJv4Q-M<t5@ai8d>M)aisBSjq+%p}*l=PGr2_akc6q89W
z5w>se^I=>r&?lgb9JgxinIwB5YCws#KeKUJ%m&q$O+c8LU)Sm49z+BWdP{QC&^FLF
z(W$i%6yv0^UKxu`7AI8w`Yp**6paq4qs0>`whRvzH+G?EJGN>${ZAYI9)dk?Of-lb
zx2T=l;8^3MP0D||lWzzPJH(;35?_m<RI9DCP~n&+<rnQer@EYbSSj^2Je}ZeSiX(p
z(!eaanY={*XMMB?y!I#NVwd+qh1Q&^<+kkY*T|kks|tbw+Pl#yH^u%thvdj!=#nb*
zfpHEp&=-^W1@X~RLBinOI&{V1F;A8?h56lLlKDBzV9}%A2JbkXb&<1Mx*;`svt{Us
z6pxR32MMWq$rGpDd;gMAUwvw#V}pcT9_bOXgsDadY?`IMGj`v4yv<_RTS?=J*TQQ~
zph)GVKLVM6gOJt_n3TS4eYdQktDD?-c8u510=LW<<?%LDIsW#j*T8bm_@9GH3>j3&
zDGN#H6heJ5k^d<_;s5VsDP#pf{JeHj;D5x2GluB@4+tLr)0_V;djGpHTy`t9IC>)Z
zSIZu^{#8jHuZOI!n0}Ks9b5GX!!Ek~7q-v?B#t1+nEm?)2tmjz@%Vpk|K+3o_x67y
z_5Hup!~FM&DR&+aU(DmmGy|;-N)2n;fmm#_W7#j=oJ#?NhzAX3&xbG$jyT?&fv%H?
zwBTp~{ifG>+SO*OOttA=Kvk;|`Z~-!v43Q$%J5S(o+k|wKGR!@8ZDoRLj|<!AH&$c
zDqV@Jy^@YOf6$yFC`J0S-yk-<LkhqQzfFR;7aN4Ht|vbtJc9>Oqc``;*jbl!J&ETe
zw>LGZ$UzMUP}@gy9(4~8IlF~S#=ON@Jx$G(jQxloOb{c2n&VBaZ<6(4zDDnWIh-NT
z5m(DdHqw;F%LRDya(=GS*(FK4o2yeLxUb{+1|Hl8GE%Q@(8J|mtL!cwCO==yulmu{
z_3h5Y<z26`-r|gHcI(HyrJXN*Z{tOwYS41)k&3n6w>r}ceaL!y6j=2(DW6X;?I!$q
z@71z8X2a0DL6O0;9`hKa%YOUKoMA<TFf+2FsaNjmn$u_mH7)QH|8&uQS&YHE4OoTm
z#3JVXHiiQ4G`3U;qHIvhQM!|75r8O)Q%1vXzFBckOj$TWEuodwRF#hgLjpDx9&cS3
znh4@dVTp0w-bNF9Q@Uec#hnsxY+7iIyr)yW<9cqt`mDrR-V?M{)wdl`l;QBTe37=e
zBHqJ6=aGM9&qla--On~U`#k{@s<K|Q&zXL+I%m)GIziyNx7^Lv58U}4JWoU*cJ2DB
z)mS?tXM5nja@aT6=Eixv^Ab;JH|)6*N%1)?Lhi*t{x<EQFc1uxrs<+$TeN5r?gznw
zv-Xe4$CBb13uq|tf&rIWCHU>XG(tasBaR^j8e~-#6XvcZZC6=!zR1_XDk48&1z!;b
zBrCmBaE8*pl7zhgy@k)GP*rP%M(%XO|H;PCGf(x1_AUB8a(!5P^ZJADHy?PDA9=7@
zuBa=UpR41ezEEz!(a=DJY<-c(&5RmBQFm=@s~TkWI&9R&KqP%&ehrxLeuPP3D5zh8
zrB5q-@m;PRf&{Zz<NSVs;}{CDJE3|#?!;gheGcq6`hE^3GogJa_VrpP+^j3$#nyoG
zoPvq_)Sc4_4Wl?d(I5yr#Hghw%OZo<INAz*HrEmQT~sIZxldSbrbWKR8HaQppR)Kg
zmOS}O<4(|1bzTYl_w{y-aip!582<3Lh2(Ah(6YG);9^v#5&I?Qvh|S5Uygxb{h;V4
zx)oPyIzl1CuqV{z0vl@gXc+v;1*WnB<dvoR>NR(q@mO)#tUHGi>}x!7LxBR`w*2!;
zI?_Nx1yIKwbo#UX+i9Ce9c9b7MjRhnkaACa0C+SVs2vO;M}hTlXeeITEJ|3$(!k&@
za;mG$&fmkU0TPl6ff`N3ughGmRu%UNaYIEY!(OaB-({q8=;jw(OIy@**nQ*}bXL5i
zq+SpF!_n>+dG+wy-_LY>_E)E*@jboUb~ydLcD2TOC2ux<-N`cGPt*rgnYp)kbMfZE
z^#}a9Zr=-{zVx_@ANlrQ+h&x$6(4VL(dDM*x{y#kd-<?%9&HwaQv2uC-&(A)<ERpv
z$rlivDL*5vH%_}V#n24`SA+W&abM`?eNYuv3k&;4AYKy2kk}c!Ljw+k9SO-s(h@F~
zM}1zJVyt;+fXLJ#5|(r|U8O8L_~zHHBl*wS3K8ieWAY|Tb4}Xi>-e8;8s9sSGBV0)
zio7w^r$2@cdi>Bh()rRaPMT&0gg{)_%j9wvEXhoqJ-o5`RYIuEXC<~?TkrTCyM5DG
zx56D4R?IJuph^vfZSIHp0*M)Ud4DFrDAuaD9;<k6E+TzrykHgc@(BTQd>HHRp~e8=
z@ZW(3<Td-uYy#IBT=iwTL7J+lxu(UbB5p4=;rC=1(Op)Hu=6rQ5iy*Zpfw*ufk=Pq
zPQmRTtdIRSPFTN|V%GiLe$Pm?{3g|OU?G&A7LBQ<zAq(@mX_eSA+8L0stSpP6GMrw
zCG`3@{c`j*UH)zk%cNM2YWk^nuht4($T<fhJ33u|Be<GuA&3%`(BTDxLEHpl&n)wu
zN755Wlctz+JYZAl`Mee<7=n3GHYMM84@6OplwpCZ{&iWgEm+_UuJ_4Az5(}y5&0i{
zV4oyI+{TV!$1;48cYD;Xq2wC-MV7(^<Bi*GHk8eLNVMOZ4EdnMA935a%Po>L)hJv(
z*9Hxeb5<rpl6p?+7JA|jq>{s;-mpIhY<`j#;gLSz{}*B38q@B^jz`q`F>Idb4;BI3
zP?^*MJ6Q7KEf4i+oUI1O4=eQ)FQB|+i9^%Ah@&x5icLFdwo0B)-H|HurM)JbL%myE
zckjsg>{s-gZVN>fIEJsOb{8&821$mze9LY4pCc^xMqomu`&K&%{c#ny@1JYN_i3qd
zV1ME!RJI^C<y~?#{E@n}zKvXo=tL*^<20Y8X!j%gC1&bm|0f493q{8?Z11tr{Atw*
z^mIhpv{7v*H~M>$mo(j!B$Ip(OX`I~pIBgB<Oj}FP&Wc;D^O)2ftdfo%v0{NVSYjj
z0Va-xywr5EltE<oT0_=So;O!N5}u)&;L@c^0ykh-R97jdXY`Sw21FoF8-6cBuRPD#
zvviLfD???wa?Z+hmy5tuU>T|XGt&f`uu4xcxaj(a1@e!lbxSUw7Yfm(-rd8tYpx|z
ztTpDA5&~N}jB-0Hof|x^PY2c+5(PeOum#w9Ec<T0&W0ua7=zACtg6DF<vmgKq>0Jx
z0NmosKGNAI$iju}M^M`x9mncDdtKWVv?i}17O6eq>ac~poq+1QiP)4Zqc0=wXV<+x
zV$6(2hiyZYvmQ7o)J!{CBT%ETy;w%i5u#TMFR8v3#xIz%8IHJ=cZCU+@WapHA@(s3
zFJnp|xM&^LDO$x~*;nGV-|I4cuqC`_{S%u@dpr+%*uR#jI~G_jYArQfWbxrG=IB<+
z{80`%Ze^mM&rlZYejbS_6v;y<gI+#^O}yVHTS>-o>5<mF?KfLwX6pv3a7e6qWT+j0
zdS2=Y9i$;rj*N(!%{`=2BrrC@xD{*cz`U-ABg0Cv6mKkEeWo^NDKJ?o>JD~m5gB1a
z4(ABJ^n7J{;Cw;DMZD#MEQ1^L*NhafOC2N9nGehRKRh^9<sN7PKK4A>?mm>$GQ*h`
z=Y3c%2a2|*yu_-XKb(eP_wc-EH*Ix7sjTs5y1cx5=$!9L^P)KZRvGa0%v#L~$4vk1
zDZl$n-_*h*4<>?b2z$>+;iU1QAidUU%n0G;4B0Z!@x$Nj5k6!qAk1|>5KTjXl03gR
z^^ZahV#8F!qH$tw1rsJ~O+TlvS%@B~BcvH;eHUDFax^kUKRl{O7dTM3n^`}QP|}?`
zsV+&ih7N#9z4%ee@wOiuT1HX+SFpw?2gnK)_iO4!)I<aCZXta>KU=zSggYnQU~~3w
z{hRc39#QY|)H^~?uDvF06Kj`i!H_Ip@t(GqXb3Y=O^*Y7nX*C95MtMr8M>4VZl3?x
z*V?mA5!x(%mzzIY><Bt+MkxmU4&Kk3YOc5MJ1e)_k3QjDZ>5ab5Lb__vo}87S)KSy
zYWe)(_v85#?W}nr{Ol&6Ue$s!e)-~;F9YJSf}RCeX$9@8?WKJUSF&8Bp6avv6;5u*
zjay*y_`YNjdH8M<=YXBM1!cNoUxQEN{u|?$!Sz+WD4eOb!Z@pzr01OP#0q+%0Y4vo
z{5uJ{^FmR-#5>deWcTz{`N<b%^4S$KkKWUXUq!@HbsGgb-RVz#cCZ&F+xmIskNqE}
zbAIu;GYh@z|G|HxQjL^>Simu)Q{vLy{Ab42#OK3LkC>hcHKZ~#R=O-4&IEtjKbydH
zvv`5I)4`6VYMDm!5Gml8Bn@FMuQo2JVb$x=#M+6iIySwhi4OntkW=5)c;7pe3jc_H
z^j1;~q6fIZ50OG6-9Ez?%B+rq)^FA4HB8lUg+}ni%jf}RJ3EDcP(vf1i`VVvS!_Da
zY?1N(6#)mdGsAa`dO)h@6~4@0K;2@L+y~Ck%XS4?q`oWOWitL+R6LrW+g$fNmb=|)
zW$k(Vf~zvYjAN}Az)bTcoXwL7#HDixPR&GFZ=p`d%_{X0``0((vwm>I#JOI;lcq`e
zjYzB}s<1Z|qj^7io&TQogH5i!s+hdwQnMYF^1a8_cux4n{ktl4UpJm|3AJmo-E>cq
z-*q-V%bjI)KEfIg59~Caf#j6;0IwGtzcKtN$AO7hw;MRssp2a;Of}zb1V&C_|CKr}
z4qob(eYA3(xJrt7379wr`>`+kkgO9j5)l)Twr45c$}b!C)zbgL)?0W**@bQ2Dxx$D
z-7z4Y(jXu)Fo+U@bSRC|-AKpKNOyNi3k=;2(hMC#cf-8n{XFYi>s{~nFYLXqeeL5s
zkMnm>5dNw={Gmq`R@7Kxj0Vfd@%!`=H3mr7=bq}OyN6Fv-E#HC(p>wMoIW>3I`CcH
zZKbRC?aH%7Ur~g!=GYT{c9-}omr23ySE0*u7sMyipZedq(d!avxMK(DOwxqJw?}lZ
z1{m415P7TJo>o@Wvs5W{U^^|{6;bhi38vmBLiW%9H9qO?`HHuWbM|7DvTw^ZhO6jK
zqlaf?${SS(GvAH0X!47RVk#~W8^}{~%B|>b27(3d+HwiDMC3nxlZm<y68d5{<(yda
zo%rcMF6yHQ{3Ru~oz#r5k8?btGro&K*gDD8Ph!)QU;U+GOO`{<%L%|<ODeH?`BmEa
zLESqhiF?@0KpIb6#Y4S?Pj^+ezGQubK=$f%oZ2{GQ(uuM88xY)bxrWx#)72d+qMn-
z`?f^5M+9@c!&nnmYM4j3>pDGj3Pf{#%!6mJ*|d|4pw_1dI`Bc>4vU;Gz}_qGAMOs-
zD7hbArhNxmsw=dzsv=X<P+`ZycB}>a4-l$_m8)acLxlPQ&ce#N?-hZilBN8x_p{{t
z?umiCZ*oSqspK&?hfZL!2~Zl@7kzpFp&~+HU3K)enq!O)yPb2m?Ya*Otl$~_XmrwR
z-WG6W{w&|lo*1&;k1B`r4)qZ;nBF)?*B(3f>X0LDI@Txr;6?g*&t~|~wKrehQa;M*
zGt`>C`%LQ-G!a`Y&G`3ckSit*J2}_YBSAZ+OQ$<raW#6ND)Nr7Y=%6`o8w^TIOu#^
z;v11hJL~S7V+M<AirDb4rL%vzr0qFc4VFJ7Uw^Ja3DVmO=ps%F<EeT@vqOT9e7gO&
z%j^+jPp{da_o#V4zDJDb9P`L3tKbe`=Wbpgf`@y*n0r6*Y<Qp=LS}e#!rL}(G}n`Q
zqHg&NUuSM7I&x_BQ4nxj<g|P>35JF^JhgBoSq2k*(N<z=xkL@8b<g(?i6#2PO-S!-
z7!&Ahyr`MZ8vswB%5-29tdX7MzZ=%;9{lPWNyf?lTtmW{w}67blwh;X&jVxIlcy{t
zFmvyO)64oioGN2cZGl>v=kbAH*aw1SUUp-seS<yx-3F__U(~)Az58=yV_t|I9OM2V
zId{GMEx~){sG=)Ks+#m*`&I4J6$yCcKJfxxbm0KMsczJ=WA>i8wM|W3o3@Ou1y~!U
z&!N~AJrpIDKW(<{8YUzs{Mf6zL?&qc^S9=@d^1S%>J|(K8+QLHGtXWejWzt9vb>r`
zTbz}R2<R4I?#NrTV+%5__OCYCu<g0gQ9141uqA;#4;RKhqN91Pz4x;KyUL&i*Y%oA
z6SOrMgi%XoWLB#eHw^M`Il42^$v$*@39U%U9KYdu0V2{DMqZ=;**}y%KPJAezG^OA
zW1P(R85@&`7oir@Lc}IHV37%0KTI4yyYpoEMR3sw&{lIqmlvB)v|2Uki4wx>G4q~X
zgxfDr+C&)M6o;1FL`ukjQT^qd``4&>9GTheHZ%F1m{#}LMA0~&cLjZI98jx+gw3<m
zSZ&JKZRQ=-{&IAl)Q#ipD%SZ^ciT{#nJcUD(fwdn%g%JGgdgURx?KLwWz@Je9bcw&
zw+eV`W0Dh4<8Wo}Eqdq>dUO@?JI3?id7kORD{EGZpogSrPdigeovR!kp-<Q_R?yh6
zEI611NsMDhHb)b)cL!6I&q|?LvzgR#YbFwM<|np7BcCQM`}ak42vi={K<=Mf>tX&o
zH^@&1g+Mkf@OQ5_nKf90dcha^esN+Zk$>+?9B~~8s)g1>{MnAe$UUO#3)50irv~-U
z-@5{<KhbUFGO<eQo?CCo&T%1#G~1q8x6IY<-3_Vk^Vxl~5M<ZkSRq?Dl0J{Dr4u+#
z!u%HTRAul1Z9etCB8RFFN4e%>E=AQ{^Wqu<uc?%-jlHfLpqisQn8t4%-7M=e-YiD<
zssf<?kq_dtL|`W6t=~W=6HMj5uB30&CVL2|>2esiev?s;1}Vp#(Bg4OpwR=!^uEOL
zAX2}Rj!`ee=%&p4CQ=LHE#)yX9c5?|88(B+J2XgHQ{ZkYzAtr%etAA{@y^jYb!p(o
zV$hANbZc2!KfTwHfTJRX+tDG0CIR=OCsi23&i#2MR;KF<*(4*W;H&HS75?KJ9J#&B
zYx>h2ou7^i6ng|hz#4vo!b=55+UAF~S9#mwk<qfv#*<a+s3DmGs1rttGUn4AA?d<I
z`GU*AH^K%1spc`g-HMjdG7~?N&B>dP`v8N`^^pMs4yYVq@#m3klsi;Ts2ISW=E)jo
z?c=XFP3xea4Y6c+=%5LxIcd<f_)8O1ua-8BE!Mt;!1mo5qmwT5hTN0O;I%e;QEp?(
zCBWIWOo_bZC}X3|=&P9)^oFeIkVe)AbM7?Gm4jaQ4mdBd;yibwJr$9`=8NsSMS8Xw
za1F-bYQ~vZfMT;I&hFU+(qA0`A4L}MxT1Ac0&&}(#MC5CiVlpwGVy7H^tIHK0ZK)#
zo$!z-Qvco^1Z4BhsbGoX`zC}lR`C8TlAz3xa8DGYwe7^it~aa|a`4;{xbRhIqPPiw
zueGDI_wK~@&lmG>ZtkAU8}-pYj3G;;0z?`RX`AA%BV753HPE5KMo>zV#IQ_blSA=A
z(VQXL!gx{2(yb=n+rG-lDKy63_?^=X<ftj%!5()WZF6_(FCo_>OEIq_s&Ha*p3|2S
zBH-koTwon5<bxvfM(;dS<XuTYSXZq3!E=VAR_t#CRzQ&ZoZ5Hk(jRWj<k$3i6>@t`
z!t0)()tgcxvS5Y9U&cg<IjaaSl$g`PPKz><!XNw6fwgLjGe7plc3XGFlEEZaHf%dc
zt&Ww@D5i>YhhOou`<Ud|-c-a+zDaXB-d5RJHlG5s{E)w*BV^b<(74y-vbICxK`0?+
zMC?tsSgF|f++RVigM(01-<i<cagr*e^%Sk@#JTYiSK54c0$H6xRz239jx8GZVSyBE
z0xu#Ax3yRf=uHv$0R_uZ<8D5ZyAHU(hvYx2;bICE6#V=RW+F>qU#4kF=g2e<!Lr=Z
z#Nd309N47;KetoxnUp);|Jx(BS;>ayYgF&a2?Cou^RHRy3pjK+i>Hx+%u-us5=?<O
zdx*;{%AxkKU4>tiaU|4i?4!}6F)a6ZJ|BiIT|LLaYMvWWXz`b`#DD0l*w)M$hMj{e
z@g`9Z_)~#iOZR7#0&Fkg%G7$Ye^pduP$SD%g}=n2%YC(hh1?W!zCX>E@Qp*VCw9$j
z{(|%TrX40>OI!m!k3{8AsD4C%i=_v+H9BYrWEcW};8q>wl}@}Ut#>)K9xTynJfUD^
z-NUP|UvmgJV7bZ@b2FW1UwWM6H$7W?R);Gh2&oXrGq7|d+r_03!X}}-mnL{K6;l$F
z@4D%O2(F}l;2>-}7dn|Nw`IkZGM`hiSF==OM0eRLwJp);_W=1$Na_l*Z}<7CioDE@
zdLkq(a%$-I+M;gcdQg8$#xIwiGr=Kr=BdeKz$##c`*C+=d7$nav~@n!Gvi>^@ijE~
zjEOF<Pxbn^N%N_WEk?6`vV}eQ8vpS_{IBa@e9Cr5I{?m7nZsP%cKHDaq)iU4OrK6W
z8*@hvHza-?UEbni;pVyN`pf4LcUcpeK`kNMic7@ZP4)pkImYXaG8EI+N>vRyZTqS)
zXpAH{O1n;LPNm_XzwL?~wi}BqdX{^8vMY^8&fU#U(<<#3x`e!9U~#ZiSZ-(}j}dXh
zy6_>OMZR_sSlu#hU6F%htRb}M8`7}!cf5whMc7HI`8jKqIj(^QRQJh}tDbqg_5BmN
zT#iuH7|)H*M#Y|*WehKO?X0=y{SAe3<BiH{{z^LwO`tMj;(g7;$JqS}*ZB|*q^y<e
zNqAAMLPU>ucR&*{x9(hDlDv>>1U29OHlOg@6kb)7psi#%A9*;$#Ad1w%dTAUYdY8o
zaKu2iJ-|@~N1<j_59_7T#fga&{yXdg9?^i$gN2?L)g4_`Pc99e@}UHqV{k)pbGS@X
zteUx<Ba8V4W}u4aWTDFGRw^DR%__e<(g{#x3y5@$;kbsqQn(t)s}tR|B^~L0pi_*9
zq~jC*V)$t$gj1gZVi5fy#A_UlXr=AonLC%elDmz2lzXM=fO+e6t1nsXcDXG-e6Sup
ziT|xN4ExDb+SJgTW2JXc4|xupsnn(8jDtGMQvy92-tG|6d7x^%#?sPUJn;oc*7PF^
z5{P66t$U*NbH@vf@x<S4zmt*Hfl$VXubW1@9TBf?t#oiu_$qJN(#~VmPIu`yp(&1#
z)7S3;WmxNF_-gX6ecQ>PQbWIOy7Zx=kg|Pqjp?V|*=+hzfap31<`gu_wl%{}a{r4b
z#>pcLFlBvZ+5hD!%sn8w{GU;3(x}+$fyMJ=geEyL?@DuBq>1^yUrt%*>T6jm{1ts!
zQa>@#mxq=+vH2q6`5<@f_dPp4Az>CPaz(XF?D<6wb+y8u0uD%aXIE`shR);CI;<R4
zbx&}|{XN>8)r%0aOHKW%5&Aple%(CzcwznKWlorNME~R@Rzo#Rh)<Nh8F^C<cwAC%
z>0f3<>`u;;9CDgGuV|fsD3ggFYBY+NIk8bi7IlV5cAb8D87@foTegf807Bo!n{*3r
zi4{Ofm!TlzL=g?y-LS8F(Z%Pxzel(>nr3~hiQ9G!j=%XtmR!xwgyuGcw`l>`?=wCL
z57jE%7mVN>`c(NNga_JuM+b6@4{DE+TH3(oE6z*dWS{x0i&`WCK8!;*pCMddProwH
z8$NfTt=YA1Yz=DP<HrNnzX+9``vH4JUOG}G#Z~hr0IX}NhCun2e)@w?{EiYoQQz+_
zQx~(apg@mi0LY~6)!WGm-&e}{^Cp39N0=3D$mtKZuoo{_XAV1EQ+%h<ps<{)zV5Uq
z8FS(9CGc!PZeQ<yX-343X_hAxAZ$GL?_oMgU+lF`=4sp1QZ!eB^dshceyYZ$7jUIj
ze_SQbn`!Ky)~wo>K2ux|<?y{RgiX?ecAf6bxK~R=RnD><ewq*0N+SJ*MR5c;^p`jO
zRmXo&tVNm>3?YWwYAl?f?fj;y#5NQ*e4eiGX*h-q5&hsCSwJ6k<Zf_5(!Q%h^+C&S
z&UMLk*|l{7<NU<=xumn(4V};>L%Pf#G5P|%8MyB2xC(c)+1>AEAMl!TO7q>`q^~NC
zrtb@(#wp!LMkyYYEBtQoqMFS=78Q}09F6GMTx+kMDsU%I*gu1J7*Ed=b-jq`a~S9R
zA2$Eia_NdU_v{yn!$qch`a4AALd2@iyTfZb23`)+x63i{!Sq&z`Rsc%EBMz<EA85j
zxXMd3>MAs}e~}A7vGQ7bf3;-JkX1WGW=rHz7KP>yS%i-d23*HFfU0hF*z1+k3PN0$
zNblpaGgSvfn@54w3cFghH+}I;%=|d(@#K$e)fYRB`)q*YmyaW1oZm59Lbv`BzjWdw
zKgzMOWcgW<CX6{wMDb`&ZWHs9ga@Aa<fiSsQLY0}Zb5&HXg!T{iJVJUtN?*E{?%qC
zH|8G35QaTO(4TQ1QZ?S3U*~f*7fnqg6sA6UcV!+0rz52zNg;p0uqh_|@=WT>8=S=y
zG(32)K23V$*?C)pa^<%W95Rbhq|;259TVA$;3n8?F3uyX`OWrk2Q5QoziHTTE66PV
z5PuK8a$;7-n>Q>*4og=5`jU0hIfRFpGxH4}McF#2{oh@z7|R-~*&z#Cd-`DJW-_O?
zL_exrZ{n2ZS2^Z;6RUURji#8sD>wb|-SfDQ1sk8QMJy^M4&+fY(oA-CMl0X)s}CDI
z`^|dSUEKISSYiu}TT6wd@UiJ|yVzpo>AA;-1nRs;65=m=KzR|o?|DkYAy$}CKB>CE
ztH9G2mX;6g5-I){9xhMiRr*j|=N3xE7A)%;BIg`Ha!S0cqg@vaLpsdZ_qox}sHaz-
zaK*8AGz5Y90(8W_%cXcTOHD<Ou<He&p8es6^4i&!0YQf*ukJ1^mdRTk;IeV&(k<?W
z{uIyR-CBsnj{BqXK_}K>@aI0Ap0VGklIf~^^iCo;l9beFon1l38W*XK@eTMJXe{SN
zogbzUqD-0tDsf>o1=}Tm3H1i3|M{Ks<f@;>qP}j`HP9`mMMJqSZOo2|x*29WqiH-b
zou%o&BQ9(0!Y=YZqyx_rOM?Iky`S7B8p;*ESFO4DbS&&!ORoE`{$`=eTU-;RE%t#$
zb!XZ<pR}+k8jZxDPS1`E!(duhn?Hs|^d5Us7bkAJ<3z18#@T)^jUX_!44r1X8N9~3
zpELW!FgzN@>0Zf5E_bAtDVf<*B|26$^-?iZaOZ=LYpX=?&`~t63j`qFk~txyEaCN@
zd`v{J)IsV&R5rshB0EWZ<i5Gp{t2Q<H^yW0^xbHdDSZ?7+vL@V(tQ2Pr^p7SE2d!#
z87Y$iT6mw;qtg9v*}6AxIheyQJB!-nz8y^lKjex}8Z7VF1YYj7R?+v^=EhEP*y1A_
zaIZ93+?uL7pBB;aBIPTNeQhP|F;l4B$ct0GeFF|T^eWe_ifH{lLO-uI-4@+H;jUW3
z4(4fn=CbdP2+-gPkV)%KGGRvf$_?T#gZCpd^mbPaY<V>9j+{ponqN#}`;^0X8EULS
z@mwLBfnU8@2EroVUa@FUG8*Il_iY)?3GJhoHQ!q2eJ9`K+KA3<feKu5?R2c%vg*3U
z6hG}76_iC#PQ1DKp$;=~1jmf7edf8;#k%Qz15?03js;{H282;f3aUnl{p@aSpku$^
z3p2M_UQV>P>dFHX9`)9(BT+ediir%5hRb(5Ix!DpE5m6x{dv!eH5^ZI0TTPa4W(a9
zfDXoSLKwBBEAy}aeOozW#s`t&Mj9Ag1WG4u)IS3H&-aFJ&LwW??*5EC=qyw^8Z)j~
z>8QISrM<90p;ME(LDGQy?B+1r6pLhS7!F&?vD{F<6DL~GJBxe9RD#ynMe&^`p!fnb
zzN1y{!%AEW0vdfd7ZPY#^kY68dt}J&EJSJjainrB)aB@uHBWnO`2Niji1+KhO!FGE
z6r9lplruxF>D+l=Wwg+M7pZAGi1X8{^V0mbPnV$r!E&J*6Z83PJ<}C<CF)oA8dmX7
z(QC44#EG133GyE&eZ4&2z7C~W{8lDi5gPp?;G(z3G2o7Jm*mK8p_?G;5R?{9S^$L5
ztT8&NI|45vN%!Q6wos~xGIm)7xD2i$qtpKzSe6?<88mD`<Ss^A|01C_Fh`dm@v1I<
z*dz;yB9AOFc#wTa7=0>HpLpYHa2hqFqjWq#142NcVagVv8nS3`>LPH7L5?)t?@p!9
z8uT^1>${t$e?fsn2D{1=pkO>QJN4N7xJ7~K>`RwfI(~%2b|dnGDLYxGNdlA5Hy80w
z8fhEsn4T_TEgWKbz49XVV*KqM(`2m?#<^~(3-|h~Cw%_r2CmMOwB+=$-}`8CVxCT1
zpAf@72z4Z>sr{G7ZW=C(p>@&pMS+s4nc^t4Bh|;`rh8)%Xp#3QzYS@o^jYnxzaPKi
z8kK&DJ8y<|8v_i!kf1&_msea3foSI8MGTO)w46!os=mX^e0QPHh`6LU$t;<F|M*Ji
zSS(Pvdw&Pa-xVL=SenLK-_FOdRl`5UcZuwtB@5DD_THoEAsq6iod*y}2^e(?J8?K^
zwR5%M5#VEBW7qw2C9%NX(n{aOlxH)o&)72XerL^2El$OaM7X<Iu+uwtk$bmj)RSnE
z$<!9nmRt**>e_@Ds4t<a4|~oLhy{J>aU>GYj}$cfB`CvPWVD?;NThNuslIDP;Ifco
zi#E@@d0PI@HXWqq#6j$Ht36lzQQdNYNG~i(l-#6Hu|2HRJLXbDgha2!g|IR*ux3iB
zqiWwLK-n%v7`btb=1hMFETq5XnM#CQgs+6e0dXP@?&HWdvCr#7xhbUtIzgz>noDKI
z(|0;{2^r}d5KgkD*Cc@kt@za}NLDOqp(#Pyce~#2f?b~q-<`@XE|Z^O-Lc<&ytBLu
zzbm^NZn}=u7>>>y3P&>ed+Yyty%WJb)Ii1uSdGOj%&>wwx*L%e$qZ3swUbz;(lt&4
zR-O|&eIE2+euravuquN=&#2fxy7u*D(s{7Sqtet<I<6am;WjL|Ua30Jv2(np8mVkz
zp7ehPf|>o?6li*4BP!REIttgr{YU#Axjb=|YFm8!nQVe6_Wi3$*-(l(#>Gno1`rY|
zcXmRX?JRK!)v<>+$~=@Y0RIWk&9#spG7wgtuxdNbgFC`#Vvp!*!2TlU=v+s;4+7Fm
zql<lgGPH&xj+!l1hi=F<{R4A2bD`K4O?`!@y*+Ylyw0-PFnS^3fSc+t82Wa?iuLHb
z#I&&L$7vnsPOCaps6fup2cIuIyp>_oP5Yzo#)=uN^a;@Fp1k%4f9M&Tpu-7=mS>nq
zk&VmT|JO$E<P*CuxKR%A3F@7Nfxs|6HA9Oy9m<PzPmC}e>d**YYT1H<UP_IN;~!%y
z^OM~~RPV?i+b)FF(!2@`kWPy)&D{k_`I%jecl3vH^+~r%XYBRH0Hy(}GU>G~2|3R*
zHPuZ4!JOL}8v652Rnx7vZ2BRcHV@CLRmDwZhzKTP<>^mXX;v+@gO%M38nK=F+4W!E
z`(F>s{E_8bNI1dAkks~NvjTD55F_jUL*k-z_w*ijR9lyI=O_DaB+?o*=S#L;4IxR)
ziAJxKI+<{9fl}%(xhfyI^fmckXQrMgq!ClUaJh2%T4(*fx4!0>>h3u+zDl(TgOr&*
z?gbfrp#4Y7pRJ}GdlfgFRpx-$1?ZQ?c>CFeeULOWDNN21%mVD`0nZ9_xEYa2?Reps
zXz0Egh7!{?jeU$u!^fv6N{n+D`8-jmheCNL?|@8sO+bo$rU!!m@!(^Rp#LHwxj|ad
z6@Z~Roq7^JO0gD}y$EkxitqZaQz1+u6wsY!*GfT@(MQrSTv5DIn?EGZaV?=>H@R6x
zTW4VF(D+V^QugK?{RDyyfonn|GSO1ysG~m8Nh0CGVVx?B$?I499gXwE>|zD5y?mmj
z>+0`v6qdcSuI3|-Ds?8GIQL5#4K_K}kXqTV$6C*P2N#Ne@7QS(5-vW?rcl`OCRd{^
zN?8)HB*Xi*l1rut@k~aRdQ<rG8X8b8{pVb0A-(&>OBux*JfKn3Pa?MW+v&4-VLdfC
z8ioBla*=_0uaDL>R*8w|*>{jh5jBM?Dt8H39ed3tnzPMnmf<ZrNl$w~@<^jk8?V8k
zk8q8*Xz_t4Bf5%8t@l36<c^fGlow=QZ#@GJO|jKtIH{!=*ptsDszzHzNp!kR<(oz?
z30e08Z*ES_kx_dxGZi34$}7f4^$CWJe$kIF)@lp`Hs^D_23Hf}J0Gv7zykF-whOpl
z|5m(bZhfH$e96WxK+j%KeY}R2ei3o>TM9t89DTHUZ3_k<pJ!(<?CY;xs_Oym5Q`W=
zk~#Ic%^@agi1$ur;Fkv2YtiH@BYml=NB6LnK~e*`#PHGSzeXFGG*VM+HngqYxx%n?
z9)*nWXcfsP6Pcc$yEYwmz;myVb&JSMXHD&x=nN_MBWQHnvGW|<coxF3*n!10363|%
zQdFSV_VEz=>_9^zG3b!TPNZ<L-^eM+HL7KNu*TeS6C9HM#L`&K0pl*RqO;oNO)-l%
z8*RA=*HA=*+jpwJoQiznyd%bn8$F^eo3K7x&wBAeG7pcdBE{b<5rM)1XQWhi7V5nc
zqxSK-4R-C-NAY|h&dRE+T^n@cTslMf$?JU-${{k{AO3tYVh&?b)^%6;*NP)SnNbud
zdx5W-W1Ck+Gm?oH%&GUfu<5TZ^y>wljG_qs=;L+H)15)5*cN%CzY-`<?MXkeAl;Rv
zv(S?wnu9LS<Db88l4G9l`b(MTiTo*O_}4Gt97u}+7FEcE1eEYt&lzQs<IH{?!XdH>
z9!X(pc6Ew?0a--MX<vDIiO3?)#_nS^ZYoLo(a1~PI9{0Bq`dU-6nwIft-dgK7>Y_V
zsvGg`a9fl%ZzsC(*jZ>G@51C3>dh6#@jPP}NGuCVyd!5YU1E$>iQ55N_z?CDhV>ZJ
zk7_eo4Q`kjJd*+HL;2(DeQV3dN)%KYp0*mi>FDxG|ACcs+iVY_R7l}(jsY3F>qY&n
z$AISV6FGI~RbT&7*5;+~G+xkR9XpXyyRKop+pqAyA6Wc4;ARb{)f5RYI@VOOgwxh)
zf2+oB+x_gk5n<a$1)=2xSp^VbcUdduxSf8OyFAmUcf!OGepWrz+vR1>xaZ?dV0)&t
zijx*#Tb*XR?($Po&Ss?^*%21`*DG9(?7ky!al5415|aufRsy4&+Eimexc59r3<v%~
zLFXmdpDSKKG%EEN!e=6oO@nn;<m;Biw!M7TaGc0MF0W?k4_MHwyS5mHUnJg)-;UF&
z4p(MKM{`&=F|{AGu4DsDqFY<lk$ulCb#o+9bDS_I)@$u&tql00yecfJUEvqLIWmKg
zqTZXLiRp^skK5bBD?ZE~ONlv8FTs7lM`B?JE|%$EWrSCzoe=!`0G*lF?KGu+<CcpC
z!o%#VcI|?=Ivu{NElA<6GA9iB715Kq?TzWc%eLydjrf{wC#GB+!(sSaB!uHRYxC~u
zNi<zi3p|locwL!rZ{@&{raO#Q4KJ`XXQ)&my4WUQ-xyEAkPm2<_Hw6^cfxjgr2TXy
zkoVRFjmj}-g&7gcl=tVqqgM_Vtp9rI#5-Q2O<7Skw;sw;{p7{7=V8#^ESK52y+a%-
z&A7#AEQn{^J;9^Hfk_u<H^GfCv21Z6?tF76Ulfe&qMN=u9^&W<s^#!+M#Z!}?D^f2
z4W1`LL4&(F&PLUDcm>|!T(oK410j=)%}IL244i5fHoQybW@*4XrGNu1KXK2cah99G
zQ>av>Ut^?<K-?DjL=Of%d6*G=d-n9GS7SWQLN>D#K)UdQ@5ueie%MCu1=hQz+G;(!
zFOj0GgILtz!!(HS6BW6f>4BtcG6g38(7?5R59M=(W1#Aa@ynFX4II#cY9ZZYqD1bI
zhD(1_-}7%xeMjG!(diEVIUnKbWuChhWy!zsI&|4Hej3tgPf!Hw`=ASmS3jf3&@z@G
z6+3EV9du<0ah!1Q-(Y6%t@^<!w<eiedrRH_LiZk9Pyfp~f$e3y4#{Wr;j}=v6fJ&C
zlD*gnQ!RCees+}mp5)TaYov@KAa{QTT>sc8ibqz%bSgvi`YJ5nwnunUo@+#+ncon?
z)Z9;FN`!BAiDAQH;gnbJFa86($b7t!h&<(l<!~(Phii|y##3Wm9ysx@UPD`{yDK^Y
z@Lm3eqKuS^r}7_Cn&}o_nF7=;RR0O6G3nDqXS}QXd{;qwJGCYDVoU=8eBZ~*iT~-u
z83o^`k>u1UQl|1Fx$|5mxPdn8qZ1W*rZ<tZ9*S=D8xRw9gr9}#R|#7Q@`?xQrJ0#B
zWf?R$%&}6C3^^C_si2t1X5|j;AiS++x5d`mQGq!;*BaXSF-xcQ#7cM_R6FM$D<Tv-
zo44g2Y3*dNqekjE4=Q?aRMLBLdtQ-lkGY-f(tzH0S3P9ACjhII{rHDW3CVAI%yVeJ
zxn$D2#XCwC7=925aCE_txOUP!Z4A{~JR;c;3vmWTSlWFTp#8lotQixM>;j^CTPGrN
z{Nk-);AY05$uaP^arInwBjw8IICF937<sH2XXC2Qf7cdzcg)I|PSAdaZV-gVjeK9=
zW2Xz#a+v;UQi~5bGw}(oU2sir8Ccc)4PE{3BW~zNUU$%aZp+taM|zGN8G2VCZEo!o
zp|zp_Jxd*?S?skHo60U+#1*6W*;vDAaNv*VwjYe0ebf=KWWodUX_@8#45R+CO36n8
z%<x@5NAjLR#rJE8qrs02a>_nk*aen4>qu$s@t;2Du$>ejUU|aJ(}|U3KaCaqWqvU`
zCRtJsV57N-nim9y`{;s5cx(H)u4PDUeA+b%zpVzU<`*#yVztfX%zsn0(_k`$aNc`r
z;|;7Q0&2MMgrB5CJfBk0<Tl2$o{oUc<|Na?x=RVf$hIBT)gCTh7)jE-YHIF}y1mci
z$?*y?jrX&rqb%u`E~x_G(Z6QXW)XwDa!QX$|NTJuK5W8W1XqKEkAZ25S<P<($A<m{
zg>fb-wxF7zqQXvq0r|m0I&$E<Mxu_OZQQDQl{>cr^uQQ<LXgJ>Y}O~TX^8riaXH?{
zzM3kXq_;DzXaA%;7}g$Czy}O{_3(Xk@#gY38{lrr;A@2Ft9UrWfu=6WN2wyA$l--g
zMTo_zD#6*VPx&er6ROH5mvAubnxt0z42<gqr87qO{VPA|RP6=6xmhVA`MCLkwt)Fj
z+>w0{hazy+=j659w~3-ef$IF_djH+Y>m^>EgBr{TlxbuwD;(lg4f^+`dOh%FGy>rZ
zJ2xQ6!N!~ba&95`WCw~aNC{WZfq1LT{0(!|R2llDL3fL+3eT4NrJ4t}x})Mp!5|3+
zh-X)4F0JU!4VS13Bsv#lms*#}m-Fa!9zo4Bgx(L=f)laz-xLfYgak?`;*y@meU$aQ
zFgS(bvq+F-GFswS@Ha3_&`}uP-0g1pT|dycfK25V*dS`%SJ0-t#l$CWW6d%TQc+Ke
z<7PP2fVg`#Bfyxqve@5$ABIE!a0y-Mz&_UiUfq+~_C`p9N{Eup)v)}NLULZ@mCodD
z`}VC(&pd}Sgh@CthK=0{?N$E486Av&ibKj&wlnIga>3_PV3+?Ng>xvTE{+fnO6UGS
zi9Z(FjMxy&zV#WJShV22XU)VC@uGZ{;m!d2^9W!NRHJaq|73W&uIpG&?8SC!LgMCT
zH*Pb?B6LwtQ*?y9T@8_HXSXy|QGg<nmLEBtVEQ0?#hXD}3ZTE0)gb=<e`}sCK@EB_
zghUkvWb2NqqI6W_2PR$w-MjVonxG!r6!KNiDjCHD(Rc^PkcpXXt?_Rd-y5<@vpzxz
zt65m<jfY!LO8Msv=BJLCp{dv66%UJsb|IGM0@-3*?2ls!-gAXQk@w=)fQv&>ng($f
zBr)W({V>l2D;+dy?`+}}%z^=Y!<Z?9g0UWW;}eW{#uO#8NMN3S<b!CSHpskX72qq#
zYYSA<w)D5_(B*Le2*pA#!n^D)<^5yYZh(0P?x>gKJUepz!j};tG;hg?5)A@Qe2rGS
zJ+k5J$Its{qVzQob4y69pF*?$N*5ZE7owkS?<g_+bcDhPeJW?Q^z;#Xo6zRyIw`+(
zBW=4%GS<DWW14LuUCveM8VeE8>u3{fsu<*irE#DXrh}>jqcb8!cv<~IP;#YY9PjdN
zr2(3(osN=uLjq7SC;Q>)#5^Em6mAGb2)wQ2`1$)mO!L(55IHjN|5XM|`RS24E(bjL
z7O$_NwJ+4cD;yV}I;H9Lq$X)fQ{#jXV-8i{mqTv`Zzv}IfOFN^;caK5Ym2BvimJ{8
z+MoHsb0g$Ikc1i8rR&}?Zkt<_jJY#Ke$JF?ywubw<PlE_(LGLC2*T_eB|Y5|bbxjK
z9jlZas`LpysoqcqUS|z$Q0S<thjp)CSKp38X@9#@N%_CZUae7>xVzb?nynPPMxLOI
z{|qlgAMO&@(wSg<hC`SQ2n`q$dtT4&_;r+~8<}FuMyl&$(Cg@>CG$2BHz^2HO;HLm
ziU~F&Rc7-B=ivz?v`ey*H;3f2{1hTj5Mm_P!q2p)UMKM!qHvGfK}%f4thMuEpkcV}
zD$VNiYf+-jOOm%oO)u?Xg`<{cji)tyss@dljhjuFO`1)a@r^Y{I9y@yL%260wKSD~
zM?6$i{XuFuikFYKJzIY@>#K{)D|fQ|KJ*V{aiZvo?tm!yUEgwwTrvLY&WnQ7jk{?R
zrZZ>+ljbk;Sqjqam<(?=Myf(;{JdSamtT3Vjg94k7RZ$G<=)}TcH>iIzbMVZOtR<>
zuNM7$l`0H5{oo&%WAI20r;m~xo{rt`KeaU>!{>tfHj5tn{%OXT!1W<r%a)Ew5}mF5
zJCZF%chB<giR|&(&5hJ<opksKCVjIScpYIID>*0AM0x+4Yjs&d%r~V$oI8f?dkL~o
z`x>`yWMe&)dus!?OT|S$FndbEI)yRdfWGKiHh{yB>z}{AY}II}tyyFbcv$f+TQL%#
zqt-o;_emV=ZZ$jF{z;)p_jm4YjxmTxtibBVsb)*qJe2yc$LxP=_;zQP*V$eXHkTq@
zBUV^wNLgU;mWY7$;qm9vnVy|<{R}6a$Ith_y-ZB7wI?GF?$?8Fr}hgMf-fI)G`c&m
zGsWkA(THAr)D?O%V-CBB#jsbqFaLVy1ir6qDeW&1vfh{sb)lPh3&@0;alW-i%N@i}
zp`2hABPq_S;GA}*`b7REcd>Mo6rvhTf`UA4*IYKwf^a}GR{qsIoSj~*;|~{}d@w|G
zv4P`WaJ2WWNo$1I>qB%p(SMmS{V+*=LSP_|nvXKJC_UG^J1Icu`nZC4<hB#P>-88S
zJ`tew6<PJ;O92^tz5o@SHTv5PTdj25c=-6i`rNsY26!*LI$Ws(f=uZS5>AvH6`L9@
zsAu8{6(xNhI4u1wSxmKDvX`p5W<Y-oQ#&h%f9ePF3DEu_E3%V*X3*sFuPWPh^bUp2
zxNzd@+pS0Jh;1r*+J5-V#fM_oHTl=8c`9B`V{?H7K}sDUCS6D;m`ivT%k(O0K<mt=
zvJ<b(>x^b%fg4>FaSZJTQv|Ce<Y=&)0yV!A$mj9pl&5n57V&U4?rB7k_Mh{w-8mv@
zlah|zXoLo~z5t`}^pl3QSVKOs8$qE`_3YI-qv*BnrU1tuof3ctWZW4N&y)6E%gz_t
za9-PQa0Lqd<Lxc3bv-Il=4F)+P`*%@xWQDCEvrSdSw3@_v+$yuNF?*>K%-+FJ1DTa
z5VOV#O83IRX*xr!wO6J`=)aEQc3?(6esMge3qra8WFA7wYA?)Aftrf1jw&$dkhs^T
zftQ9fk9=Vjjnvs;;#!5WI^oog3}upCF<N}c5s+O<wm%F}{Z8G1enb#@0li?rZ48IU
z2TKdRU_n?3XlpIluqZMFtv>;`b5B^wQ2xh@(iQChRLnOVsJ&SF!CEe2Q8N?v)b<PJ
zdI4kwo@_hv9_5&3Yu8cY$MMOvl;h49cXvdh=7Q!53z?U@ai5hcc)S@{^B1<Atv1st
zlLSmR;8|XXX3*2ON#1$YE18~|KRaA~ubt$14HP&FG)k)Iw$~P-Xd>yhV2Cg7krnUw
zYOhHzxTt~}X2hegHa!oQ6Cki2fal}QN>;HQ{%G62foz^wiH{9oU#B@Zud1aUeWaK$
z=WZ1EXs|d%7>lWQJK=Bpce5T>PP-z2jcwxW8rt=NG2+u_Iz~0Mmw&!v=LA!S%}E+f
zoXr_Ai{D$)Zyy27mB6?;qBmlO$Utf1vDG;oVu|Xx6_oF#0$tTDYm%?i-CoLi-EhBq
z4Bn~gJdF5Mjd5{%0Z+O(sY`N1;M(>2_yjs6j&<h+SM<!;WMDF>|4bP9<gI{At$E=j
zb?|jySK%vY<4=omZ5T&0zRFD&y$bhX>1SGj55Yw8O?CmbiXstn-BCd21*YLJnO^h-
zEjzh|DUWH7zaFEUj|ZY^%l`Hslin$&;m<4HV{k%cCi#|EsQ)Kh!DdBist*OzG>msE
zea=^#{a>_#7?n|;OnNSvf}ElIcyDctW~`Wxu<5^~kq&+*A>Z2Sc}jX?k0RT3V7U>*
z@re-1_deI+(p7~od@#0AV>kD_ZVs7$7W}Cf)Mo%$*R+8z;)G#R>Ixm1@(FsQWhS4#
zG+aYt#3`1cvAfXzOvXOH^fSo#!(f-~Me`)Wi9b)dzcZeO3UZw3R`tuqLPv^-2<^+A
zm<otozCfMbZ&QJ*gUIajq5}cCYQ6^&ga!T&DCL3m7^b>VNqGGc`WkzGFXsD5(&=dH
zD~;9M*|Z2I?<=G<=w6E<3HwFSSsDfP_mH@jd*`$t=XxcG=pk6~c;<r`)N8yp5;Pnj
zu*u45nX^g8t69l12tLHZC`gOy-+@{%W-b#=^z>6D^8w|Q@PZ4Vf)nMnL|80u&+EZ&
zBAi00J@BQxUblZLbXH_O?ICuEvafU>GllOwa<f+2*IvgrIdpfBOH7WjAu~wmJa>i)
z4H<gXLI{4PFVYEC;-u_o0&2u+G52dmMUKPXnC2QqsVn64=}ZZb6Ns#Q@Su}n8g|m9
zV8W8Xoa%eTLs7V2f1t0BE7|J0Iq-78s{`Jg^n35>eE!*MjBis>3GxC4B1xM}JNuW8
z@j2VJSQ;P2U#>`;<K=FY+)M%*ssYwstqr+?oboF%YV9Lsy3dh0tY<2;#2+jF_#hY6
z9sj>SUbrLBzs9%KZZ(hR<`OQr@wk)N879MXo1(N{tb>4D9$Wv+<)S>3S{qpea#6(2
zv>|Ioh^x0SuLq~vX}+~^io&%#wgTGERl%KR$bo1~J-Y7EBqDD^B=h(nl}=QYu9?&~
zzgAGn>pqp+i>qZtw7`wN`3B&sUTLq{lW&R>WSM`Mb)9pacU^F8u1=3+bsl>`vxqTG
zp8$d@YlX=W=QD_1@cD>LimxgkzA9r>cdW2gpBZ}@zZr5h`C?`6U66r27hXh?FJ9Pz
zJem}p?;mQu8{vxJ*Qhz#*{+8ut$GwbkU5_jCAp75@#6Inq1FD}S$Swqp$z&Z3jqr=
z3>Y~80{&d7$ZD>2zvY{16uT`soVSNocIXIkzObH(ax0&x@0CD67QgR>$1$C*E>>v~
zm}a=LnoA0~ivJx=J;fT~z{ICJ)@{Ts>hR5i!O37(Wy+bkJl$yXRh%p0)<pB-1V~>~
z<Y2@&9#0sPnC+(z651r#u)Ww}T2DjV;}?i|vb>5AZBJ7|n^#hy08ECyu|ndgf_E<z
z)`A>S@pJ}VPX5XUM$MQuVqfa>L4=g{OzT3Cuea!rFN)JctYfY&^e-|lU>DR8nz^$}
z69Q-Qpj!dxD~)Y0r>LzYufDkUO<EZP=^Gbguq3B&7l!@huZgF%iNc0>g+<Mq&Czm8
zsVkj-%XyvcKlo81UQCtx!lUkGFA_c0c%FP+-O_x%HYCylb}Rh;Y!vzfCoG4@^C%>n
zR88F&sGXr-kMoxUy_=qn{;cTd4`CeboWPs;dAYTkjaMmdh9aQj+&1b@yr!-I&#+&~
z9@CyO2L^8gXWY*5j%LT^(x~da{$T!lJ@ioTB_r>|WLG<^KA&yUw7b8mwr~lkFNEfa
zJc!EU8Ka&jYizj%`^^xfe-74Y%;g5)EKcA<iZF7Jmx5h8%j@hFI%FzW0A9{$un70v
z7mZxGb#gdz=DWq;z%3#xw)z_s5oxJf)s0Lp|ArFW8^Uq-Mr+R`p%uk!Lt9l2#}(TW
zrS)|yNh=e<yx~HOM|}Mi4n2>lBM0&Dz$5Fyaa4j)^N+NmrK&rsyx&NIeRU@GT#Mta
zqGt?sD7uK8^q+g8?+HesO_8Hb(GHfWIJ9(!TGdVHv*PunK5iDMmg#~$$LGHNB`VC?
z1xPs^#PClBC<q9+GqHU~dAQj9QF=NciU<_X2i+{7=W^HP%*oUaYt@ibY%ckM=PtZ>
zwZVIZK)WT+Q9xs@0oz{N#T&k-6+Qh_Dq8_7sbyRrG_zB~O+`4x5<L(g<Wy&lOjTjn
z9_`sKR-JI&FSng3JN@DO1_>`bz|zhC7on`ApU-^4PrL*jZ{ha5sF|`u2-0+SV=772
z@c34>Br&9@7DUecHOY;OC?|E@{Yq&+6BCknw5-*OPN!3&q47*vdQDVrtva}im04<U
zBoJ+=ZIE;EuEaPX-j#B6As#J0p8oB&t;LW;myIAH4*l;7D~6{tokr|BQ?xw&A<E;Q
z3H^X`{so*s<)Rpl%%ttVvs`28X}_6@DaCN&f0!C22vNaUsgA#1u1?wAZhoymaeAAu
z0e5?1rEdPvXZ}^bDi(ZH0&KeNR2-#{z#(Au`y$n{U(QJx0JO6X+6$v=Dov~XF$5*b
zHb2QGow|Exx>@lt*5OmFN5WQ7n&)%zcXJZS7n;qJ8AbJHg*yp`3wm7ZrwudN^(^Rp
z^&`3*1;=-5jIxds;-z|ePnwHKy%GjUy1UG)`swAR=x#PP!Hq-*SWgt<Nu(F6q}xTp
zk^9v(XK&a7<GYIm4EDvPkabO&=GOY$u7tcdL^`A5SR{!v6g)ldJ9>PhnNh=wHWc^S
zF^-B~h_sRJe{6|+vNR0?WSJADBe(x;pjG74NNmd2d|u?f$!<68j6d8!ksZtlf83+b
zsnW>H2V?nLJWwG#?8*oUP5GZ3u>T8YcIc+w)<%x2d&<m-*qOy+3pX6CL_kzIQ$liJ
zf#ww!vJi$xzp1M1=kfHcDgx%SnemQ(oL=Up8?#zB4rhNTUZgEri+6@L{DmQt8qO(&
z1%#O>T{Q--y^ezqtWqaqHjQv;y;iK=i(u<eMV7a2-*kp1553X<>BprXw2MxIFOeN3
zB={LN{mi4s!@TvLSm?OrRcYRI=^uV3*}*Tn6Zu-XnF!)_q*Ri4k2bH;JeXljNizHR
zgU9=>67lW5Jf#_xIOzrsp4?*f$$HJFq{kU@H9;n2{3z2;L2!5h^pCABW_}MUb7a4M
zujG#fP-YF#^CHVzXlHk=ikCCP-9_xk4eq7(S3p4&AUyOohNI%JorSsADN~GkCA?g6
zIm+i{3zU#!p>2aSMm;~{S2Es`?8l1a7<(pC;4h=D@I^)|k&$w=>tjeKZf4jGAUKt^
zcvfHTY@n%Xe-Fu_pvm3r<T^?ua3qLTaB-FUj{%m;gvlvlabz?4=d~*5JswWVrrRJk
z1$p(^-!DQB!_p(-105mHo9L=UULoTod=Ep>ZwV>RICL%R#L{mR`|MpVo%$mu%U_ag
zglmGuo@ghpVK{>60f)GvdstqmgF(AY-M+$`V42?Z7Yg(`Fb_<4Vg`>J)d#|lWs5B9
zq=9<E)DiUV9fGa-nU5Yw(1#EbDnjj^kAXNoLKQOnO4jDJKqusBD@++d1(?c`4$&_!
z>8Q-m4Sz$ir&5*!5mrE4+*NVXi4|$k6;Se!%3;AHp68>I!U_qIgb97UFA$%WY7B&{
zSG?AXW{qzjQ;0mWhSEZ<s&Y|pdgkTUCt;UG_Z_%jTkknj^4=MH#PGkWBl1-sp2M!w
zNtx9XHa<}6_nV4+zm{#J@>FMm79~7hS;(XbhBlEp`J|xV``0lemeWHr?SiOjjiLES
zfW*J9Dw6FilGi^f<hmZY!+kOCOX@Qk<IRE>PZAfFy@e)sOH@Eb-gCMuN-A>8mL%>*
z$+#JS^qZ3g^N0d*HiPE317=L;VW;VInN}=1R+V_t=T6vfR<2uVCaF4|eiu0a6+gNj
z0BkWJtDN3Mbat}CGE2U^aniK)yE9l^3$@f&Lu0_lJxtqK4LSxZO;dZA6@=q1P#ctd
zvco00#QxYq5O<9)RpS^arlqkGhH2Ik0v7T+j}m#NqUmY^!iMRoM!C%LueLf}GXF9{
zK?Vr>P>_$uj?w}jHG*kb7Ov@I1sd|IT&+-M{?-}J7sx*RIMsgG%HL`{&NtC)w50D`
ziw=#h?$Iv_$?b~Ooqt+SGqSTVAxLTSAv%G&OcXhM3XM=EYve68JcwOLYY!@#%XtyG
zkYkJyBi=f3pEd=+?~3z2$DSKXNZItPqRh@AHGE`?)~dlTw`mE?iTV`uMeU$Yy5IZ1
z7-#2{4AQmrInM2eCpRGr3NwBCx19hH;G%4<km<L9-Qpziwk59fxfWYuQ+BFQxQMim
z*#y~q&6KZj^Fg*jg<5#m#lMWcv`AzcQd1K_pZud$*~=^i=288<W6}k=)g+G*&ho~`
z-84O`v0t;{Lu8^yb#+-ehu4dHt(K=0?oh8Qm&H+=_sv=X3O_la?24c4>t&mlkgocC
z<I)&TE#wR*=i<Q!y<!@)x9R`dzLM5_E^xDX<Uj2l5_<Av^YmHwVU>bZM=P8l_*%~4
ztyR$7?spKYo6zK#)4;YL_$61xLddni-(2Q`A#r5k#4g@3)|$k^EmNLha&l}$624Dt
z__=|(L^>o-vxnG1qXcLHvVCO2>1}`r<Q_HeZ*dj8F@I~Q(2K^i9#98rw8Z4sp)39o
z_|Z|JgN|OA&zgNnW^gX+ebR)yx3v9~x(Z!Nh7ZBf89#IDmMLL|SG}-e{}cG%bulZA
z?7hQ0O<59JYRGBsw^;~voL}-fcnkN2TO-FI;&bJ4-irQys%P#C7+@tVY8<bhUYiL-
zNzXS3d<{K%qsk+xfpHS$EQ1<8&%ePfW=7VtR3Fiv-Kl(a17=UYWk|T`6Ri<F{1QnM
z%%iX+cv^xHYp`&2e>mLAt`bv{W98QWFKNzb)E>bM=P5D=Dn?+?^60gKue#P3jG?49
z*iL0?+!LD+UL69RS`I5!<WQ1vPr~~u<kT}VM7UU%-SV5N>I<8S@{Yk~Q}#-W&YF==
zn$1lUn;NqXtLfNIbIeY_vyAoTjB$Ll3f6jaEp|#NH;d=2gP1BT#VrhxIhx((z~*%o
z%>%zf@MCmfrq6@2=Y5w^%&>8^e)S8EDm>?h{)9-wA@zfBNu1>Sal+7cn6m%HWPHtX
z!0?_^f0;JqV|?D<{g{NBX^)}kVvC;?5a8{kLWUlFzybg6EwYCHYo?chy5-a&&0{OL
z2Y0>~6BYhmm{k<=3O>1o;gD#kmc8w0<JQNa8HtMdV`T7o`U-?PnCs?7ExbD^tegYT
z^yd(cAJ1BoME^64E7u7v;pm{db(+1?FaK-_>De<G7ONw007tz~PmIPvtwFL-sdJ{d
z0x81UW4#`MEsJ1^g@pQIt9||pZCT6tgbgILVq>=|J9<AyIKDSF<rRCmRrh^t!gRm-
z^?u3;Y+F|T(p<3+z_Z4+Fp{5XcK<t!lN%VS*p58;#o<P0tVr8kP7Fsqk)(+{AvE2Y
zvd!Vnm(iV3WKHJRvX@{^S8(=w5P^j`Cc3dsPKfSonRDJe7|mH46aTne)_zMnPrY1l
zaT7xVYKV=mpx$Nip*_ao?a*z<&*;{FY;JI3wsa`<?V*E^*PR`yy|MxH*8!;xfa!bQ
z(%5!lOwwDoJhCu{b1MDs6n<0B9dLC30X4hhY4!EiZPLMT%l%~M%2uA-Ef|S=S9Sus
zp7qt@T&M^9S9-BRGxqv4DHDj2Izl}3M;;{T{62>5kAHo(l|?FJ4d`m5j=3Ih@^EfC
ziO(+xgLy#h6?VBiAJga97OS|tpc%qgi^bvA7ZS}qv^rc3@onYnp%-3pc}H*~w$mtx
zQpfE^aB`RXh%$rUoLyh`!_gnW-6qqgUttyI1r|Rdlk_=4;xVm3yxW|ebaS8N^JWEs
zzl+h~-{ougZzDd>q{aRid~Ek^wTKgr|6kG%9RKav`dK?ormUn1R-E{hfIR2?^9Qu>
zHwq1e?*zE?B1g6x4WgA~8?f_{0YjQM#`nTsUpO-lGMX`~D(*Rw?ReG-YI_s#PJf`+
z<6H0H5=0&v$HA*^+DR*w9eH}~Zk1542TwxX6OOr>%E<6LZXLU95zzjguzSUSYtl<G
z`9s+f*|qzug3n8(i3&)cQ%}!ymLKBalInq&tI&1tkBRVs_jjX#^D%=lmT#}#M_zNH
zZPfC3*^QAXwGTrWSBtXK$9|KLy?tpS2n!kfb0l?OMB}fch0a9IFCb&)75gXPAh~6M
zfQef0I*y+smd9CPXj9nFYhZJ8>$daTdD&;on6`&GP(Mu83Q2?8OgGzU3lv<@kNgeg
z227Cd@XZOgeB&_Hk6V&AP87GuQLK@+30IyFzXOJxaXZ?3?(b4^QjIN>vzkvEc68P&
zo6x_!brTc+_O9xy;!*5Or}|FDfSiXn1#*HejLRFYxUA44^l{ggX8YQ5mKq*&L#^<?
z^<RQY#=TF@`-#VB+OtAZ_Wu@$%sB^Jsz0L-jW)XqKpT#i?N$Gq!8q!*CSCZRj$fwN
z8Jg!>_nOfDxVO-GblXk$8p=t8DsFe>m>7AK&%WBj1_jebT5fQbt;ezGr1QbehKl!o
z`R@I=^zP$%X70_9fxwH8H}o`;n_V=r2M51Z?hb8oAGT8g)B?k0(Rn%HF3s0il5M{U
zDQ88|qlP1{7y=Hk8$bN_PO18!0*vV-qiMo$S#dy>jiBC5j7=}tD3N6RoNM)$+Mkmq
zowv9&j3<?(zP#CpF&sPSm6ch1PGsrJh~$=X=4hl=ms{-qEt1TYFtc5DHMO=7q<AEu
zK)tYN*pn?#?{3`}pE7)sTVDQolWOrD>|Sr7JRlE2Mf`s@?frCZsnXM-UEA9Bed=(Y
zR237hze_gHiZgnDRDS-9iEc-C@U6*^xyZe*^G4+J)Z0oePx^spF7fZ#!xjJcwDyJv
zGuExUd(FbWk$uVC8|T?$qsqUo-ohvP>zw<sN3%5BXMI|`u{B_`ZP|soEC2sI_qbO+
zfBUH@z3AfmXAbWyIGX0FdjIvb=m3Mre~;8t>_P1|;Di+LY8zpe>C)@!1w=)c{x}tW
z{*yQGU<xf;uY$lFX^!@ZGyXEX`Tg#~$Nt-KMo}{2!Z(FFmHzzn4lsE7Cr281GXEvf
zZ%dY0wr;Nft`iq~w`Id@!_&6;{8OEDUOwLYIML?o+{*@wHr>!Zf6>F{?2%8e^5U&;
z3gsT~ukwyOsFr>|Zl8?wd29Z#;>|Nw$j+|!0&Wsq`MOWKz3cvexrK3i{{X9q`jYl?
z5k5^|SWNx>zFx}Jm32qLFL&TtB#xJED*}?zdkTbp{xLuMWV>6y#mWdPU~6Mp-<7XN
zrtusV1MYGaJ!<&p#hSx`YYx}0*)X$wsq#)$H;0K<eUBftr^{xwiM+I&RT6Ypq4Kv@
zPsQ`MCRK}W$!=8FdN-q{{qKht7d7_&NOFm}u6_I5(U_HsKOb1IhG*}-ue!jg#u8@G
zsXCvI)&KvkHE;HJv3=jZ_Ag%Gu)JOwc!+n0-u;~PGhEJ)dis}dWV<-)ip|QYRX(q0
zT<r+SxmXOmHinH?>E{Q>zXf;I`CUzN6qRkGj|wTTsR-TEA>^sG#A4FsrRU1+jl|+@
zJ~9;li*weC`}Fg?^1rA0%Bv=p0x#`e)FafPf6z?Et?^1BH&?)qW_g9OL!9>x3p;(&
z0u35gCO<xA6;pn=wWDxS3~+Y*81OcQ!=*V#LP~xfT6%BN#Yb5)lP5V9otbE43p&V6
zFq-K(@Q62MgS)Z+c6?YeamW8f!UlO6`Zw08uSsbaKY8s<w4%(7^(^(j?il_!II~?r
zi0|!Pz4hY#Zh=)Vmul>MXXVny>wIORb*Q4MM3PE$?Q5=7qYZs_QhVR;5q6#bYsw9s
z`}2Ssq_yT82A%xtKjSd)9Gm|a7Uy>DVS4F3;oQ^-kso-3`2X;gT`hW_9pWl40$lge
zF|R7@c6gGNeoKjF^`Ut=d43P=->*45`Td&X*`cK?rv9~4HI%X0z@sjILp)v1jKld9
z_upH0xvSqssm!mFI?2jC0hqr0a&-?)o!TK+1-uZ~*XhfW$pY{8zJA{UJRTgBu)rs9
zf}(PlF!0#%2{n$@z*{2J?;czR>e3)i_e=y|UURn>eopqKui(SQ>2(C>9;QF_>dn_h
TLzkG$U;qM7S3j3^P6<r_wUr79

literal 0
HcmV?d00001

diff --git a/docs/index.html b/docs/index.html
index 7d662ab4..7d6fec26 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="components/server/config/">Configuration</a></li>
                                     
                                 
@@ -1600,5 +1610,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.2.3
-Build Date UTC : 2023-10-05 11:44:37.773330+00:00
+Build Date UTC : 2023-12-14 13:56:54.954735+00:00
 -->
diff --git a/docs/licenses/gfdl/index.html b/docs/licenses/gfdl/index.html
index 4311f21e..86b3c55a 100644
--- a/docs/licenses/gfdl/index.html
+++ b/docs/licenses/gfdl/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/licenses/gnu-gpl/index.html b/docs/licenses/gnu-gpl/index.html
index 0cbcd0b4..11eeb09a 100644
--- a/docs/licenses/gnu-gpl/index.html
+++ b/docs/licenses/gnu-gpl/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/pipeline/administration/index.html b/docs/pipeline/administration/index.html
index 3c768b02..4044c9d7 100644
--- a/docs/pipeline/administration/index.html
+++ b/docs/pipeline/administration/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/pipeline/index.html b/docs/pipeline/index.html
index 32b60817..68d2dc52 100644
--- a/docs/pipeline/index.html
+++ b/docs/pipeline/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/pipeline/pipeline/index.html b/docs/pipeline/pipeline/index.html
index 9d91e54c..67bad9c0 100644
--- a/docs/pipeline/pipeline/index.html
+++ b/docs/pipeline/pipeline/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/pipeline/planning/index.html b/docs/pipeline/planning/index.html
index 76297b93..3c6e6590 100644
--- a/docs/pipeline/planning/index.html
+++ b/docs/pipeline/planning/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/pipeline/production/index.html b/docs/pipeline/production/index.html
index dc7c8b25..67e3c8ff 100644
--- a/docs/pipeline/production/index.html
+++ b/docs/pipeline/production/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/quickstart/index.html b/docs/quickstart/index.html
index d95de274..26a5f7fa 100644
--- a/docs/quickstart/index.html
+++ b/docs/quickstart/index.html
@@ -408,6 +408,12 @@
 
         
             
+<li >
+    <a href="../components/server/install-synology/">Synology NAS</a>
+</li>
+
+        
+            
 <li >
     <a href="../components/server/config/">Configuration</a>
 </li>
@@ -1072,6 +1078,10 @@
                                     
                                 
                                     
+                                    <li class="third-level "><a href="../components/server/install-synology/">Synology NAS</a></li>
+                                    
+                                
+                                    
                                     <li class="third-level "><a href="../components/server/config/">Configuration</a></li>
                                     
                                 
diff --git a/docs/search/search_index.json b/docs/search/search_index.json
index 01849740..8d07d8a7 100644
--- a/docs/search/search_index.json
+++ b/docs/search/search_index.json
@@ -1 +1 @@
-{"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.8 (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/","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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods Register custom event handlers The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions. Fork / Modify the module 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: 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 . Events and handlers Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information. Adding your custom handlers To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods","title":"Extending the Ramses Maya Add-on"},{"location":"components/addons/maya-extend/#register-custom-event-handlers","text":"The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions.","title":"Register custom event handlers"},{"location":"components/addons/maya-extend/#fork-modify-the-module","text":"","title":"Fork / Modify the module"},{"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: 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/#events-and-handlers","text":"Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information.","title":"Events and handlers"},{"location":"components/addons/maya-extend/#adding-your-custom-handlers","text":"To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers"},{"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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything. A typical Maya prodution pipeline This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case. Configure 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything.","title":"The Maya pipeline"},{"location":"components/addons/maya-pipeline/#a-typical-maya-prodution-pipeline","text":"This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case.","title":"A typical Maya prodution pipeline"},{"location":"components/addons/maya-pipeline/#configure-the-pipeline","text":"\u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"Configure the 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. You can choose to export the geometry in world space or local space. 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. OBJ You can choose to export or not the materials in a sidecar *.mtl file. 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 world_space: 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. You can choose to export the geometry in world space or local space. 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/#obj","text":"You can choose to export or not the materials in a sidecar *.mtl file.","title":"OBJ"},{"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 world_space: 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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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. Known Issues There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves Features All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu. 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/#known-issues","text":"There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves","title":"Known Issues"},{"location":"components/addons/maya/#features","text":"All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu.","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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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. Develop a DCC application Add-on using the Ramses API To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here. 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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/#develop-a-dcc-application-add-on-using-the-ramses-api","text":"To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here.","title":"Develop a DCC application Add-on using the Ramses API"},{"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. assets \u25b9 list of RamAsset The assets contained in 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. assets \u25b9 list of RamAsset The assets contained in 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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. 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 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. 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 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. setComment \u2022 string : comment Sets a new comment. 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. setComment \u2022 string : comment Sets a new comment. 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. shots \u25b9 list of RamShot The shots contained in 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. shots \u25b9 list of RamShot The shots contained in 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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 = None Sets the user who modified this status. If None , it will use the current user 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 = None Sets the user who modified this status. If None , it will use the current user 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users. Events and Handlers Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated. Examples Adding handlers with a user script file Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events Adding handlers when implementing/extending an add-on # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users.","title":"Methods"},{"location":"dev/add-ons-reference/ramses/#events-and-handlers","text":"Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated.","title":"Events and Handlers"},{"location":"dev/add-ons-reference/ramses/#examples","text":"","title":"Examples"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-with-a-user-script-file","text":"Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events","title":"Adding handlers with a user script file"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-when-implementingextending-an-add-on","text":"# Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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":"Adding handlers when implementing/extending an add-on"},{"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/getAssetGroups/","text":"getAssetGroups Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups. Reply JSON { \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#getassetgroups","text":"Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssetGroups/#json","text":"{ \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssetGroups/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getAssets/","text":"getAssets Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#getassets","text":"Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssets/#json","text":"{ \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssets/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"Details"},{"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/getPipes/","text":"getPipes Query: getPipes&projectUuid=uuid1 Gets the list of available pipes. Reply JSON { \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#getpipes","text":"Query: getPipes&projectUuid=uuid1 Gets the list of available pipes.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getPipes/#json","text":"{ \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getPipes/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"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/getSequences/","text":"getSequences Query: getSequences&projectUuid=uuid1 Gets the list of available sequences. Reply JSON { \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#getsequences","text":"Query: getSequences&projectUuid=uuid1 Gets the list of available sequences.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSequences/#json","text":"{ \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSequences/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getShots/","text":"getShots Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence. Reply JSON { \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#getshots","text":"Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getShots/#json","text":"{ \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getShots/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"Details"},{"location":"dev/daemon-reference/getStatus/","text":"getStatus Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } } Details itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#getstatus","text":"Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getStatus/#json","text":"{ \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"JSON"},{"location":"dev/daemon-reference/getStatus/#details","text":"itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"Details"},{"location":"dev/daemon-reference/getSteps/","text":"getSteps Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps. Reply JSON { \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#getsteps","text":"Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps.","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSteps/#json","text":"{ \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSteps/#details","text":"projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } push Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited. fetch Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time. pull Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table. pull (single object) Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } 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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server.","title":"sync"},{"location":"dev/server-reference/#request-body_2","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_2","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] }","title":"Reply"},{"location":"dev/server-reference/#push","text":"Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table.","title":"push"},{"location":"dev/server-reference/#request-body_3","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data.","title":"Request body"},{"location":"dev/server-reference/#reply_3","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited.","title":"Reply"},{"location":"dev/server-reference/#fetch","text":"Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull.","title":"fetch"},{"location":"dev/server-reference/#request-body_4","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_4","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time.","title":"Reply"},{"location":"dev/server-reference/#pull","text":"Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time.","title":"pull"},{"location":"dev/server-reference/#request-body_5","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_5","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table.","title":"Reply"},{"location":"dev/server-reference/#pull-single-object","text":"Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID.","title":"pull (single object)"},{"location":"dev/server-reference/#request-body_6","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_6","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] }","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_7","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_7","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_8","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.8 (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/","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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods Register custom event handlers The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions. Fork / Modify the module 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: 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 . Events and handlers Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information. Adding your custom handlers To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods","title":"Extending the Ramses Maya Add-on"},{"location":"components/addons/maya-extend/#register-custom-event-handlers","text":"The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions.","title":"Register custom event handlers"},{"location":"components/addons/maya-extend/#fork-modify-the-module","text":"","title":"Fork / Modify the module"},{"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: 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/#events-and-handlers","text":"Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information.","title":"Events and handlers"},{"location":"components/addons/maya-extend/#adding-your-custom-handlers","text":"To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers"},{"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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything. A typical Maya prodution pipeline This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case. Configure 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything.","title":"The Maya pipeline"},{"location":"components/addons/maya-pipeline/#a-typical-maya-prodution-pipeline","text":"This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case.","title":"A typical Maya prodution pipeline"},{"location":"components/addons/maya-pipeline/#configure-the-pipeline","text":"\u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"Configure the 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix. Arnold Scene Source There are no options for this format. OBJ You can choose to export or not the materials in a sidecar *.mtl file. 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 world_space: 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix.","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/#obj","text":"You can choose to export or not the materials in a sidecar *.mtl file.","title":"OBJ"},{"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 world_space: 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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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. Known Issues There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves Features All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu. 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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True ) 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/#known-issues","text":"There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves","title":"Known Issues"},{"location":"components/addons/maya/#features","text":"All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu.","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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True )","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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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-synology/","text":"Synology NAS It is relatively easy to install the Ramses server on a Synology NAS server running DSM. Prepare the server Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin. Install ramses Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Synology NAS"},{"location":"components/server/install-synology/#synology-nas","text":"It is relatively easy to install the Ramses server on a Synology NAS server running DSM.","title":"Synology NAS"},{"location":"components/server/install-synology/#prepare-the-server","text":"Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin.","title":"Prepare the server"},{"location":"components/server/install-synology/#install-ramses","text":"Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Install ramses"},{"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) \u25b9 Synology NAS 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) \u25b9 Synology NAS 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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. Develop a DCC application Add-on using the Ramses API To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here. 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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/#develop-a-dcc-application-add-on-using-the-ramses-api","text":"To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here.","title":"Develop a DCC application Add-on using the Ramses API"},{"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. assets \u25b9 list of RamAsset The assets contained in 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. assets \u25b9 list of RamAsset The assets contained in 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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. 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 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. 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 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. setComment \u2022 string : comment Sets a new comment. 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. setComment \u2022 string : comment Sets a new comment. 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. shots \u25b9 list of RamShot The shots contained in 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. shots \u25b9 list of RamShot The shots contained in 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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 = None Sets the user who modified this status. If None , it will use the current user 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 = None Sets the user who modified this status. If None , it will use the current user 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users. Events and Handlers Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated. Examples Adding handlers with a user script file Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events Adding handlers when implementing/extending an add-on # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users.","title":"Methods"},{"location":"dev/add-ons-reference/ramses/#events-and-handlers","text":"Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated.","title":"Events and Handlers"},{"location":"dev/add-ons-reference/ramses/#examples","text":"","title":"Examples"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-with-a-user-script-file","text":"Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events","title":"Adding handlers with a user script file"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-when-implementingextending-an-add-on","text":"# Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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":"Adding handlers when implementing/extending an add-on"},{"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/getAssetGroups/","text":"getAssetGroups Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups. Reply JSON { \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#getassetgroups","text":"Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssetGroups/#json","text":"{ \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssetGroups/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getAssets/","text":"getAssets Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#getassets","text":"Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssets/#json","text":"{ \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssets/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"Details"},{"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/getPipes/","text":"getPipes Query: getPipes&projectUuid=uuid1 Gets the list of available pipes. Reply JSON { \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#getpipes","text":"Query: getPipes&projectUuid=uuid1 Gets the list of available pipes.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getPipes/#json","text":"{ \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getPipes/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"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/getSequences/","text":"getSequences Query: getSequences&projectUuid=uuid1 Gets the list of available sequences. Reply JSON { \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#getsequences","text":"Query: getSequences&projectUuid=uuid1 Gets the list of available sequences.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSequences/#json","text":"{ \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSequences/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getShots/","text":"getShots Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence. Reply JSON { \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#getshots","text":"Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getShots/#json","text":"{ \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getShots/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"Details"},{"location":"dev/daemon-reference/getStatus/","text":"getStatus Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } } Details itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#getstatus","text":"Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getStatus/#json","text":"{ \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"JSON"},{"location":"dev/daemon-reference/getStatus/#details","text":"itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"Details"},{"location":"dev/daemon-reference/getSteps/","text":"getSteps Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps. Reply JSON { \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#getsteps","text":"Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps.","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSteps/#json","text":"{ \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSteps/#details","text":"projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } push Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited. fetch Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time. pull Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table. pull (single object) Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } 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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server.","title":"sync"},{"location":"dev/server-reference/#request-body_2","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_2","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] }","title":"Reply"},{"location":"dev/server-reference/#push","text":"Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table.","title":"push"},{"location":"dev/server-reference/#request-body_3","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data.","title":"Request body"},{"location":"dev/server-reference/#reply_3","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited.","title":"Reply"},{"location":"dev/server-reference/#fetch","text":"Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull.","title":"fetch"},{"location":"dev/server-reference/#request-body_4","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_4","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time.","title":"Reply"},{"location":"dev/server-reference/#pull","text":"Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time.","title":"pull"},{"location":"dev/server-reference/#request-body_5","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_5","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table.","title":"Reply"},{"location":"dev/server-reference/#pull-single-object","text":"Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID.","title":"pull (single object)"},{"location":"dev/server-reference/#request-body_6","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_6","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] }","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_7","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_7","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_8","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/sitemap.xml b/docs/sitemap.xml
index 79be9f4a..1a413bb0 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -2,492 +2,497 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://ramses.rxlab.guide/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/changelog/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/credits/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-extend/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-import/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-pipeline/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-publish/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-scenesetup/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/admin/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/applications/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/assetgroups/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/assets/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/filetypes/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/install/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/pipeline/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/pipetypes/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/production/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/project/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/projects/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/schedule/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/sequences/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/settings/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/shots/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/states/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/steps/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/templateassetgroups/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/templatesteps/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/users/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/files/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/files/naming/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/files/tree/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/admin/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/config/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/install-docker-mysql/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/install-docker-sqlite/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/install-src/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
+         <changefreq>daily</changefreq>
+    </url>
+    <url>
+         <loc>https://ramses.rxlab.guide/components/server/install-synology/</loc>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/install/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/update/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/objects/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/enum/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/implementation/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_asset/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_assetgroup/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_daemon_interface/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_file_info/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_file_manager/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_filetype/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_item/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_metadata_manager/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_object/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_pipe/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_pipefile/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_project/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_sequence/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_settings/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_shot/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_state/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_status/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_step/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_user/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ramses/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/create/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getAssetGroups/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getAssets/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getCurrentProject/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getData/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getObjects/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getPath/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getPipes/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getProjects/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getRamsesFolder/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getSequences/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getShots/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getStatus/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getSteps/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/ping/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/raise/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/setCurrentProject/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/setData/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/uuidFromPath/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/files/naming/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/server-reference/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/licenses/gfdl/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/licenses/gnu-gpl/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/administration/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/pipeline/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/planning/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/production/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/quickstart/</loc>
-         <lastmod>2023-10-05</lastmod>
+         <lastmod>2023-12-14</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 30364a8a4949c8b447c000d79ba167a6dbccb658..a35e229a5735c32d282361bafd037738ecbae938 100644
GIT binary patch
literal 826
zcmV-A1I7FwiwFp&343J%|8r?{Wo=<_E_iKh0M*+|Pa8212k<+eBFcTUKznGb5LC6I
z$D%&Y$k?+R7r){MkZ)f*2@r_{sh4X0xg;#s>ZjFsJ+q#jUp`thxu=-4cNf#M+39pb
zPI{%?crpF`>#F-Oy<D8kOEih{qz-oJV!F&ZeCqp$hlg3xnXCwD=Hu8WxvYPres{1x
zoqe1xPA2u!PO$y8`OJ-%i*}Y&PZNbrlxFeKh}+p%w4#3Aw*mX(MatHz#rf&^yYB3~
zJ9}S;?2hdXlS|=78X~P0N@%m5_j^aSkp5ZnkEZRJj30UGA}O5{Pn);FJ97MaLMiW1
zlvb=oM~|7DLK5qGG-f1m(1DD01Z6I_MyDkbIZ1L<SD6xk)ZD4k==u$!6v}FcVhzD)
zDY6DwFrLV%&aN@~5}?E=*g+f0>p&=8?NS!TfM`(`;XN)=Foft;k?n4V1O7uYV`)*M
zp%wC~7?jDDXjRBbn8{WbwXEF;!(Dou$ju_-#6c#QR4kJXre0gTB=Sj)bhS&O$llr#
zUJ#@cwXz&BtT__<g|~+1Jw*^D#AAh>ReCq*5d^!dAUoyd9mUSB)5>7dD_my+v!^K0
z#B1k`AJ<rH5N!!cFpXhF_iSDMmTzU=d_t+tyVOM*D7GpWNJ_3)Ag->30@*sJ1ltE;
zhv9YL&89FzG;fMYFt`$Ay}QvaQyc`;oNWA7XjJ^*5#3feF)}Sa-ln$=0Wfy!<N_mG
z%A#gM0yI#z`3M-gZFd2Z+oVKeGv4<)u728~fnzh?sCk3E^l$-^IoGbo%>^ztGNC2g
zZ8HRmoQQ8&Y)cn_#|f{XG7{&T#4GPe`Ex69zwzBIebbFa{!(K7ov)eaM~CQNYqbIe
z{?7cF=^^vA$V)7+4g_|IId{1oL;u(ez4Ase&N2?cf3og+JE~^eOm<YvJIy~#CZvQT
zaP7@GsEtA=pe!`urbY=ZH7fOASJ7M6xd!`=xQ5*JG%&AHjh5tEtv?RRFc-Sgje#eU
z^{YM4xJ?(KPC4>z4tTa=T+v{Jb6jsiFG}8TMy-mLcPWei@k;&Xt1ilmzoB9d%Qr*-
E0B_cregFUf

literal 820
zcmV-41Izp$iwFp%p&n%d|8r?{Wo=<_E_iKh0M*+|ZyGTW2k?771>(LeNmZ$>2vOB4
zJvQp&Tsija;>IuhNW!<T4J1VhMCzrQKbM8YTK%*duV-xU;_A_w$vwrSy}O*A&*sw!
zIq8*l<K^_{kL&K;^lEvwDA6R!liJv&%jqiT@S*P?9v)^%XR;!snU7<i<f{Hi{r+S>
zpS_<h&nETLF0lKy{Va@^%XXDiFB64LlxFeKh}+p%w4#2|w+4spMatHz<;DEsO?N);
z=5K40{kel?awXhIL!|Xm32iou{@~0G(mzZ7(X_jg@gq-NB&BoWY4bLCM~**FDCHfB
z(u$4f=rNO1NMc>j#*8EmI*`$hpv>jg=(Iv2CrOU#C{qHEnmbh*U5_A2p{#Z&))0)A
zB5QyF<B6PV?;4{o0ZNR59kijm354R+E@fd1h!$lKKHwq+Lx^4#*`8)N;NK)OmKG%%
zS|P8BLFsIX)`gse>1=gS%i4`F+?B_P+$=Iq9Att?#WLAo>b=EFBA?_)ce^Bt?5!=~
z1wlGdE6WkXnj^6vcx!mxQv^{$Oe^fI(z`*AAlQ8c*(opYD0X&})&`Sa;W`tTJw=Hn
z2GN$F1k+$pbkEl1Z~2zE%_o%Vyh~lAfnqBcfu!V$1>)+Oag(imO0b<#Iu5T5e{Cxq
zMDw;P1A{9;*1KQYWr~A<>XVJ%GWLoeJfhnQCq|}O{Oj~Kvkt~?TcW_oma?dskN^#o
zT|NSaZtF&X<kl(C*o+sDPOG1mI^fuhS3F)}uRL6UWX`qgX>);#jZA3Cc3V}zA}8V-
z7Q4~~U^?LiR7T?bka*!8DSvDQ?iaqxj<340$e&8A-}4Rg{OB0{bFEgOz+aiqnI1FW
zh`hoA>p)<)nDchAQ|NEorq|vm##zQO_;=RZ$4;u*?#enT=AGsrClgY_5x8!0IjW69
zC!j1e;ig6jEj23juj}Y7>s*8V*0P4&?P*|Mr5Y{CwOW51lwmG(r5giJB<pu%o^jjl
ycsk|CcXPnA72}QuBb?*<5c;d+{fg1LXnB{i_#f}4Zx3})Uj6|jRXBKnLjV8}mZRwa

diff --git a/src-docs/docs/components/addons/maya-publish.md b/src-docs/docs/components/addons/maya-publish.md
index 38079fa3..2f707e62 100644
--- a/src-docs/docs/components/addons/maya-publish.md
+++ b/src-docs/docs/components/addons/maya-publish.md
@@ -70,6 +70,8 @@ When publishing a shader library, *Ramses* keeps the list of nodes the shaders a
 - Use the **handles** control to add some time before and after the scene's 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**.
+- You can automatically add all custom attributes.
+- You can set a list of attributes to include, using their exact names, or a prefix.
 
 ## Arnold Scene Source
 
diff --git a/src-docs/docs/components/addons/maya.md b/src-docs/docs/components/addons/maya.md
index 4605d2e6..5fdd69f9 100644
--- a/src-docs/docs/components/addons/maya.md
+++ b/src-docs/docs/components/addons/maya.md
@@ -369,7 +369,10 @@ 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`.
+The *Mel* and *Python* corresponding command is: `ramUpdate`. It can take two parameters:
+
+- `updateAll` or `-a`: boolean. When `True`, the dialog isn't shown, and all items are automatically updated.
+- `updateSelection` or `-s`: boolean. When `True`, the dialog isn't shown, and the selected items are automatically updated.
 
 ```py
 # Python
@@ -377,6 +380,12 @@ import maya.cmds as cmds
 
 # Shows the update dialog
 cmds.ramUpdate()
+
+# Updates all the items in the current scene
+cmds.ramUpdate( a=True )
+
+# Updates the selected items in the current scene
+cmds.ramUpdate( s=True )
 ```
 
 ## ![](../../img/icons/restoreversion.svg){ style="width:32px"} Retrieve Version
diff --git a/src-docs/docs/img/maya/publishsettings_alembic.png b/src-docs/docs/img/maya/publishsettings_alembic.png
index 3bec291a00fcfb04b9ad7d5f3a78e69e88bca68a..d221ca7cf25d5afc5d3a0b94cbda921512abbab8 100644
GIT binary patch
literal 42747
zcmce-bx>R3yEO_elp;k+v0}xg#fw{uyKC{{?oN<Gk>c(S#ofIWNpY8;#Vts%U?E@H
z{=Re0%(-*t{&n{ZFniA?dG&eLv(|beRFtG&V7$gaLPB~WD<h$Xg!EJp2?_bf^Jj=B
zUw1rK5Py(e)uhFcs>jI=5H~269~D0$A=SlVKA4~)?$MoObX}2<u>1b}AOjss%@7Yw
ztTlAp)E%sy6wTdC%uL)&5YLd1e5p<CtesRGtsUH4sRi_WslBKL*xylmBYp$k{k`Mk
z<o$oVfB&BEKX3ed|IfVv!1cQZ5DDo!jjY5+4KKrE7>*O!0)XMppGq!CL99qptRIQ?
zO*#i-Tr*Z2jd*XGNu!4u{vb_naV>#m7evG+4+zi{19hxn9DUXARS8)c0W0!!%QzS?
z6GQCPAl<WK^|FL7mNI|6)P7AL{vohAH6)z2Ih57{3E2$gO98FiPr;s(87|@IliM)l
za1uY!>bmb8%DJxXXef8QJu@Zp6oAVqlEoG8z3iKQ1`(47&)f5z)~y)9%arAc&QARv
z`QvQQwW(8u(=KQZWZn0q4R}*?b6Fx94S_g!N&LOOT3J{;qYQYcgWR3<;Y6Ev6d7CY
z3@5jqcHh_fLLG!|eh1&omWY_Y!^it`vG649xBA`IL+&zrZb@mToR8*Ny5<PMe&>m~
z{WXt=HJdE~_bpuG1-SoSe}<2b&*uRq_J6#{1xkC8n9kA`&MYp5!*3|zG*8K?|6I&`
z=H}+lp9SBHT8fyiB+#71@p5V$uRml4m{z{|_lAb=HJD@f4I>j%FZsFD$&`sySoog{
zBiqcY`?8pg1Vm2LK$D2~?^_9iUy$+;H^`-e*SdUnl^?g2r^nlQu6m_!rjn0tdIDZ^
zsfit|bb+zmV23`lH3s<$|Nd`GG`+a0p+Wsgj^Ok&0k{|JX^2$yXR|{<7kw90^p05j
zyXd6+zhT2Py*ixR6&Cd2FOGnU{;Y~kq@28Ht53dJ5<jZ-j!tjW?XK+Caae05)EeSt
z?fweCnlCl{+ZXCjd?cuX4&Al>+}%4hKON^X@JVM^jcne*msvzib+aB1GKp1?asCdU
zDsxv?SNPy(A8Q^Ey?K4SYb}if;F6;`dEK@X?sv=VCzO~4lihR8y(c^Ag09^hjiz(?
zM7D@NZi(_3I&A-j!+PM*G*#FQ4tzuOx6$KBfOV&5VmZa%hJ4a7TI?pT=|2Bv`-A4l
zEHi0nFzZWpfX|-rit8SEX*bltZ_Sg9)exZVIJ7e1f6b-e<4-R72#JO4um$MWWOs<(
z6^j0Z_P}9L^y+`-sbIO{=U!ip==EY{AP~dt|9)hwg#|mG2RXdpP~=976*v&kUDje&
zQ&)%A10n5+SM~TemEU5yey7Xl(d@nghxf!90DIQ-V|pRhX8hmAG$kb^r=8w!=o4O3
zIXQs)X3YXBDzWSv8V=*(?Jv9&e~&C_59<^;_-5CivIX4ASAJ?@?lw%Rsy{!s8R^Ce
z7XH)UPs3p33H>MJe+F?z&ZzZ{bzEY-_m}8;zfq6-3rEGSFgUljc<Qeh6k7OAEIe)M
zsS<o9;7*y(|Dl!R;TY<F3bjCGS5g+aEmGAo<ZK-KT(dWm`}p3_4<gw`X99nOLGnFB
zVF$|5?k`(A?+z<u-G`m{(Lb9hIqEXp%LH1~wOqaJIe!ajK0G{hI$3G+GMJ|LJIiAR
z<GtgMfUF+@kN3}64FV{Y;bW4Weh06+d4)p9xq2jcJcooH&ibUJOxL>s5Myd`bf?O^
zeZBQN!pFNB_>$MDWGE2Sz)9#UEa(CLu``ky4fQa(n@)`qS(44W5bU`S^cgZUH>-RX
z4K_VZ?W!_@Um5W(C5%q6`9mVT2Bi(_?aV{|?x&R3_mkZBan1Up-o(rLy1Mw@JBRAI
zcS-(xC&j6Tob}8v6^cfl@WWE!=SET8L){L@iP<Pp>gwu{t)cC-qSJ8z=a9qSP7#pq
z2@8z-detX;*Iqz?Hv`HO$f5vpu06w%{jU{mlEz01HNX+Jp32m~Q^2Y3UG~9OBE!j3
zV=RKiH#FqvZ)oFWQc=%8qp~Kr$B&LuKJ-!&j}WFCZ#X{gI@Y)E4Pw}=giieZCKfuw
zM7&YD-$RUxkktk(!G*OTqX%%wVLANM!&UU)L|&Z@OS7n#Xt#!X&{KFUoAIq8!7Cke
z2SA=JVzRMaj3T*d!9i#glX?m-S9JQiX@A6l<(aS1kzy!>%NHyLMfw#^VDU(jq2ogV
zRaf&UsG@gMv9+#y<2OF{!h(h|<boEnwl$G|#?PwE8`iX7fhs`w_IErdh!NCaIWcPV
zFkrMV>F5}(OnnnT_LVzqF?;0X2jycAoO>K*ih>hRjuCJ*yuLB?o%{x#bC>%ZUV~?V
zanlkTfV}S2smk`ZlXzo2jsf?}ZR-tNdKa<}zpolvJz&rLIo*&Ev76(u#xx+<S9_&U
z{$C(l6(K<rgeF)2$ne!Zr2BootPM%*y|{U_eac5668X3h@N-hM^D89`HsOZ;Hx?8u
zGi;gI{U;-QR_a^)yBfj?xt<CBeW;N{4F3Dks;ZxB#s5B%jOfMwH`8?g`z6kt1}<UY
zDx!$LpM$YJ7)_cEqWbey1)KfG|Jm>_gZ~r%<*+>dzE{e~vH0($f}}9x5^SS@6Mi8}
zUqF|Vqg=r-Y>gMvs@xNBa&!o<g3jNy)wh^9>+L1UlKkxgGp+Y9xHDQCzKx4b&S@0j
ztyFXEh8^I&&o&4Dm%GMdy(tFiN$|5Fw|AC7FS`VC#^T|RZ|w$QH&-ROeY`}pP1N?E
z050+$58h2|87U{0{TrKscgnpnB$a8sLEJ)$UtbtGN`ekVIk-eb(QK~nP=?MPJoP8j
z^G_dR(+ow4uDgH9qpCyR$lqPo1j1QKN=17s%wxT=4Ak8#@7qA9aDU`XxaMZszYepH
z_ObKWdVL}n(Gv{15S>9DZOb+F8uSzFNeG)IPcUX)t3I5uDE%$@C9ec>1YM7H-|<m@
zsR>-)|L9S^PNWj*-kJM%G)wbFFW8$07?<z=F2wLs+%eNyu24wCecg^p_RF&ScQ*EY
zLk>7|B`x-V^CZSC-v<sm|9hcI6oP+~80y_>3Cys16AFiD*NEA(F9Z-0^I!^Q^-Zw7
zn?*s55dodB$zAi%&%?f}?j9JS8Nw>y`Pa06r&LU>-f|)*{oug5OUA`$Vj<v^BMN@t
z8J~Ll@^3e-dhJ(Qotf4e{;eE&WUl|LDz~)%EQ*4G|1XQ;|83<I14{RsY!}W>I!+Ji
z3RbFg>YhMXJ#+u%+ziokm8qoO7=ryu{Wi54s^QgWQeNV-KP!6biwr4Pzs+UfxtqgU
zXW0VoPIYA^*4EaRPLF?=;ok<o7o}a?5dL2qVVHFhy|IwtmDn#Y_xz?$HJ$_?d}EWC
zrbg0--9$B6*N86WiUpGFZQByBUHL`+E~QV;)6oRys=Q8QDV5xtsfe-47d~D}T{bV%
zhjuF+MBWON3cN3DK{QL%dAS~nbnP&OdE}8-Wsf$0FtFKz>WkB8BK;7UJ>pSsUvmc^
zU|ff#0I+`t9uvSxbl<CyyLP{mApJ@;Vq(V;W$1#*V5ggM9cZ{mOG4Vhc?}5A>%uAM
z?hpGOL&2p^1ESRw>3E2!swx6Urbk;lo{E)L5X@bhYiccFHbVRFtxhzf=UFRQ8=`b$
z4;k!W?}uL^21|@zROm~_rwcg`gJb&No9u(pbaEaPY~=p3uz>ubru9TV*GqP6O063F
zLrb%T&o3^msNPjnRl&y5DE;z?5)BXtVkDIf7)I&;ywjBeUhBu(eRW*36%>KL-&2Ii
z6m)%>cW#D@26uZtqUVpP_qbu66;Of^d$JaCpuN+TbnsyZCs)n<nZ5ZapyxFvmDicF
zb0@rHUsNOr%|rY18OU)%dA#(AX6$EA^H&Vu7q2y7EP`jYu}yi!1Ae-&gy!ZK!jX=!
z(|{mT{M_Dvn<{3kE<cLXeSlwZK)B=MP<qjhBjA+&QL^?$MNurniCCYb!%ts^J7?Ks
z0r<HynJ8-wy5H_H{D~(;03Ms1sGf$Xpt~p&OS;FW@41FeHpzb$%zHG))I2{=BxtO@
zl<sdTh3-dD$oz|2se4)QS~vM}i{oH@e1lE)tCTC2^2&w!?5db^TQ8Uxx<{jMbd4~p
zy9037oQBU9Ty&&!{igf6X*I^)qior*rSOGvz_D{v0DpCtKe8hbS_kdbw@t9`Pzfd|
zU9xFvdy?6ry|D^ixl54sB{Z1#P}o^83<Gtx*}LBIfFH$}q{h3yl2X7%!D%PjBja1O
zxq`kume3KH{<>pM7!{y;$I{G~gg#27QvR0zHL&U4*%apcSOVET(T`!$)TP>4jR9#X
zPfys_KV&Twi&J<eXj(8#`#!ht#XU2N9ghk}dbs+~^@$S0J#T1FeBhaBa5S^JcEPaB
ze7~X8b#(rz&LZOu^GbB{NiFcKaofah)r5)8KH5Y@Qg~2g13ByM`nS*<m?THjn8@R}
zeojQxXN9g<L#>J^sECHvfuCZYfu+Z&os#*mZ!#jNSeax2Z7l;852+nz=Gc{DD@MAz
zI%;=ERbf?+n(t4>{jD-*Rk>V#R&LP^y^Y#(iyePOCK6N;y*#&5Y|ip}By>wRq)B#}
zvkrBcv}Q9z)ss4s3ZU|KuDy`2f&Mpf3@u44KJgSu6a~MNI6c7Gkxkb{cql!-Nr%gs
zEX-GlRQEm9-@-@15V%2i@7m=cjl`XZpT?e|77#P&Os*-a5`C{CSUFq@P2_HBSK!H2
zFLwp|kE$u(<u2a})C{nMffj%6I~+-@k193xOBeD7V|NKeB-NcjA<PZWW%FjpBul1F
zaYHX{5MiSoHW<eCgqyon;9aV}o{An<L}cIH=E(!Q)Vzb3z1CEWE--x|flYOeptu`N
zqMO4gxZW$fxqjMkx>=zV6EgG~EZ1HqahHc}o7&id6K%UtP^sW3$CTLJ+O(HcPO*G@
z1-2B49b%nvt@=^`*o6t)5C4Sx7>(O>eIH}%_e6W{9z7x^3aXWE7sHh3YG?U4S`2T?
zuDSTM;_}=hi<Rc}g^4Y-`=;1%QU#}GjISQ&BJYu}$4_EDOWU`<rB@f<BqZ>IzD56B
zG?>$LtbFq+W6gVyT!K12%1A9I+{zHdrnDES{|1fTNy8FF>hkb`z2Sv4!;{0$b2%SX
ziLU1X42R~lY3DyHy7b$wT=QdxhHRuc$va-+zZyMo9o<bk2gI<n+;<Xw2V0m%u3xSP
zeXk>O^PvB-Mg#bu9=0|g15$rg$~lqyb95YA*u6<ps!EhtY;<WMt@Q_%)~?G|K<hnf
ze`WI*kt~7p0+PyYYN5dVyF8Gns9iew+ys@9$_M#K6gJN_Z_7b81kh=$9XItdW8u*?
zif}BG9NU&mGfEq2*=%;~GSBqS9DPSr)92zYW?;jdb6=d$eGHiaI$KQVNID&eQ_!{S
zC0Q+#J+sIbFPVku@0(^QqM`vOjH3a>Ygr;da17HGf3y6RtKjmnXwBDRvxyvGu9=w`
z9}ZCRTkTqx9l4cGZ*@fSGDyE;5fu@MxjI@n;?}UD)uZ{SAi&mn_Ju?LYQ9RZw0c+3
zLE?Sx_AVHSKIWPj3Qim0l#u<!yEgA5*$rARW^<O7VpnSzY|hQD!fx~2qgzZlzHe)?
zH)@91ErU`XKN)_XURx;riOul^zu^QH$Bgr#JWI&+m2k<3+U3CQT5%U&LuHY$jZKmJ
zJ%8f@&B!-fQQ@UCzVF+Jpu%U_(-kwpSUG0M#(Q<T?1m@pOJ6H|yq9(e_zv7wowvB=
zSiW|CTp2W<L2Kbj$w4Gy&c*z%eZ~yx*G697<MA)DQ&M<VAFXIdXcyx@NEcyy?A{Y|
z3FeFzmA}nBE~-~K#>Im`Ul8D+dz?E>VB_r=nZ)!oJ;@$jjDeu!27f?+)7#WrSC8=B
z@CndR(iRDFMp2>O3Gd!8?=A@1Q?fS=^`ZC@=eWPJdz^YT-|&*+!`v3KUE>50QJnFe
z+0sGwP<6H`vII|@;4%Fa`$D(diGu;6k2j{3hFwcux$ov&aYL%sA$x>rfNTH3FMwP@
zC--9pyS>Sd?*0pEho7f+52&l!%MEW|?k(Qxwl!^;z1_OT!d=*ESZa$x^FOk_S)Vx`
zsZC3{ziMC&4?o|q*Y{ez>ypq|toI+s#$!q9Z%m($db?*-pM##a2Z}B6MPR%*pEds@
zUG#MzoGtS9#?rzf3SDr!XMTiYAH3Yc)-9qwH1U!BK3aEz1$S*iM@C@Yg!V<eyr$8n
zH{R|$-oeL1zapQQP;J8Dj_eS(T-ifQnJCknO|#7ih`BBM5W^q>A$ubLO}uqpG-!5v
z?(2LKlpJkxjmEq_yX4&rOoRU*j3YSHynC7U6XUgs-MnJi`B^9TqWcHd6r-7=5ay%1
zl_0l^>*d_!-%gKo3#81)i0Uch(ugWZY4;_v!MQ80nlRU!NK@{0rm`b>0kj0BAw-r*
z7dm<avrMQa_x}ECJA;$pO_lgDy;ndeVh-h35NNJG%jXUOl?EuWd~my5y*(5S`*AP0
zOVHcHzX5OhHMe@S83=)>4ktk|wNC_quDDq9JQv(h-xSVLN2Lj)+U<^Y*1<4mJmwEe
zY88*`zBXzF#UDchnnCrY<2zzWHKsD24rXmCC&{DWtY1!!w?E5S_7W`}85($ITm?@t
z;ryep6|bQM?+i+QEYnDn%Y^00SJ~$2$<}p=;0QgE`|h5qH8fSD&%XYO8DZbBbIAJV
zVO37Co_6-*!xEt7E1EWBXt!32$3go_4xPmN^;x!8rb)BtZ>)(mKl{VB_o&Qx9Rpsr
zohd`MEst`@<gbHbvM>0bw+V6ms8gQ4z^^ZzxVXhM+*@Q#^w>R1?;ld($*XKum=+-W
zDJ8)#5SzM5gZ3>boj;W=3&S>J=j#m_#?{KU^e+CZ|G&Uh`6GV7mj=@A=m6(E=eZJ)
zy#uKa;riV={0Wd=B-jzI#T{xWg5y1!-`HVai@&b19J7AQ_-M2&2f<;wfBl2Ey9<LM
z7!6Vayx#!7C<dZqaMJM>E)+Ucco%lM7vA|kuJ?bB1VRd1{3C|Ujea=3#((u8nWb+G
zO7Zh#HP+O2PBH7Y;&iLCyYBKBbK&gwg8xh>$s^TbGrwbH04d#0?3TRIH19x<Ui7g!
zJ`)4uA1d-13`*pjjKBBb%*gvasMq=qc-gA(%86o+jjgZQpyRC7`C+HkLP7sGxB+nc
zY_0y(6{s22&%o$pcTuiPFT2<^BBU*QFVA1&npJ=U@klU#OkYe*Y+2R0edEDf-P_jl
znA`qtYMM3?FuTa0?QQ$@)^UI*U*>ZG4%NDtB}YWKs+2OyR+d7)4$nFRy?|~+4K2&a
zHkE_@p@4;=%z5A^wmz$4VA4bEN?P8oZLFX_u=NULI3axq9Zw~{lG7Uk#t)&eXQr~K
zy9-l@Ql7x-D*Lb(B8;Yw8Nk3Khw1d~EpCQ*h>ad)#nGNMtQvsxSQ5G88VAVQ8~jvr
zf5;ycf5nv*x1xmZKX$b@r{(!A*ZV$1?jV4|g(f|lET@4+H}=gT@NUw(mI#kVyddRD
zi=!x|qff1xWXcjJpLg2o#B?O5e<VaBUFklK@7}-6!KwMQV$D-?b1`4F@gcoS(N{R;
zT=sZr`SQ?~`%{O&ByEtcr;cO3-5I~&#YcbdcPkgT+x&tfvuukB2nJi)uXJB1P84JJ
z>3QXSR(J~Y-suNjEh3}&r$o_c-f~ha54-xI=d;)&xaw`VYcI%hVIAtj;4iR`aSrx6
zBNo1#2jQ^ZxCrwa9`&mkP)@d8#Xv0${_oXL?VjwBbCD}=OocR{*~6nX%4nEjI~17R
zWp@Vy+h@RZ3zy%w6pI=PS}vE32QT{;z9jVpphrSooto42Q>S9Ews;=DrvYl=SPZRA
zTZW$3q8DX|QA*x&_4se}26P#iTwsDi(%7InABJ_H_g=|En#90oEuZ1|$uS#NZ7xT)
zC|zj5`%yfu#H1{`3B~b9^fRfxT462>0eskL0l#CoCaGL_(?3%uj?&{roaW-~nXz5(
zXxRH)aS@QP>IECf_C;~=S1S|=I7XPh7A0?9o!OtKL~AR}=7z|(!xEO?-<u9?dKoN_
zhdp^9OK8nnkD_NEF3Q%}>pfbmKMwHtZ=5Dx?&w&o(8jF36E2CsX=B2IDKe+B{T>cq
z*}iL+B3b>;su~NVysG<nNt#Y3-C?6=(1~2rok86tJy~*HwVgWG$oNZVy}yO&Lh%dH
z(5%_r=h{Ta`O8I2XgWRtk$WBYdSdu!!UWIQI`SV3CpPVWx_ivWx-myNHcU(mt5<$V
zu;^*z<TIRTzR3R}64p7?m~A)F_i!b84_e&hz4y$s27i?p+>)W3oQ>by1!(Txs;7ZK
z`6boO!!pgZA!$uD93+7xMTqUlK5R}Mbwc!+5qcm=w*vcu5$Klrk@7C)SFPa2egh?+
zWhIdzAUWT${+&2T>2SjlkyA8?x0kov62n`QITi+bvU9kDWSP?&)4TqGw8tv1$7LC(
z*;AK?A(-=7)(zd9f7#OLpMm9pP8?q-XsP6iC$uT1B(@`lma1;ezCL%`$J}ap<!LV2
zDTr$L1>zTVfnVbNQ;)KWZrLr0U``<HY0N$P{PBn7ZYlR6I;l;l80`#{@YizDJ?3Tc
z&adZEHuH-obuv>qPWD_^{zE`BO<MgsdZCyR-B@UwoGaP&oh5mXe847nxdEgMv74!5
z+2MD$)#EY0_9k4|Gp^BIyyoEKps=TRcC?)LmV?}uO3u#yBDBmL_c32xIo*o)^&kdM
zelht&+G#BEeH`9Y@yZo1e`E8w&G!-c5B0-B;9_FGwm*Tc=D^^O-DYADMu_!~pJ`P2
zFM1|f(n6Y|(>h@ByHModBm1P?5ZK~6EZ#yb_rfI4V;n8`j^j*&_h<D4ouZ~PMvzCy
z7p>Tts|8T#h|91DA*F=}#=78Xr)eiAow~B?o%NrphP*y2dW=G$w8C}kC*@%=>-^ZJ
zu8aPIrA987ajokmTd~HKSE+-fHc$)8qBFK3nr!JECzc0>5$(%fgs4@PI(`2~ui8VP
z!Lig1(Ix`Vs-07kg5u42Gn7;KXBD>MlpQ;}abq#oH5l=8>>o9(n;a;!_s^!hRdUQ}
zmfhwp7(<#**e${+9eM++CqOa6rZo4L1Cz667CNCCg1Z;~WIJ~58Z9DWG2bzms)CtT
zo2znkj2N)XVn%<7E5M$54TCIc7R!FfE*L8;&Fivlc?Ff&>sIKj%ZGCxH?hd;k)Aa+
z^pqsryRuUd$OeqveFgx^tE&z>>0*va-0kQfrh1*k;8)!W!P!KHUdX-1xGfH=f5_E~
zK@7L=-@jkJre^l2(5f2d`<<>{Yl?!a7pCFF^^MS->ZHLS3vEgK3`Yi6EqZ?M`sqaG
zJ?#u~7`8{bUWW$Y<-4*wyJOmxx4kj#``XBoD%4p;c5#LJ)4l`}WzT8xp6~ze)r$S5
zdG;mA`trHQtHM}C5xqcjj7Dhb7C^45qMp3wlH1wOA~R;ENTmER%T<t77b~CNCdY`Y
zm8qABW^oFr^+tT-Z`;3+qq|9z8%ytQ*N``hYJ$w=<c<y&bQLSoZEQxCxsK`Z#&V~n
zKSh181karwa7$=d$;r!Kb&OW}x)G&R=|ms!#vE|3xuoU&_(MyDh*7yuiH63-58!cN
zU1y$dQ?D7}%%X{x>!W2b`;{){@s3en$?})6SyZqk6W_%g$j}G{QfW$?53|Lv(Y&q@
zuNBTqWf{84%2d75NG^r0QlvAw=P&rG82tD;tC@A^s{MA<Vh%E&T)LHfk#ORr9{-rd
zu})8(nl;gX8-4kxay92wv2W@t5O`CiA<+^~uwUfr?}ftM)VxRSST>L$ODpW`Z2)?$
zU`V#xn1Ki=Ne%CU$=jHE#%>0A(p-KeB_(q1R_IM*BPhOVAeNmN<VT+&t0uq|@8fAc
zkDFAc=JGMKTUrHsdvNx?IR2;2WY9#U$Qr5%If9_K^ycR&SOGoFX2|t>$;HL=NUoq@
z?4n3gIcXtp|DxKklW{7>um!s*Gcd9b@*d~<&=Ql3Z!(k|k|s0XVsg61LuR#%SHsrZ
zyuS9S%b~fy0rR?CI7Ig}hTQk+?&%_F?AW}CbY``B*V4;uRq(N{U~3f(f{y>nj-#$D
z-`pEk^<r)a6e`1p-E{C{P~@2%A*e?vo*ex~HB}>Cx24p<UJ77`3n@~=h+m`GSBJ@E
zqpF$7WMT|*P9&wlR+m(`l|jk<x9>*<C|&F(wlv-co6-zFMgP1lk9k{jRgWfce|;QT
z1AQ+N6}gDQ72kkuZY#y^_h~-43_eu;sp*QkQpa*+%|OR>ml2y%B&v_0y1=<bxK=lk
z8z1PrXx^$f?cety+A!A+vzga$0G-M8hOS?FzRZVoB-A~VrW9n3Dz?S9N@Kp`{zRL!
z<><=7mz#!R)ZQm5r&2w+!d=?gLh%P-DI(s*XI@`>z#L9?sTL#hpnnog5XI1@%pg?-
z<A-B-pKB>s=+`nB><53>z$@{}&pmZjh3NZ&2@d<2E2K2A{SWHkqHZI4G|rDf&O%xS
zRDkuE!_$ir_J$enP7^Gw^uEjXPjncvhT{)OwBvi=3lqWSI({-zRqX$&hb#s;>}XwP
zlY3Bjw8J#xIAS6yxY?yzlFQ;4L_+K_ZEWfBb#pHIh;?mI<$gA^M2z_F3WlL8D9jr#
zR924Aj(2_+r!-yXW^7nWx{rvmi^g!+JQ};+yeBrx#;Es@1p%z|JLdV`BVw$JC91&f
zbFXTHj+8MJ)J9@r{8x75KO4d{;#yP+cg{obU%e7Z&oc(qn@iD`6w&gVd1AVW-0jnx
zf)@XzEQdFKs;I2^!n<auFC}KNw@^Gl^z3ma#@7+3;E^_m#2quvB>UX>jd-xqH^2xO
zpP|S`xyT_gd^Z&T6)u6uJqoG=vXZA~i@#;Y9y-RpN1X2O(WnHo205q0Uy-Op`zp@y
zzAj+SiT%a>e7hh;Z4Ns+aoXT|`oIrkGM}?CghQq0>FL=P)gm*7`f+(36Y8A7mff!0
z{&#%i3QP68GT;se={Id-75EnOOl3;azRz0R5qolbJ9#MGHZ-hP37Oq8sDa)kuB?LO
zVDi`!m5(1);F&Aq@+b7?m#=AR+u8|jrOkBoe%_{TucZNYC+iGsop!zGXH;XiE+Jfj
zO-3w2p>?v?k~mx)uba({>7ASGTIx=_rD&Iu0xK<2<+EMbVykioYx$%pH}T)#PW?;(
zin{d@Yo5r4hRUaFJRRdI14cI0=)vk)<|M?^FIgyeUHl~4<cTH`YUKty&nI@WL9Lrg
z6T5Ud{wRCZtuw9yvAA1yp0@B7(WCKblvnc?r=8szqeT>K^W9~K&;;4_a}!pebW*0|
zbrv~7(AKIkv`1l2?=BL;n>waK{=$zUG<&je^v*@q(f%SMh`TMSjZC7;U&{D%J(aH@
zi4aP`hIK=w58a%}NGWY-jeN6oi{59EqsgY#BD*MEZQqXaLR-qmTmz~`Jub<isD|^b
z55gCAoU2OH5Lr?!1Dl?gt{{-sdHspH7T5C2vD|lG$ZwHb9##3_Cf;?As;#irWq8o9
zd%qG#_W*;(y7V3i&I7obF`UdLIaZ()SLTd5Jww6hD=9b&C?A$SN5yOwbj`3KIA@KG
zOc~f7uKc_a4cXm<GHGu&nRg34^(eB4v)kf|S1G4~=x3b2)bHN4a0rr%H5%KmhU?LG
zH8_h#ki-DeQju~#RT6Jgp0m~ra^tVy`RM$kb1bpdlc-w-QQr>87UsZYqY)~N1?o4P
z?tMHI9EyRFVAa`M(rDZK!(o@G7uQ<}y1#m1H<j&6+r6jO33BOK+67-z%q@V|X9~Ar
zbMed{hC&~nW|o9~o4+UTktv_5ohw;KFea)H^dCmNp}qb9T}lcSA_!rVqNK>x;m<WM
zH}S7*5W5~eX_8z$5~|~*QkU~qteST4tov*omj!PAotwj8*f6u@hc^=o71HeHDZh4Z
z{PawO6O@-oW^t&ZE-TIkv?I!2y2I3sK7+aNPo(sQEh&~{4Qwd8wpkJ{<Qi+u4i8qs
z>IMRw`FiF&Z&TJ&>Z4245@}CqX5My)6awS#xKWnWi=s`5U!UjSqU%{cVObPdw7f6Y
zM#wr1N)>A_b)ovoYD)_;>+LDoig%7Fb!fpZQ9kQl&9YSu#ob#++xm^=JnpwQb+1>h
zhq9n;?zU`mkfm6L#0}(I^hkuVyE{H=sFMhH3tMH~$u_?{)U`80DS4M#_S^^O*%XPr
zR)F-yS+PqIr8pNeu8rM~`Gk*`Msk$R+pK@u?}QNQx>tg;59ezNL<k4WyTB~`=6Xba
z0%M{pNS{1nHoo%QhD}HJ_uw~BY*EIQ0~cl!rq}}a>k`B5?Nw5bzXz^|^**Y0(T*B1
z?~0D%eio!FCi@6i8I`&Jb|^>rIT%)6R9LBfr+XzD?>}$599&9?k$zvk9^#@iKI=)n
zdIYFkyEmg=c0KZNh<YI<>IZ1U!9loKGDH)|nSk@5%&r{2TVUA<_99JVFid&%0tK50
zk8@Zm>$EQlpd2T;+TgkA@2stx&&+Yo*%}|Jtu0hGY69DlzTh3Tt~Dg0UwCbiWL8eR
zjc@5VX~!fWAQ&uqlF4JwX?SipKh&&mP695C+{Bih8@@1{MeT}OpVjMZE3#96Jc$c<
z=l)#ec=S`+6>(H$LN&vRJqpg+xbd52e3o;^_I83XK7QX&yjy8UGwM-NB)Vd|VgOy{
zOs%HB=zccsh-q@NNbC1pO?aYzgp7^$o#Uxx`D{y7B}_;CBr!r`Z@x-+U}q%_7I)bu
z!T@=fYy3JhJlvt>xlgX>*Ys@iL&x|#-|evD)1)PjBAml7gMgx7D%HV<Oh<DajW`b4
z1+jUnFbP3Odz6c-Npy@#fVk;AcO=QmA_L=d&z`_EcfUV1n3qwaq!ds^o6YF@J88_W
zkO+f&r>IZ~e6T`$elPh~HVPMx&>0fKvSj$jyXM0Z1+7<V-g$jy#&Ok%mFtput@5b4
zRKnEACJ3!dx#IEV2Wo_It{jpOsB}%zlRQuLnO2InT1HdOt1y2hT`*=vA{>5FYY%_H
z>}4HOa1poSW$9RgQ8jUl=Fb;iHTDA!9ZWkJUoRDBIkzE1NuQ3A-`Co!QZMKLYidb8
zx^>Hc(q0`yPf*R6AnSsTVwtU1b1gKXSm=K`1uVLIhn$pbusu72KzqFD%EDcZBmvMC
z><!(m(>6odMwwr;GYMVsdGyH$KMT$4=(U)#lCj2OUpaLdxfzAi;mMYEj+*zj^)jay
zd<0FL=u9$539JO92f(}<lKZ#M;*<32`lZ}IEyT8axei&cd!=gXUfivDXALFHOhn8&
ze5oAaxytSpi8myBADUg3Dn0mi%k{1PMD!dEKuEz95reGHi*v{Q_O&++7r$Dp1+PqL
zd{LJ+G|Ll@oM#Y$pu@)X=*?HQ|6-l(IB7Zce%y*h$D;RJ@Wo3)&xDV0?E;hUJzlcy
z?ihW)<aj1w|1nZB)OZeUEUDt~p1<pp%u>sm%>7}Pn=W*#aq*5)S+wFBXINN7VAXD=
zv1XoMecie+SpT|i<b1^^hqQqbaw#&ih{(bjqwEzuZnJFZgSXcz0f{(6fNsvEFY(wc
zhS&MFhMY`W^pPfZ^07q#!Dj3O6WjON2n!(Dpp=A!cOSxs@>MysZpaKJz10h{c}zU0
z74_13U4!@GPq~UWwMmQM^%)z~VQlbVL-C}JAxcUUi<0Ln0O+b~#uFE+&fDG0JA-Sj
zN*$BYkyDN5z~lFndqGwlvdJLyM(7(Iqc1u}drz=wE;5S3!aGMjEy8-SS%{wrew}Fl
z9Xs&ZXKeFwT=4XFei+5HJSZNi*E`>c5qO+*dhwxg(F;w`CAOS9cwcO-;-_&KqaKz=
zsTKPolixX}EbEQ=9dH1=6)P&Gs2B|~;*AwLf4=6m^`a{YTo^0z6X8r7DaxG@<98_W
z%S9^~7!>}aZ{)nNWPR~<TlVo>=?R{<R8Dw48%11NQ2gjm^;1%by}yK-VKtN_JwK6v
z{P}PUL|WjN6V!52!-R+09Q(@Q$4s+FRaC+)BZl{z{<vE{3~&GJ03_uyA3k%WsRuMc
z-IWIQ=%+pRdR`olcg)@0N{;8W2#Tt~F%i04*QawzuPJO@=}Wwx-E>NJD4%e0qehO;
zqNrC3{XptL3ma{%%Ea^q+*WrujgF4Cc5gp1`W3L+OhnpZnzW!Mh|`!9GPO$hb219$
zy}iJsDwU!yt_VROF;~&o&sIz8-wto=@<nb6q$la|Uy_JE?z+^@WEsqg=3T3vnqK)6
zyhgW8;Yzn>30WK`e4n!K5&dB}BZwuCa4X$cO(~~CS^|@01RZ0oS6&$YLiwTF2WE`n
zyL|4>LD{>p9`K^%N=-z#wGE@tQE6jpEO*wHaQJ~7AJ2Ty8yS8(5n$-ZF;w3W)%h*@
z;wI(LJFoa1QUKuHt?J9}Dywi&N2O+idh<_ipkJjzAD&K)*d#;NN^)~cWI_kM`oEaD
z&iX7^E(|s79pW{L;;^qo^H{it6DpiE)Mdx!t$S^aI<%Sz@;Js?hG5%G9VO77Ui_{J
zAn20vM&$B}J@|t=d8eJ~QO=o<&H@AEYuI<E-GS%TLK<Juu9iSWfb2Ro_w=6XQ4w;l
z%?il1hfq9YV*l06%6MeM3+fX0#VHRYH0-pRW-mD@ODhksJBZ$_W6jaA%5ZPckQEZ^
zyc)w}aB7Hf78fkl*|TX}V?skipLOx1SGJ@kYS-0KE~|;)NO;o(DY?FyXiiVhrkV&~
z#k-`yD&ShO6Y*54p)2^B=vw=y$%HTPPtDj_E^NRok$H2!o*DeygBFcE)7;|iVgCwO
zA7(I@8ub~ioTjUU|FoR3OrF=wH{tvOFZ1!XIB&R7jJ0hcSN21`32IyjOP%*8gbVn;
zXnTFc@YAbcZ|?_D#-!KBWYyCeAq{(5!G^6wp4V%BtKc4tZZDF$q$<fR5ppNu8iUd)
zy+G%z6aJ{auz$r{W^dTXV{INg2SJW6P0jXt*C#(SxTMGI`)cP>6^1uLW&y7(=TSDr
zR}qz<W`#LSp3gDqo!>Ynv<J4_bL9sbAt1f48yY#jsY>l4Q*}l+HU5RDZtq5h|1q0J
z8GREzcCQ9c%B$PouNzDG#OASmZxDOQNP<JeP;g7Hu55`&&Y1T+T!N4=<~O$|7ovS^
zSA>qIzl-5zY$p@aXHcE5%=bjo4GJ6Q5(M4+Z|_a!P1)<^+H)>yNP2@a$$PGKqYT-X
zMF1NwU-NXB2bNFW;7-;`$5hCovR2gPD>$mzKdyca&|1hn{r$}+z+0?}b8R`6DiJY4
zcCZpUhnJQya>gcIO2!h795PyT6ev|6bszR*kD(dZlH)iPfJ*!S*Z{T$>0L8PnM$7I
z8>m4=-d7t$a&B1yp5P~PFPcwmX9b{#8D*F*HaK8<fEP`=n@8`Y>)wEgPC=dL-w+W|
z^|@yluI=Fmna~_mz^?113ycE?=eNGWB-!9D?=I)$XkK|4O-QvCP5s9Xj@hcGigk%u
z`O#KELs10?A0n3{wD5uJ@%$DZ>Zt5T2nQ(f-Yf?bUoEMl(wdur!N99^r&gWrrSCrx
z3(@$A^y-(qP8saRQLn*Kdh+b&rEg?#OfwtY7u7nR#0Smr0eq0+37T5T7j6+W*zjHQ
zdZb?tTEVh7J!Twe9xMv9$>vZE>;$We3yypmxdU`oZgp{lD0a1XT=}@dom$$~vhqG$
z*9{*WpnFYVPkkAN<z({>^)J>_>6OO|QTsJ<@CTY%o9!>}F|cm9!%*Frd;GYgPL&aE
zRwhFzxYXb8acp61!~E`QmA7J&??`SO+%pFRkBM}jRc^^QeoUI5LnrWO)Uy!|E2K*t
z9sOiiJ_pwkg1RQT5{m-JEa}~wt*W8m%D3Vm36!2rDooz9>;4X%y3fUR*7*-xqK`BM
zQ&#geBdI$|+hmo?oPu$>h$%q$Sn!6#YcD2lMiyA<I2kkZ8CYvOgWsAXoBj+EeRy&P
zqbwr5vsnGL9@3R43WRb#k6HmQ>VNH75MO+EA`a4k2b{T%`sEJ+)Iu69DA(C8Q&5Jq
zx?<jzzd-mFn1*m0GYodwn?ISQfk=P{Tb6-?0PAblq)1EWN?FY7e25KkiR%NeWsA!I
zM(2IC^H;}K$jMKm?UBCsuHFEI@pqbglzieTBIh0tgngU-vLP;sY4jauLI3tQ&0-X$
zSD%74v2HB6IX)ji1SekO*|e|%SF#-?Gc)k8#xOrs;Z*8blqp;DpTyZJs*x0qF+}ZC
z%7_;qmW;EBx2$+Gjupz)SBDGcT^f<6$T_&GPaT<$HtG(VDN)|KJVT)m-C4_;f&8{$
z%0@#lRRfHLqvK<lyjQOaR+5vGIU3Y|bB=+Ddt(DosY@nI$=*VK(_{u=I_~>w@8+6u
ziXg1mq#$&`7R%8~C<9JsGGN{3s49v}(Ai}Idz^;JTHOq>2M|T-Xv}EAe3VrQHx)A8
z7?FiXc<I^74c!{?Gn;6;SW0tzB0}(!_3@mtxP^7t>iPi-y{<<}ytdLHc~Febzd4Nm
zwZV_D2a>1}!3WP+musuPZhJsj*}T2JJBdil`0OCYaEh8nH<Puo#gk-WC4O%MWyyDR
z@05@78Z_xpt<Ban^h)LEMn$FIOI#nqxe$&Kwk+A%IiAJ8)xPFK@PCu71p41xIu8m%
z0QEB*p|5#9lvNjn925gLlNubxA~X!|L+*?_FcQN{C)pRN3ZjPk=m8>>C!H7LlCXL{
z%B1w6qv>LKojPi74{lu}1TgZ`%>t$&BBc;6K`imJdz!R=uB&0w;=isd-6<t30I(7*
z2-{eud1&VC&(*=FVz=%{swTe?bdoXO$B)jf_a`0B3kIGC#RCUpyz8^4^$bKe3D+LX
zAzL09v51*Z^HNe#S^c(`V=eZzpGBOChEKLuStM@_S_++@P&*|}TxU>J`GJlZzB}Tl
ztn$Mcp+5Yv1rL|3SeTByUqt`8un-Z<++OBzEC!ta=tcpSlsExFa1b^H@`BFac7Hv~
zn5>~X1OBEiUt;L<PQx+WE(xib$wvRk9u^35?78)04#IhgX)eMgm=zuU*OB_|zr4qv
z{<rt|pUsq!fz#cc=u<@%TKw*Cxis6Z#P``8Tk^8)Bb^9B!vC@^XZd6hVwL2uVtcLw
zcu(4oSi9Wr|0e>S6qESM(u1H_cd5gDXq@rHb0L$eU4|55OGM)8>Rpu|Dr@k=W(P@3
zDZOzI@QmSHrF^%q+WWX{QawU43U|e2qJ<MQ5h{db2D8c+s*t62yqu}4EI9{p3afIt
z!lsI+iXx^>RrV%F7n8W5hk!eiG9Nt|`@|M;Dj2Rt19{fdL%^=Mn&!?vJF_+by}Wxr
z?E5p#TNFLPZ=jYJgWjqg2klZ*F9UQclBR)XLPeTBnJc;5ch*c>;*t?oQ?*aBb>4X_
z8*L)c@bJMEqGsP*YO<9gmyn>Ie5Ca&5tt&xq9#`R2z=Bcu+Z_dDpx@cth0aK{hjbV
zee`a7$YU?@;Y0MGntL%$U9W#^SlqM8dRHvA#<F(WR`x<da}QEvQvgC8Ew1bo3qMw9
zw7&u^^5lKNc5R}XqzL(DINPjriQs}FZqB$U{ibNFxSnv#rG8Iirr*&pa*F^VR9H+C
zE2%F(c*sN08>;i9RV*0*(NN%mP;B3Ecml#rUJ#`lG>$MzIo`|rJs^%DAT%QbqpPc{
z>Z6^j-@!Pq5eIGJnUDfj5v!jqoh0!LDb!DI3b*HtHqkB6jq%O$tfarWrdngL3>^1!
zw;aJ6%|es68U}``@Kn6$IjS2sq#^FsMw2E=D`{oMkT^3bxyojI01xrK&MXhX?QF$w
z##e_bACqthNH6K<lpgq^yJu+@9YQrjojeJ3iOSv@q|p@B&_z7nfMHY!lkxyPVqG!o
zaB*=}*GN-%_b;---ItXll04)6vBpY~m?i_Oh(kQFaR12(J>Ntzn`q+5Afw;I`h{)H
zzR-3QER@jc5`%z#Bz;E~91T+0Qx*gvrQQ2Y7kwbgt_&**NPdBY##vU-=$<ItyK8`U
zWSsMynpzIQW$5!a^Jt`lQvQG>4dlqo=XaX4Y8y3ijY>-<2Jvfq&dfIE*3;q9n+Xp~
zYOwN1qSVSLkY(^C$gkuVPwtY|@h^(D$V-Zkxy+7c3AC;CmOh*o%_I|xt=Gw>3sxI{
z=HiP5j`8c)uP>L(>emdF3?(EyHcp6emq8}jM3{Gzp0qFkqf-17$LzxWG}dtfDfG&z
zx-QXcs?}Q*l_W=t^8Nh|?=Ima^*-S7m4!yGxR2gv;><rZh1E20EB#}F>{B<R&kR@n
zPYg!`Ys(7J461ooN_mvA5AtnJ0LhQU%e%sn5=lQmi&nj_7VPX0HO>##*?l?=?_EY8
zrP!n5W!XEzAN^Al+Z}?Orr+Er#*gWtM-Rg_58s?|l$vQ5BP6J^Na9L=?0E7tw<YS%
z3p8VUk0YEo4bD6~1(LQ1)J8G5(YI^sj3Uqi8b*Wsieb?yA+pqMK}8(PVK>qfk~ben
zuN%6Qlt>btvjSA3kt@<QN5v&`%XZSzBn;JZQV%1PQbgm7EPyP&pR0k-RT_4wW3I6Z
zo9!uIFJ$Q9gDCadGMWbOoIoPr1dXX*=w$u}ovI>C!AXrGCWxv4%=MbMH=?gxSZ|Q2
zP1sWSj(A*O(zLJ*_$#81o%eVkXlX<D*xS-WYqMAS;cx=h;pI8d5uPOy3(8*?umk1G
zVRZ%>t+9{Pgl7%jl9@`pZAcucv>8cZ=|dbULLA^=c8X*{gi=uE>F9X<($dnY-&rr3
zk0xhZo^H3Fw^E-(c-HpE7+!~!ALW`Aml<LnqCAc@(yQ~wi`}b!$wt29L~A??HElQA
z`;U*_D=Ki`Bk++I%-!3dFW6`~G+}}5w|!TS>PgM|A0tjJrysHKhWX+{u}!CCQheH$
zY|_vjWt1_9$p0yhzDQ(?Lz*zVeXn+R^UIAs;hUhkiRIS3C8l-5&`9YH2<*bb1nP6i
z(MdG8kwf|W%64b5%a*HJRv79ycwLX)>HpCu{!I_g_DDRahs$9jS9<-YULoaXB2MLx
z4#%#lm=%-Nr;AaH<I%$@daX?l{u*mn*i!J@lr~}cgzR`Gx?)jK_x7gDE8qn6)O1s4
zJ>h8&T*RUCimNL$93xs^uhO8Rhd{~H#pUH&UZD`dlXf)9D2r<+XKaKlrhCrbEb-Fp
zB~h6D0me`Q8DE}Zg060G{mnj$fx}<NZ3KGLu$N;p=*!aUJd0HDTTp%z<J-h55B#*W
z%HHZOz03McjjK{qFGbG>gb%o~d7@`KLoy>WnRyYxf=E1f+gkP1MCw#y+Zj9#%1`eU
zxhhjWc#X(>r8>@s)`%MCFCvc)+z*NRG?JkG!5o1ObNcuM@Kl0E4GHGGWVMw|<gQev
zG}!)}*=QJgXKi3rwQImFF%Z&=J>}OSV6xUzU(92D-F!)F+d!CUGqe6n^q(%%AmveZ
zC|haNLKB!V6v>{T_OhsWl+b)4eaP9u$HgSq>4V`pu4)aUGDC1VEH4n*cQ+C1MFq$l
z+q5E?38kJRW(GKc6n#GmGvMOo915h!@!+mxkmrlth;OoKd1|#x6{Jw^^G}QMH==Rc
zy|GS>Kt10c?C@%-RG64;ehE!2V+S9%p$h(_=)Z(QkD7+ey1KGD5r?zNrEImokxakN
ziE)(oZ~kuY!QGTkI~hZ9TeBu75s7bUT8OHy-%v;JRG3tcaAHdqo<*MST!n={Z)e9j
z=XTXW?6sA;8-iM|Z@b2R>0pNB_`nG@mJY22+|A_jgckD)-|ZLPk)L@6Kt1mazJN#e
zz_<k6Z4-m^;tLPNUge}4B;J$~ur}PK_P#XLUIoVIS8B^eX1>oqmZmOQoRohdha=@A
z)bGBg9!AbZj613s+1~MtQfw~J`t2lMz299UBtt&W)Y-zea$)`Pc>VSAPLIQKgjGc1
zhrwUdrN6)TBP4~lqWI$L2#w+FCB+Zi*=8Hv=Rb_tmfiAbey&=m6cI&OIU_s<jb_;h
z1%_+l@ST=JZxjM(suI0pJ*pzYBd9yn5?V+kc1e+VlD*3)5d0A(m<kKBfUK%&im)b-
zbhsZ8`u&5H%a8Rkx%B{pcDEs~6MQ^^vOm(XEPJ8hd@WbUA|v(rdLX5{Ebr<~ZBzbm
zD^5v!6Ukp+5h_BdPqdfH0QUQOgkwB81?8jm`FecoTlHLzMo{JQY^x%U-RYpd{uP-#
z8rM^NRg;n99P)IlH{m|sg6~7}eJBgE!zM|sC47~+oUlu^kD{pTv(e^!m>9wLUnhBf
z19Krc<OTehr~kwGa{C^NjuF1^kvU-;hC@L2=PXV^!GE15`fo7zKe1pzRM*A0V7LS|
zNe@C_Q-#ElfZ8W*GJ^y@+8;rdQmQnLw<8;(-Ry@UO*F=%P1&~a-M!W)$HIeL$?X~g
zYwAH0%FB&6e<6tM+2-{qX$=t~xfguKlk(K#{Tb<ybBy%hZn}SD*VnuDyac&~cA?tf
z&lulAe`2!b6@|nu(G-ZOBK#er;J{=mnYgIHHj%&TUczy$z5KoHgyEXsn=&)H$|wnU
z+tg3+<#J)~oLC%1axEjX9z>;4acodk$|^f&R01-WkGccfzqg$H-nR0|Uhr4wwO7}n
z(|b#PTV0r^7O781b)Nu3LHiZ|CGn9v4^!Tf-1~w90r{eFiaE5ccNT6A+xiT1j&a@e
zcVb^-8|v_ORtdqvPDp5WHHb*`J;|(x2aHH`!u%sc=Z07C$S@RvgE0|h`@xT(SfGF9
z_}2IUm}e${=hli>J-vD79m7cEk!4`%nZ%@T>5E=tl`aJIvr|p&`u@Qe7eP?EE+dVG
zeY5!|4My;ERVmd#soghFtxNC$J7ZpAs3-{35Ow`plYMIXm3Zkr+ho-pyP44Jdn>cI
z3V$mkk6NO566t`<m#}R6>pJcfnUuk`!6B@r*@{h#KvfRodD7Qn02S01K9L<<)%L`D
z5~%O4U8z4xkBoD;mzx2~?GgmA%Uq=n?ZjJD*%Mt&b8IbP=iY;&ltx@(odoEJQvlw)
z5nR$ZTW2O$0vum53@*H>eEyw+f^Wv@=9$)IGh7|=3s=vNK_Rp)x6_~bon7l&{hx(n
zXyq9M%s5(LFh^sqA`Z+TY%WKU@Uy^notCt|l0O&}aWtUWHHT<N>`<*&O{E^2oLS{8
z|8sC9&emd?ix7zB;~YoRw&Y#@^2_VT@*jQR8nnGS%>i{1YrZ9gf+ta??Ja}evNLGf
z^ZfDMpot-K2~&icl>O_nv=q13;j|%<_P8zn?kMqyS7aige{ZV+F{LqoV!D866dr7z
z7Lf(hQGMq>6WP=fM&DOr0R_NT@@8*d>f%`P>+U_Itn2nn?jR`1S?f<Ng^D!`K_Eg+
z)`ldFEa6G-^C1QfuEg`2ZnQnf^OmjV`6JV4=-f)csiC`&z2L0wXh?%%i-=CW{fvEP
zRg9Nly+b?<3zvn?#d(Enpka^~mcTT5bTK~qAx$?dZ(ITi0R^{u>QvtrCWJQh_%v0Z
z3O4Jfr{`?Dezvd_C^Q<#rF+3O@<D1(YA%3%U#;ijVydDn53%7gq>nsMRJizq(7QU#
zPgyJZT{SELf9xdsNF%%#3>qqC7UZK?Kt3g?4oNtE>r$(ML125b{H|e-q`{li7f1Fq
zI<~V+&Bnf4npx~ia=BD-Z=?pfMgpo*g(pERjz)d}n_bin_l;w6y*A1gvWmmT!wc0c
zUHn>u*_wfjh%LSq*H77!48EBlquITs?*KiH2P|BI;zdT*p_(d0P=rJp4Iv@I;>VI_
zv(5eNJRq&=X3ca^P!ViJ$Nk{k89A-6MC`*-zA;bp<5Jjsn~QLBn_O1v;k?Bx@R<qy
zkI{>l6W@yLW}N-Wsk;zXn^{YX0u9_m2;e<QPG-?vb}j?Ki$7~LwKZ=|o3Pmc$?>E8
z7%eOI5vIn_UFB-XQh%})=TJ2<(ayQz<Le~v<Vbn#p7sy^ibjL4Nf;`W2%;3{jZ=k}
z_~0+GOGvidFZZX4;27v`oR)^QnM4;LY^Fq0R2z?>TTs|wldY=Ociu9etvzExM28J$
z_tq>v>mmQ0S5A~FRx514`P02i8=9w12%LV%-n|`fAE6Mmbp60I3I;oYCZct<5ljbT
z8Wcv>m!8fZb9JlHNkepru+s25ZnrpJ@*-sTi^VMaB5T(a;?D&4(HGNGD3|01n$nE3
z&W~qghfy2G2TN{Q>s~1X8H{;P6-^l+n_$w=PIEVhN?E-B!`fShMftY-!Ul+hASf*$
ztsq?jGN2$K-O}9+f`kJq0@Bh9-5t`>0@5YYEiEyGFw`*cUIYKNp7pG~*WUZX%NOPF
zIPeDU>pIW#SLYT&7^1iytQC)=+nplfWuB9pi!d%{)hsbYhg^8<=b#xRZdbFX|KX=;
zm-ffO<aDaU%I!2G`vr;iE5`Le@~@SfB<e2TVsae09jy}G+sm)TAHW6YX_`I4zp*?i
z2s&h!WV?R0pC^AZ!<F>lhf*$XNTyOq?oM;JO=H&^8f5vnmx)xrO{27Wjmu=2UBo$f
z@tLy2D-Er!aZF0R6-#L|UZ`qo2gxV$uV;_2>o<IM4c~4pCobedb#OI~O<x(P6GWGu
zLeKEVfc*8cA(}9S_BUmd@I{d>!0vt%GBW>^l~hKT{ABa(6)1@iKv`{1qE$BKy?>T{
zP3deqg_zCt_MU{UoeW4NVjl2_NeGsg-wM<;heg&pJH&~XTjqlz#GBfoxO5ETo5*%h
z5WR?;@hTg9kWguJXW&7N|2G(E{$ApM*=OZ`_6l9LFY(LYl?Pht&()SGy+wF8t)HH=
z`3Pyeui*R;w*RePOr@AJoNo!~KqQX0LR`xFq+)d)A+t8kKF%LSJUn=fur^}-%RPaa
zURJJ{{ddj|0>Re}C0+)$ff?;dsF7`ZKSf9E;~lg$-K7&v42A=1y5-R8M$an3@201b
ze*x7fQG*K#Yfn4|M`V8Y0oq86lQ@GlY~~f&<T5E!tyAHi&AQ1rj{4lS4zP=>68~3x
zJ8@m(LQx{P1vJc^m*(TxI_pYEZYpl31s4y`ljkFCp6qfJCR*k~s%D;bKj-HBlr&ij
zWOd8A@4)vw?+yOoJ+djTUVT*&n{1~|-0ddPn^5p$s;~}GyKK>Fy8l}~gYn~~L!QkE
za4*)w74d#x)Xn&a)&1)e=O?mLAv5!es4z2|oGWBQcp`Xmuu1K?Z2NmH2g}=t=bPy;
z{Up1Dif@=xzTa_wHD3ZD*!0pkX=ZEj+H6pB{=hEuHx61EvHF2X3}u5wakGx2z8{<u
zKHVlk7Q~eghK;1%#W1-F<_c_6-`#uPOwFPc*{2$SlLEAq4>vCrle<<rOw2Q(h5~KW
zbi$WD{>n<U|FFG6GM3>}`pY9nitdBgu-u1rZNHxLP>zzLtc}Si3Ht&03C4*>{6Vrr
z;uvRnz5FMO-GF2<56b(GJ}*>SBS+W5GCJDsl~#T(i+5?5Ue=MvK|WlPDd=eHF5?2g
z?xJIWuddVmt7Q(yV?~L|KYmz_CE&_1*+*X)wE^aaT@Wp?zs{%ek1hc|;}4erpR0i)
zMx*Gn03j1g?K*z-NqQ)dh)2YSe7BrPs024aS=7&(qq`BIeH|MA=}Tw%?;biWE%J`e
z&N6S5XQMw(C<Z5ZkX-#&J8cA_yeT!}61+68XslXBM(%g$qf&sY*Dt5C@;=aS{F2Sr
zYj7vrq@MLNW7RM@4K?vBu0ea)K);UuXa}hX#9?e+PQSl@I4-p76l$cUyd+bdr}$KX
zm)lN*a=>jEAzr<se&NtKm_3N=Smd(eS)!tqXX0FKa`CL(sMG>-no=-eJDs@Gq`g|Y
z&E{26{FXMHM^C35ihY*IOs8!KSZ7Y@v<lp(PRE@1o0@~`PK{1ZTAKCPno=dks&L(s
zrvppbZ5;U*9QG%Inz%+*@2D~5F$X^Ik#aRW^<gu8FKQwov2UbhX9s@^IsSdKF@Eb5
zvH7~`T`kvkie(9)&OcBJ*c*-(sC&xi0NJRl2>ZpT!D1+-r+U)6sL78=sewf{6P>?*
z>!|G9Pi?|YkcZB?UX2*dIdnM`MPj31;BT<Sun0{yO=T|gLb|Ej^TY~nOzAe=sedbK
zAMG=E!J9Hu+!JHawn;h{`vQOSx6hfk#JMvWD@|#~@??!;TVChfwv_v>je*<2(gz70
zgGcRMlQGAy&Yo^}uEN#bj~cP|s!HJ+&>3K!E^V`&+dQ84y;$e%v=;VX-hXr5LDuoa
zhOr_{ndt$@L+Wd$KRI3sFY`oLH!d%`mHc=R_IPtp5oKF->9|HtiQ-xaudYSSFe5#l
zIOR*>Yz*3W9SY*>b=+)5@Sg3g4=N3~_M$d;YQhY@A$q5*9gz6CdPr<NpE^5|(z@Bx
zjTz0S;VADom#EkJc|N|IXW>id0?pw9A?gE=recNt>y<MO)fNZc%_J-JG_w0UyG&;(
zslJR+sp&V41ssalp7pZY?42WbmO6Aqhiw3SFI`mT2G?$ko?2dJ(6D#E{dUHc073>;
zEk!WhyU$r69z0*CZTo_Ke!{-xu%l3jl3_l+M<AD(^P^0XU_uw3-DEwk&A<ab9!a!}
z_6Xng#P~``d;Ety&56c3K%E@nU7n*cy8YtR({;kq=GdCPn$j-`eqL-Nx@d<;>ev$3
z3+^a4n(ZVU*?J|A)q{LJimi-z&<^9fE;7^Zk)o0agLNOrL~ho;GJ`;x0e>5@6g!Ts
zYd2FeR$pVnY&RB?#ChZ;GZ3#MqTj*w&WVVx$~@2&m<>IgCiY-n<8f~q+LTCZu=A@K
zO^3%P&1t+?a1joURMrA|?O(UUM%K;*LFI8Rs#D}Zh2x!5nLC$opOCX``RvQ;yRz05
zttY{E0`nenPNdWEe+UF7=c&XEA|teV)@djxYk<JS6wbsTslINvbnjcioT6NwdIys4
zk*scLyWQm6=fcyV&9kp{Vnd{rurh=RiR<<KgeHavh-YPL!h^!PYjcc8&*0)qQ<ta<
z``Y@MEV*viK>y4@3?o6R!I?hiiN>?2ed}uSi)T-?MtC6a2%~IzMi}dKv)WKDZ;J<4
z-230YDzL-XqN!+Knh;_8+1$c5UADexbDE*I;er$t4IdvUYGHTnvl)18Hal@j$1SKS
zn5rnHBSUgL52nosFr){k>P|4|otgHWbs+voh@sL4S62VpPJ%cNo46<Lrtj@3_jL^R
zb^f$*F2VdDipCL1thLg2<bLO!Ys~RHm1dsyM0+1MEIfmy#<&eo&OE8EgXNr}Iy%<l
zPe0zONp(3<cOE_78O1KW)<zrUQkAyGLmIp?|L%J5!J^??_d_o_mfPT>xz;66?g-wf
zk5nD*cqjh9PODXvNy9hF1-p;em!9&hBZ~ic;Dr~-&phNnDz3UmRczVZ*%>OmN6)wM
zQNtlMN`ht_etY6H{`~k}U%7tNb%tc-+V_cr4p7yULf|MTNSz<WcDb$G<F@r|z(fPl
zh4wgVP%RhH+9udQ!>W1aR=*&)bY{XtP-}dp7q`reZ+wa%v-<;_F7xE8pG)qEP0<?h
z!;%V<1}#_uO<sTT*_V)b83b<OPkX~6Pd%OP9g>T`TviXpUfM8!klV(cqE}k#2TxS5
z<<cD65noc@H12BnYCRJdUpMujw|Q{JXPhEQaGT#7(#TfDM^<J}@sp^nA_+dQEoB|`
zO}l#f&r*{l_;xmqlkM`#JNuE;eJ+-IyS2%=Co!kGW-fBp{kjlQa%!~-)=W2|WgRD-
zM56niV@vYoczk>VA)i*YQkQu8+!N*Tq4JJ`Zdz|CFYZwAoHC-G2oCt33kvMuMlRTR
zK201t;=RD<5!58Vz{|F>iCsJuP?UI6AH4-4h0HxYwK<sTomX%)N^}Dg1spc`Bx+e%
zS=)|}pN^Fpl#VN<1E~6SwJi)3G@v|s;p$qYPbUn!V>6!<{B*<9MaWE2ud*g)fiI<v
zvG5>*L{47b=+d7dSYY4oGRO-!f<_vg^kU%<Ue%(z$|=#YvBtwW@}7^Yf=M}yXEW=+
z+O}KEH9N_bBC4I1Bmrgm$b~z!5-mk;$W7MoF)c7&t3gC3?z;zmz+Vy1A`O`Oc>C69
z@CSV5p>J+*3LfD~N3^vl<6VyqVCd{A!B@Eaa0dL}<zN2A&;4gM&>zQ-H?)<K($b!G
zafAV~O%ntot(dn55u>B(4pi)cok@8iaR(dc%I~ClTqGvt%>mp&?VvobKG^N^`Fc;x
zE026=!1qt+H#XsJH_=-kXK&}Sp?kws&9p|WmQ$i1r$SC&-}=Iz2Cn*pR|t$ze&Nmc
zK0h+}yC-0@2XOrM`&)SsL>@%MOBxZVNSkq%uw!WPuR6*y3Am=RcPGy8ju!$v?<j9C
zQ$9OkazGc-JH!;{3J){hb$8BxT8XK0zd#*1EfuG(^VJqeZn}W@5uZj(Ha0f*Hz#-X
zAs6JtZ!na@RYsmMZ9-ZtnozFOfA4zJnR%X5QA2;rPRy6z5*IyTXd*m)n@8<QzBZrV
zn#q>P3Ek&8KCC&SL_j#59-!i~M6ju|W)#%~k$=68f6+`%M|(?OpFF1;_1~DkdGD!_
z#>b7ZwcUUMMK(49!$o(|zAA;f?Uh6CB<TZjguvWI+~5+GNpfQ`OI7oRYT$uY&D{8m
zV%UDv{OyH#^+Z&WJ-n3$x-OFR&4s}8aE5$`S((LI?|&>@FcY9j04<WNE=FU()Lpz=
zqpWD*muokTWR0gNx+C^|I^p%J?7;`v(ryc>$j55m#`xre-Sm9p??nP=YFqdQqh}PW
zMWVSi^G|9F{V(UP8Kn*6ifXcq*DJRks1{}quKP#9P?p1}JY0y~X29e{+JONZxn2H4
zj-fH~H#PZ?e(BVypHvEvF2@=n19|5rHJ=3I+pYl!4_fU9R|!{`Q$zP~Xc;Dxh-g>}
z5vP^LWLwS4P9I8dd@>Qj!zRdkC^@PV!#(9hc-c;GC_^`uo(BVd&lGh9wNP=s%4R}6
zH91s9EX{;8(){wVX-FE4O~Ufh$^Yb3G?@D_@8LUWXI~mC5S85$sgwpxJ!s*x<<WR+
z3ST)xWc$xe(mOnb#^xy>h3bvXGXd10{z0Z5NA+)e9}8nmjJ7GS`I!KJouxfDT@V^E
zl#sYj+0Iy7LIAuvc7NNW2y`g>?kl_6@NAg){t=*vD3bG_vxzL1f6R(dYbln#>caDR
zlmk(PI?X|KT!l0W8am{;Rngb_A{=PN{MX3~)pjSS9pM~9FTmH2b^v`V9LNEShI{?l
zCK4+LYPT4sj|who=5kps2dmGqWaLxoq`U!TCm&oqtMG;>$o{5ZN{6toMaB&q^mPK!
zY513d8nlzfcy|2W^Bsc0^Z~Mj*b;g5Luo*Ix&1M68-t2+@4ctCClQ93uku&Wl>11j
zVk=O246U5g8C7Rf2q1|adJ|`sOz;hc+a}4Df6}$(=UTNqiOJ6$hg-HCmKVO}*`q)+
zc~wO280Zmxm1WJDWiq;|*HzTP%7?jVDue@~@!=0E$5LywzCiCS-mSS$n<Zu{b}l9y
zJ5{AF&}utVmT5OrFGk7mqb277XhNxpQ&d4S?2vvOMN(n>)PFjYGbe@p7SVmDDNF5!
zRj&;zaCQB)zU*3dW!t{h<!i8EV+*;Z-?AC{wsURD?X18=>y-?Qe`|Ky|0V#zyjPu7
zG;-WH@E<%iY&cAKOw+D4pzT&|Mf?R}PK8AjLv}qut7d@7PT6j<+QNGD6i2QzN4YFz
zI5_t$IZE=k(j%PWW(nC)IV`rx_#dnlTlbWmfEyVM%YkcKMf*#8Nc!U;zx_uZyEYRV
ze}&i^Q2gu--gj1}dmZ;I1)6-$%S}%Fr}n&U=k&w*NH1_^=S9OQJDiE<sD#jb+VsX8
z?vmpm!R~35^VVDy`M7@b`<kd88LXlenuU?@WIJiReTJUafT4X~!Y9a9hu<H1%jZen
zt=O;<LS}qv$Xs9XC6+bX-Y7NTj9pZ@P<ZVZnyTa1Juc~VwASN@BE9Es;K0?4^2R$4
zpl%f}l;zZ`dq8vcmo%OeCu_=F%dg+y4Ce+xA$P&dsc^=zpRytGm}sR&TurmU5%=cY
zEt*&pxbK+v+r$<7*>JJ%J9&dsog0I98a&!hTpM)^w%=A}Dj5AXlB!o(B`h*PJyt&w
z`Fy@eJ(9nouB<a}2i1ly$;Zpf`V=`IuINl06R(xYTt7N5ojQB@?j>S9JwRirBT>^(
zwBXL2`n@g|<azZWKd<3iyTAeq^&q$5WK~+k>RN@PD9KTIw|QI{O}+9?2M~lk^PWp`
zE&5@7A<mxq;bl*Oi(A0-o(D=U5lJS>d>#;rsNwg<49|Cq4DUs`t3n5Y`xiY26u7>9
zI$!E^nmOc79irb{sTDPUoYC$-2sqY<I@JP;8@nD$sFMZ4krDGKD%g*9qtZR|sHgi0
zTBQYK^sjxny~dd7fe7&C$W|oY0ED-|;E9=8x%a;*|9-*EtVcc7<iZ!rPv`%<xnpfN
z9Aj@e;r}Z_vrqJUrgNd~ivl}r)o;7y2&}UwIX2d#+4@WjlujgEawf~fhyYQ@K;C`6
zqp$=-a%lR9M(P2UMRu|#r%D}mqJ>^SEuwvLATb3VtM7BO)1c|MGhxCE^L({GZ|5Ix
z+ilc*8U$%or9Cz{Fd(OwD!JZxDkh+o@rGh=YsUW-O-|{wS0YM~Z)FqwIAae|6TM))
zs4<JYO?Vtdqt9FxzQI;etvr0wTh2|tGj78|`y#1<JL9|s;@_jJF4>rRsLq6-A9fL!
zsEh`9Zx5vxXS#m9Y5Ld$l4{GmwDmtm4<NQpeeR&&^TJ>HBk_<cgbj;wq(w12Ax<++
zYP8+c?5rFwrpZd8*ddD}ydYRy7WC?oMiY%XjSRv{IGa<?1U44myf(n0u+v7!_^5ra
zlArRx<IARoFVB!pmklhA=GwX=d~n8dp%Y_Yz9m&B))9poNIT>`d3j*0mO)jda#64O
z5;6y^?yb6*^d_<IjO<=pRbS=ymwHtu4~@;HZwtKEg5Zf2vPJbv2kkGOxMU5UjJP7~
zDI|-m8fuQ{k%KTmSk{7O$rtFHCV>Yo;@+Ov3w>ru>o4lgox?zX$fqiJiF11pniENv
zb8GlZMnL}5RKU!NJ(D^VX*yvt$y`0BDOAYzI8VDMzaKR}U6@Gy5=)kdQEcBV#G*+z
z77vK6fK<fbV4BU+z<FWJhbMTq2O+<)@6=5uulM|oHhcW&+G~pTm|ko0BjXs;&5`;L
z<7AJB{<5r-8N6*Xh6=_-@*=<EkhK{}{8XNmoH}AX_~~Q*!y|y@IFV5*Q`_Yiw|u5<
zHJ8CN6AoV>M4Db7Sb1|v-bQdujo(fZ^rl#SU*nX7U&vo%tHQ=<Ttqs+uQs`4k){!E
z7L`*Sy8^Xrpct@Qt-cczm@abas*!>;)V1rb>CX<7!Obc<QIM(XH#)6jDb8Zyu?RbN
zhs8B9OzBm5+<P~y@x|!yal{?zQS*&+MLqYM^oMneIgT$Q1;cG$SgCFAe_2sc8=J!=
z>#Y&zzxw@{-|Qnavbc`?`FwovX_Q;}m;FIy{x!*MxY2KM30YF+M`@U<TOeEo`kaaW
zCvI#F#}9|Uaq!aSbD@C*9_**FW<)n_BCi`6@Xs53a~ykg;i)3{a*A`TaNG}92Jv+I
zM`(@X7>kX(q~VAIyp-Vkn1gWXJT|2@>Jd2#nT7XVt=syTb*1C5hKtJs3$k*wWK;{Q
zGo>gyX296VoycJ&Qe}J%pEsWiNmgT;#lSSiVJxKSun@JG#VBzI3XiMUS^E<{EkBn6
zb*kQXBZ2oIz4ls)UoGVvV2yjfkN7H-Dk(UctFxhN&*R{zIJ+7xby1u+NdquT(ay~a
zUg38h7b(cS-J3R!h~iX=)XXPHn|FIF%jf1U3TBg$;e)O4*WAZ5&w7fi-SLQr1RNEh
z`r|w9w?io%7W#3=MIa{XogDVR&&4up`{T)emoLR{VQoDls9ve5K*0tOGhN<Ci>F2V
zPDtWD49uOR&R$fUc{6iHLp*5NkCUjhIb~M_h1)|eyKV3}9nm`whJ^l5j=f4MP<CZa
z*&HHRvL)Dko+R<|BQTkQe|_ocl*jfNkcfa&A1VyY+XWZGzxdt1%;#Su_7N{@Iw#hW
z`@|40r$N3{uR{53LXd!-7Dw%NoZ=y5A{-r4`UD`uk2o~!&gtAJ2U*Kfs`ha*h{KJJ
zGQ1LyW(PDoiq9T5Kf1rf1^&-|DnQTU=1inkRNQyJs&a)tMt5zFbB|3V`z$^bUD%S_
zx2InJds}1HN%Y3`eHd5wAY%mlZ^+%v6UKquk43Gk9Nw580#<72#+r@_p}>B<@*0^|
zbaR{FnXOKB&$Ew+LecDvCafWY8DF7wsgc92NS#1PanoLocS*>0sq#S6J6y_UV~1fO
z|2L>q=viR(r|I)mNMMs<UWIj;=-c*<L^yO{4Q6R{zYhpXE%p14T-?COl~JoxMNOPN
z{B66zKBeyCpGtz5y=8^R*4tEkJfapRkBalv<K}YiteR|vhWwOXXNsdWMi+<}KA~VM
z6N7Hcq?dTZWF9L|^_zBcOeQy!9=|GW{;<Sh;OOzy*g5sxVeX%L=W465_@;~2dbS;u
zDq^-*cYp`&lr%&q8}w0Q<X<y-O;BC;tl);f%8ZS!t%F!L!N#J&HUfRWj(G+gi#(6i
z+IzHQO`$x9=dYPs9$|FhB6O|>J>u@%mjfXd44_XRnvvJjj2mYs9ndGI(KOHb(Kquz
zs(Js`ee5^<dY!BtZrw#s_^nP;$8?VdM_yEktGz}O^Db_6+J(v=uT6==H!eciHlU;<
z)}6@d=T-CcaE|4u_uO{F9`>f9uK1)yg*8hvO0?)__HZO`qZjKpIixi#{CW~WVQBi)
zmvSxF5n6Yjcyl<5Jf}2Kyp~_B)uN~?K%%~o-{GT!P{B?n7xF&AZ<T78(Zz6OjQ2(D
zUu&uDr3G92%4p2rrIg|Z7L@phlAOLE31D{P;_=&!2i5s5T>&IRb{${>{%gF^+UstX
zb$@zMRZ-MG=nrc((p&}B>L(ClDYLWbyuj90_HMcl9`n`AjopM-qrj~yr_PN%mnU@H
zi-v0hDra0FP~>Hzmdf4(<vVo;kMaEC&f}>b%Zpm=JRrIV1nKg59DC_NBL|mcX@zCq
zEmw%~jjrGp^MopPb>a9;_3M7A^6~N_eW6#ptAOFLlNe3Q6+6pKLS6|^`11vogo;AF
z(c3%B)?J*5@6<&Hg(i7W_d%1_I&A5O9BNMeiZpwR;WDn;UTEzqwMpYZC8k>Kahdka
zsa19AQ_0z|Mm>uQ^JH0;TZ|yu9k9A7W5L}ey0src)ZOB0e<FHz?&;~_{0~}A&GJ~-
zh@HW!9DCfrgPgqGN8%+rjnBRR3erch*8a4UJeU;!6DrN}f<0u^dF^@C7D9h#a_;8E
zchx`mn(2sI)c1XjS}=emOXhS1A2l8F7n!Z=n5c+G9qy<gX}T-z)Fm;onp6Y1KOEjo
z$n?~@5d>5)1PD5Adb4|WOi|TmWSr%O8lrY6w}UFdQ(I>gmO84#n?;HI5-uUHl6Sqs
zL8e8UFFtw^%_h!(JjJ@JW){U*W5GTht~@0(+dP@-7oB;c@qeZIz#Y~Tis!@n9ICW^
zv@WLVM?k#y#tP3Dm0uF83QxrDJa4j{B01zPDDj+jcE2VLTupi9<<$5@j%1T0Jc+90
zgR$;h0oVftqD=-s#I2S_?=V{J!c(A-3Ge;fv2pj^RIC;D+j<NkeQrSl<C0WNHghyJ
zM)FBctG@_ec~6;iBiRmw@&m)+remA#A+gJ>D3*pshb7M^+D1?BOYKJTP-(%#9|@es
zO*8&3GPqZCm$CxGzEW869rZmgIqtQp(xMtOk{jM5n>F1;$U!}_o8l1lIE5<dM36CL
z;Eb;`Y@Er0r~C}LnzbRy40RnzmHG8D@Bk7Haa9Pxi^R|ooK@vPHjK3^p6NoQw70H?
zbh96LI79*qQa_QGG_rJ4AcS5YS%6>;P@)+T=tV9>h{$X?;6F~(S*4$$dQl`ZPJEEQ
z^LeJ!#Fpzu%yH-ipr#>zehIAA%8+b(8@Zu869sBZCBrT~E>_#=P6w)`^6^mp!F9H|
zR7~PJoADASfIdA1=+o}r+Z%){y^9HH??2m<ULhK4Urk9kljVPM9QC!m`^rsUlWCXH
z{s9JRTHn@v$R+B7R-$A46MHP76^Yg+p{p06@=z^+udY5>Nu4Pi_8Y4tnCbg8<3;aU
zJ8Ks;=*Ask<Apn`NO$j&>!YJ%xkAJ&19^Cu;c&g%u2rpaY0^wD28~I4K4%XoR91WS
z*_+RImX2#hZt@&CRTiF)Pi6P!#f>CqEvz3`AHE+?vbKl2m&M5U)ODSzbw2KEVp0fY
zVeL#ipXMpl6C8NB5#f#>J}S95ksWf-GBs>Axna|woN;jVl=-+$1_!sN@Dm7z@hY)C
zDBW!_WIlb@Uo9r4_f-=wjV-U*&tGY7<f9~1gxb=F2nc$r!l(GJxjLnOQ8V!1N%?H>
zV|pqkK!-Y-`)_2xyXrjIce2j)t}VF>Bs))$$(9!Uk12N?9{J~>h~B(z2p_)x{K60q
z;aw3h8Uy)p3puJSVDzTO?~+0FeM;sdl;^Sad}%^;|NPl!l`AwPi~R={lH+;1;Hzui
z#QE`x(>r2Og8@NzI&Qtx`$~hGxYBy_slbxBS&YPW>(n|f^?)W@&1wI>w?UarLCdE^
zaF$3~E^ab&rYvr6We#|Xlhru8dUJACQKj8xsRJuTxh2Oh(a-Uvzq+LPZ2hz}zfs!F
zo}Oiy*@$M_h6O(&zv5)I`ks7(nPI=sYaWcKfW$e9UFzvVxg)W=U*3W*%VyE|DqUAe
zdycwz$Q`8P9J@2<8;f&Ez)Hycld0MtaeXrPS()N@2g;7vyg@G|7zrg`z#B$5hv@~2
z$pzXuZ!d>Q8kh7zjvs{&Ty7c~Q^97GU(pbHs{ySQ)vQB}mm9ZHO0#>1BqEnxUxqyu
zE8;4)T{-f$XZXQ&c`8q7E#Y7DM5Tuw=W50@AoLU_0Tt1J+7G?QV=N@7+u|_(tiC01
zxMRuEl26Y;aYVxCvi>$GkA8;j2y?w0ZT8M;e%tYwn?fAg$l<$SY3>*U(tKnPsDL#k
z(yc(63y`CN_;x^&@#Yl>-s8DUg^$v!b;bl5j357U^BBE*_W(Gk$8GX{?xGKvEaaRi
z8uII7e*WW-##50-e-dq18&aUS&fxKtx%GMG{|-rmmM$nxZsEz~mmfBVyuWHWb5pi0
zUnr2%X85)C0mCoIq@wX*zN_2>=roCsu&XHgj0cx++`r_3k4kS?61aLiTQS&9kFaxT
zwlO~^Rxt>i`L{0f^XJ$~ko|4v&&`@>^rTDj(^PS8opeV>!f0R09_P_N;o24VgsM?f
zC}{!W1i3ZaY9kRv$)kLA#LMwvYM=LEf~*NukP~wL^3*vJpPv?gg<N7#WNa$zpHGQA
z_`_Vi`@9*#RN0u#z80AwJ)A0ER=x+ZF6d?f{O8rZLu5V0Qb$;4k7&fttWei|M2v@e
zSCNP4LI>{f+y2HAwHMe7lI|zJgQ=hYT=C$MLEgFM>e*O-O&b89GLwb^t)9gr^J-l0
z`7`0PBbcdU1bCroM`_V9anBekUyd3^x@`{n^+D^}zF2&@HI<5?Z>ee~JhWz0jme^L
zc^-N1{nONhpj4@HRaJCW@~1$U!lm58QYQF-fL3EoDieqL#<??I@`GqgtkDghm?mJm
zSSg2G^JzrrV*~5qi3YEl)=-#jeb)SR?Use)9cpkC3Z)!1m?SW%ItSvf2Pg*+#Ar-M
z!nnAFS-vT^NM{qO#lt&}xbj?G8S@AZ^UA3#|DG8Ba9^;eC+i7;zgBUsR8OC#(-s3^
z@HCevQ+tsPMHVEpo5ubVD*i`wIQ+Sqp}6bK>VmiAdedv6u>AE9{=$bXKzH&HL#SW*
z%|_qA7kzkt-$*<x?ICxVlXLkOJHpzln+8DHC~=;Nx@PjG7H{1I<z8RNu@1|%D%%br
zAYeLKY@0UyrZXFl^NBrMZun7TzS9;d&FLx|IzoczeS3hn43&BZRA98&K;B-M-}+E_
zRL`O4u15VTgh@+t`*rSRkVHkOdxyCOlHHDwjq^&Nv5d}E*xt|owh+m+#fm<8&_->A
zEZ5dqXGOUHLDMIH+Q3nzi)0^*kn4|te4iR5NE+6e>6Sm|X1J_ye?kRlK(vvl=SX!}
zPNc;2!gV|#^mJwB7LKG<LCsDYZ2_o0ZA`=mhi9y=5=Kw_JDIgcUg>w%hOpqL)3lM5
zU)~yage$3XN=pBa0*gDBCvADj;l(;VTYN%7>qO!FuuV`*pY>SC9}q~i8^vEo$MPsU
zJA0ziDoXzqe6c<F_0b>pCpu*m!wwIIZ5qJ_fr!gPn&D@W7^~GBnH$QK@ebXgOGs4y
zHnq0c?|^PH4hz>um1BWunV#$aUM_+3{c5>HM#eqMxBxBoSfrt;e---^3C$buhKqnM
zAc6$tn3&wd^CEsvOm+up7!)D2?dkEwq5$dhIhI60L>|{)Rgv_noWq*)bIoEa9&RAS
zjr?EyUH0xS;-w_`kbiV1W8aX2?$BABw$e2qbZwIXUOI*~db%;j{)YD?q}boxqf}@s
z3v`(r?SN{^dwVlwTNx#oi*(7Oxzl`vm%!4eAWP2knhQw<4^GeTE^3((HLg^hJ$;a3
zRUj59^i|36nzxSds#CA94h`*xFMQA{t+$IwAsOx3AR_>tROEi^`Q(sLwV1Hy+072G
zjCTv@;0j<(jDq#PAWMh<u4ZTp$GhE^;SVh_gf>)~MQ%6z^f&x^sjSVI!sERGS7aJP
zCWNM2M9lemcJQi~Vvq>s$*|ZI(!(~w%M9q2jBiPp`%Gnt@&Hv+q-P($u{;~g{jy`V
zyID8zCP^q>)J~0A^4=2zTH4Wut>I#A8T(El`}NEnwcI&T|72vUSVm&^8bi~J6$E2c
zbT@hrqP;e5M?_40^=@MT`I5sOc;te<7-)Pq*Ogj6q0LjLb&)?jQ>*4oF{Ej+pM+#D
zm+uL2GoosvyD%`PLcQ!>NV<VMontlu7I(oM9!U@<pQt=t!0`85h-DFeOYS|RA=_2Q
zCLlTW0apwe5*H~*=qbouFxP&!u}CBT$OMpM%rl_xC4TVFW58fEo8$tsMyy+oCF6za
zoJ0~`v5$%LT}@^D1NfwdtVZZ3VRG@4X#;;W)!&blv{KMHw_RPvWZgk%$vaMWW`!xV
zwhW?m&0M9EdYz$X)$Eg|?Z|^yB)gqE_1zMeG>nOi>BlW}RQhISLA|~0T~yra-RLTw
zqKwunfmLigx=b6HTVQ#Hq?^ERlMTJszBqeq(kPhK*B9TlTjhypPAgMrtkYK3i+q%*
z8$e0?2JhtOh>-%eNMSr4M<H&4D>78@2KU2z1k&|XmO;s%#+Pl-uB(buvV(<@2vVay
zMX^c=M}Ck-l@wb1Pj`FP5285yJ^`sW`b=QJ2DHlA0!eAMW!`vQ6}}!^*!g5q(Ra_i
zg%pVzw6Goh@lR{|pJxr6XzqK7e8|KZ<`KUi#m~!==GV3{rdC?=sd>8F1(DC+Aoc3q
zLN8CAvJrM>eKF<sAZHBHe}uo0_wDuL&5n?O+#ZxvQdI&@_rG*{MAIQw@axfO6vcxu
z7_P-(MqQO`X^q9JB&65=%)C1!4C<pb?l(5(rU&sL5y)pg(Sp>yt2)z6xgPEAA3iBM
znG;sX`pIo`LG-Vf($a}o#|sr2JZrBrXi`bD#Kz8$D-2PG7%l;N__#F!nfV8BqW-Hr
zIF+Vk1h=VhU=`V}0bKM1L?R<O7K*sE)fJebLJuvif@n>P6ir{5`c$bDZ%UwhUCvA_
zQhlT-cEdxs;1P&oY=5s^+7saa+s0a%?{-BB>C_t$nfw?Yw2SdJ*MX~$g?Dh852wG7
zPbQ%f=9w!Q<yI$Sm5&O|yZ*=iDKfWYMn&lnHR;oqy2+)!zeqju_lb9MlQ;GU%Cw*g
zLT?{WGxiVwe-Y?j7#ToKt#cGzC0l0HBA{O~H0NR|WO#-?4%97Kc%QZiMhb(^l=8$e
znIUSnKNHROCYnnm;2bc9wexCkKP<ItnWsh=H|tVzRV^ZBBu=pi_ti5BvM6F!OaLF6
z^-)-g=3N~DD6+@BpG`j$T|UP_?ZA*lXKlq4V}iw1*<X(o%M}c=2z~O&l<UAVxdlYv
z76!W@IeB@4jm`N#3QaFCjh<^TJsv$LDNHF{9E|k;WcKh^X_y5o1qJ2TD$~2D$T6;`
z$TUrh7dNO}n}kB4jD^b`eX;%975g*mqZ0d{fRGTl(~0QFv1qFKpQ;d+DVw;Hf@xFm
zW1#d7;Xyu>NQ=bfLe3;?5*b&BDl8xT1x8C%W%cj~*B&*DOp}$oUCnErw-Xx)WOR2X
z_tFO9xC|ANOFd2e>X#v2NnRNq|Fl@QyCb`xOjN6!Ph6c0fVHN!E=@3`AJkRG(U^uN
zSQA=x$mtNEjHFq=IdWd%(De52#05IL7S?@Eq9X!C$;Llm*f^j`hdh5?zWZHpWE6RD
zmp|f<ui*Xu6xW{jcx8nI3CM!|m6XYdz&lA$g{1nVDaIb<|5>$MUd|m79&Um<Mf{t#
z0K{!_^6~kVX*TDM-&Ib3%*NK9BcFJnVol1S|D#Uot<hxAXuS7Qy#A)$Qb%at<rum$
z&|}P?uRqLnZ>aUEvx(+`r3g9=H#S7(zGupqz8V_9UGU#`J+*g>Jk_ICJc@%26>0q_
za$e6-je-`Pnx?+t`Q}k2FHw6{p`#<NkS-U-qoX`ja)s2rp@z#$S_#<~X|oX31bUu(
zmQvx*-gfHVpqSD#*R0^?D0jGvVEp?ok=mrbHq~~#qP!N8##7r5Bn!5K(-Bbh<gX$;
z%!yb~q6pTjOPfJAtmAj#gdsZy=!0(pH!JyvSKkc+%Kn(SBw{=uzPY+(olbk4psf~f
z%uJqe*WcV2xNmsO4Wdlt(@-*Em`|=ISu6ic%uAOt8BeWDwN$xefr4~$(opClgUbPU
zDDv()jYQF$0|xu`W&&|$EXJwl>N0#R>dQPpczav>;q^`~k=Ja`(r(<PVHuv20=nB0
z3<QfIwx7_?<^7hR!WlhDUX6g?!_~Hts^2JEwr8;V2??)SQx?#ghRFQRxN&d(;pt%B
z3Jk|K&-(iqQPn%E5`p1(E%Hqd;ryj&5U^I2&U31M2IC5mFJ;PTV7Xj0c5qOsFXy(>
zLkyN25eYcVjo5s4*3{7O2g@Fd44U;z(_gs2r}!FxWB+xHeKHWWMpK@6eKl^!nE`Sd
zPx-@t1Jm@uxOM2D?r<yow~_;fdhuX-wlQAQA1)J*j&G$o=p^vg2Qo}Yzw%ZTwA>m5
zdZ<)(7^TrlmO;bKpA})WmidQ-<@4UZJ+#IxSqu5QMTF0<o4?J=i}^omiEaUD5J;BA
zV*O1^mk?ZgONcJcu=DoAj|eiH^}b*^xwP0pzp0UOr!{&1mawfUUqdLiF*MmcO>H&^
zM0g#W3gG3tnXdAe8cJdEcQ9b7@P6VSCC@}0ekr&onT#c+L$;+f1m5tMzUZQ}qN)J?
zU}M>*+S*O|UrHDtu-M4(O<3_8EC3|CP(2Ig#NeKH_$E>FTzG(TN5?*Cq|rB%f+V~}
zpwF){<L9T-)&*q6zw3rRwBRc*EMZ`x`!ETB{SZFByd6J3>vnN|al5-vBrUdZXo~oS
zml*XI`o!s>;n5&#lOe6x&-TpZOud&)MVEM*$n8%+Lxmo>ByC(VP`+Fsz>s!N-qlR7
z;}+7%O0oyC{>WzRxkL@YRWa5C<@3X7nyC%?txGq)iGFGOK%`)#HSb8A;nxcy^DJAv
z?xJ#ue@c2rb~<41s*TJ&A8J#8TJ);A<DF~3Xo0k-zj<{=df9ay*;_*#R#d*ST6A^A
z;K#V9Rddr0YwD{>vOd3U%UqW0fEn{-lP0Pe0Z~UYD*~d`TO#joV&SLt1H||kjH#c2
zLvTZkA&-ubRbtPLd?+3WRg#v5=>E_oJojt9@l$-FuY85wEbxyTP(Qx302`)sscM7d
zt6T!P|3l79av6LBtXG+92j8?)a+h?f$PH#tFKzX+<Miyrd@W#V(=!vjUhqxbR69yo
zPc_x#T-y1(XR2)K>gMa2tPO`8RF`XWyNP(4Jy;G(X}~LFC(68TsyY@Kz8@o79}TSa
z5s<X}w!T|_Q%3T_cgd;5^%@lkjCjV<j!sldz{4Gad+Vk7zbihvjkjLh8Ov}=HRbmn
zEweQfn)>?IffBzGu7s>LHM2gVfDwAYLvtmPR*K9l5;d-CIgB|yR0g@=N^pwJ*>bkJ
z0jfDT^Qm2NMNPyEsf&SL?$mQ`h{i>TxAX_L0ydos?ka02W{$~l-fIIf&C;5FG$EyV
zVSrYH>>J%=f&N3vaAwC=2r}1fp6$6L@_6w-nz&<Qnjk0lJ|22IaZwq(QK@ECRaNsR
zAo<|HxE$auCSYMKIuik%snQ))z7jZDsL{XVw<{z{-7NZ%M(=5OBv!M(9b@TI>$JmC
z>*lypQzIT}xZ4tPjYBxrA&+VY$gvTxUG_?UqEP$ajGllEROuD&oBp-M+l`#~M`zbc
z4Olz3^%9-n2wZpJ{G>PEwa*C^P!p5>Kkh1KJOK`GQL>hDj<Z|T-<}}<i<w(FSGDdC
zj&if1ujR<~wi>lMM1~5KEVPu`iFa=@PB5YV2!__|%!h!r4q$hdv%~)=Hqrb4U2O7_
z-5Ne~>fD@3<?4TvKzJ&KJKPYpp_pH{^ZbDHC{2N_G-&G7esg$((xKH>`_v?+f@8k5
zqx5OGJkGZxpV3v0Mb-jE0+C7zfw_hoNM)Jo#R&C7lpWm8^85A_k@{f4eRz&=?u(87
zL5l_NC);NC4xDBepken?L(jH^Hlvml59Vhy$MXk9MO*`2EDs!(*raHP%$Vm=XX8$U
z4JxMPAp_IQfE$U`99u*k&3A^@c;}2Sv%Eh{*)jBy#nnF899j`~KRFZjtWTB`K}lIo
zd)~}F2b<J7ilvj}UW(MurG6Wet>o=?Z3liCgo<@kRMhL*1=<;>agk%g1Np`=%G{Kk
zj0!U^`V#y^---c(@U$HM#H}B|V%B??LjWyPp+0c+M(b3{-T9eSxufy&CK<Kjpq6SE
zUweB@Q5Z~2HeXrIm>AWOhu&UQ5j`FaZsvE~s3!dQEcAH-s*};dRXxsMrV9{x@zm{R
zh~}Ynijk>~e%mYgisRX_(*qj6y7#iuRcuB$r1~1u*?oHz@g;!0bcB6zs2ZfZg{;}j
z_}{8my3M-2=oloy8`dZ7*AW7aXDhfeE&h*d6`SnV{i$nd61^@2@=}8@#VhBrJ{zaJ
zuXaYU>e7j_hd*1a@vEJ3LTBfuw+8bc8>IRn%d#$JBnn)T&L;axIBG9YVNve2^QT%r
zQ7$C$X6XZQss*Vn*-t{Y`B~{rngHc@z@H1M_bV9Cpk~!?N{!kS4i^ZZ8ed36a{#UN
z=LwF3QK0S~DX0n#^qB7hX%f95%pFd3Yn)*U7;4S?TvqRODDy)Vb@|S{Tw7TuWF35k
zPKGmAG3Qp4U1_z*n=yF&&w;9?7N}ZqpZ=q2VLOuTs+rCHTGH>5$^I|^(VjPyqn>&o
zg{eE8mE5VMx-q0M04<~1e4-ES@z=Zn+~!n(-JR~Z;n;juWjQ2EXz=QtnC#E`A+IWZ
z)i->O3c5P$2i<B9MW-({0cSHRheO^;urZ6bfGW+N$nj=+CFQ^LJif+H$Up(+odR4j
zpav3$vsLAh3lcVW#f=9>P?*Nd>{aqZ7Fz14u8+v+e}c(H6os&P(LsMYSn%|E$|rGN
z<_UP3g)~gPeKqS}&o)ty_PbzwmBrH0ny)Zv{;5)GS8k~PY|RgY6s>Amntpdu?FGpX
z?$*qr+UMKEJ;j8}vd^44m}lzOHpxIC?BtpGte+Kn+sjTL$Yy?X)?!=IFN(BH_I!&h
z39S%}<xSNYD=$^#Hl-81SN-KL6dwdJ0nCtvLdV*MGb7-u7LoWQSpM|`qV?WIFj+>I
zZQ9N><dE-%MOdmoxeZt{_qxi+EXw)=p-H1-b$SoA=*_CuCyBgORZoD<e3Ub!`<MBi
z^?Y~X9S0q?tSc3xb9}s*Kjg&NVu@7iuMp*ai`;gXz~29(w&k1++QYAU<g?LANme#a
zEa1l)+2>(;?^UKVLCBN1jPgVM@2{Jv$^~QbL<I(2wxX?|Zj^>$bi%k<R3D$xIIr^n
zS|0Qzm4>TcA3xS`beUp!w){QxJC;8zM<K=yI<;Jwu6LHp85_!TKimRvGA`)=#fpI<
zORh9!hbN-Wkv5;&BJtZE$$+-mQWT*yYV5osm-#Exz4)hdzB{PbJst?vecLvu=z8X8
zGo?emNi<|)ATfD-=hK}k@92<o=r6ye|Bd9u>3=7AasPM8%jUOkVf}%o)J#!!fqkzd
zphTP2s$|{SX~(KzSvV36`CkPu(*FovD98U(@Pfp-KzVI<wh<JyjMjKtzY8nhD&1?3
zi$W&$3&xnqLLj&`Cf&bXcs34&ItR`@N7tUjy>80g=2DZG|1OBAHE3R<<+XpKpkz2d
zUY~N7TB-)0(+{@!c!RD^5B&p;6!ALjlT%F0f1CT??56*9a5IzS7QHU_0KV6C`sBg6
zLRu^1^IuH5J}YKFb`ZJKEdPz-=Aki_ta`Yy0#~}-vfXP5-w<o>=6@4lF|z7*z$>-4
zm98&go@CbFom;3=|8s~za1tFDMO#l8k^g^ouQ`)Z4lObhTx&#qz$YA1xo=5ugXKN&
zx&K?Yshm;WyYB|NP1^8j>`GD4ZjQW<%>h=#P4Yi?*?7@2SS3c6+CbliQuU49@tcU2
zyD!r5c~5}Z@Y=r+ggXdEfFOJ#f2^a)U08Is_0j}!yBaHmBGA(45?Z?ILus)kM`ST+
zB4IKd{!IfvT%1E9tk4-qwlBp^ZdS+QWf=Stx)oP`TKfzn9F5uw-+=MGlJNKkGea*i
z*btN0&Xp0(kSphg*xGS+WKK%_6y^2B@xe?B_zE-Y)$2(>FSTK=P}AU=qScnZYRPq9
z{`9)EDOWs?gq2l?gr%3v<pz8uw?Pxlapl}rAE>8Dgab+G8>|8>X+iAIe*w*87y3F@
z(V)?@3RmgD)*MYD<*`*Sets~~7=nogvNMnEsXZTIH8K((-jGD?fyqJn*0&T0fgt_~
zDkfESjkN^E?*}!li<;ecOeUD>dvCs43ipX~p6<i4ni@lkRG*ovQM64ip?<e52IBNC
z;<(+g+`-P6<8OU31~Sqb2^&o{?c_vem!ps__~`<h(w&XP;stCSa+UYFCekxn40Ct0
z@!izKj4|mcDbh&vKHhz-8K`X1SgV+iA*wmH6dXQkc)I0uplGK7PSVT99e@AXya(!=
z9I`(TZtwc{<(ZWRe8y2uw*WdRQM5vf<?b*U`B-}Ait-PoAg^MqOxfKEuNqGo|Bh;X
z_`R6iK1Dsvog61UB1nf<Vc#va(`)nmlbYq?W2cXGQxA=Fe7Q<l0lql&<e%h=eYqRS
z^5c6wdrM&FdJ#IA1}8&50@@!Z7-R>EJS0rB#6jh`k}uBXR_RC(7y<>qHp}aB2AT_j
z<>|i~j+jg$TOPk`KXqq$)IH)Sz?o64qm_2+7DU4I3)0xWlgG|<wTiv6ZV-}OC02hT
zm&UGcWTfz#E!8)PK%qvy1`81Mycb}rg+roXNU=)Jy{?Y?><wHuMxNyav}m=2VDNid
zP9MC45T|~AfL;J4`7LednBcpC10+k0>DBLLOo_>;K76!HunimMA9k^C2Lm%w*;4XA
z3&vJV2v0XRyq#BiM9!0%T=Ylmt3EL$PI|xlw>)+q7XKWk$%ly_l@fWoCoqicBd#r{
z6=;@fA{UYhrb*krmQq(q!qh5iCy&S_a=BcqiiUYA^C6h^MmB?Uam&toO*);-2r4zi
zBr<W4ED9Ol5dQ4VXrl<stsa+3J~Ef)g|sVJ5hB$kns!t+aj4!0@Ul~(Ad;#Fu1Sjf
zE>W?O(~2djL72>sKnOZr!aa1{+HJQ4g4+lJjL@SYAyEoM`?qMT0x~fjB|F?Z>5zE$
z_m*HPO|5%PKryZM^=mV6V1$<WtQ}VUUaBvxD^+S&hkL~#SL)C`paO7Dmmi%Egc$H>
z7q<PW9yQZjVvb>T=(xA1@MnqV2318f3yu?;g{Y)~s_ZYWF<CL%={LUHaLk{-?yHW<
zqF8=%y{e1YN)YlV7xd?!K9SzGVW}7lo)e44yhMJ~mVrw{Gj5C!_L$p0Pwq{|TzEe2
z4#>i}t3<j2Xv4Pl)|)Ipm8L_2ZCswh%9_8}0kzCmxB$RwW;jd^p=u~sMwV|I&mS=i
z?(C(vB38wvYH_>-buL2AU&KTqp<vg8YY4P+D?M1#3!VE0BHa9BUVRe|E(&fe%{TSb
z{}1KC8y(mr0exYH{+yF<MUv)c#+5$q{NC)PG5vowfE7Muh(IOKz*0!*9ImdM-)$gk
z-ej!eG6$dkHqUj!j_+S=hfVTsc)Ltz>)yQ0+#MZFX_p)O$YLdWMn+J_hi9=`apUl6
zB^MXBxbt9`$Z!-_#VjEClc($4O<>d<%GThEKk`{5AmB4FnAw7u9l$HoTjpw}1@)>b
zQ7_|jKM$MVoAu`U!E%URU=4g0r(q1+kFhWFVBgE#q{2DvvnweJBPZi?jURq#0k)~G
zDT0vgl6fAT$Vbdj-kw^?>jg7}`*T_DP^(PL?y-rmq1(C*Q&E9<rnP7+)YJGn$Hu!P
zR!zP2y{9w<p;690(IdI~-X?Rm`m>>penEp^2Xx-NM{iaL<v@odu0M!fYEo;yht^+G
z7s5KgHOHBP3{;;udkLdBeG-<acta0^A#dW-W@$si?VLh=IVi2R`@S%xPIXend$5=~
zVse6og~f5F@o0l@yTqV5%#t?&VQbrKZDZ5C--1Q+N4-1i7f3N%dmuwNiQW!=l~NYG
zGwt0Ia<ubFed4(GmF}Hpe;-eS(pF@Ae8bI6Q5}CB2mO|4C#Q>ll$@f}o_}bIn(2cK
z<X#JR9d`cK+@#Tl-gMA+lDt-NWPtV;wD;L<YWlo_`w(O_$14>JZ|Y>n)?Dd3t4d3F
zPH|^cYbe8uxRLZ9rZxHJoDXQ#k*$*{wvL-|W@x(u$)zE}U34h?7@0H(;*YxiSHoCq
zX1##X>1dqOIaQ<e0K?6{R9g;K&x5^1>fYTJ?KZe6@$z{I>+<~G#%Q6k%3_ND8E`*`
zib<W<JGY5{TPpF|ZTXYvSt#H!fFDpsI5bnN9Uk<{O82e)TScJyo&rSLagoZ%jBwCW
zXZX_bB-typH=y21yp8{Nk+#nnaR}Hl*jAqud30n~L4aa;`Og@|^3}O;hx;@<^&gRF
zQg==-%7V-8z~ZJgqxecf=wJK!`ipK<PoM4}$my2Kk%_fvT;?gHAC_Wf!u~=^ga2xI
z8!WJO-z=^P;ZTPg<n?%IF;8d7u>;_B=vf8UbC#cEW6yt>!ERLFKcXPrq*Pk>#i3sI
zP5?uUb@AK3QwDPM6obyD+NrZ<c;V5;)7y5BsL02}_mZ5~n;Q*a37Z~hmg)&npY-8s
z>iK$VNI*c3>|Af1?oFx|0JN>zZ`9R2dt1AE*mL}in}=PJU%YYEJ5livA+IN}V~{ie
z7A>A^H^=!|1KGu;(m3PUm!jKB`|;4%lPtF0S+{okA}8b*PTxFc8OxPbW#}oIYQSz<
z&x5Cs*UN2IOkZ>PG@<p-$~`Gr6Iojshg<5l451!am8|6LGR1-QeT@y9Q3XsHgH`!6
z1D+I_R5&30(Trp?sVb>{2Wtl>r;D`(xw$$a6qCb(cXR?&CnE`2@WSFAS;@^KKP#_t
z1!m6e))6obpAs$WleruxP!Ej#t`5*dPS(UFqMw_DqqaGZQc#q6Bx=SaYhzSaqWz<)
z;_yd66#MNQo-2IWYKJEkoVe8}s_Cx2-LUFr0K~T4C9$3Mj7N%_^!Z5dYWm%e9ZSb{
zD;v<y2-ii^cAnc~aT7har<=ayp7xsF0^x?+<Z5TTkKf2H6M|$+5JT=+z0y&Xncpfm
zEREz2{4lA{lL6)8<y+SntrqXVz%ozmw<@R9JDpEIEp_``BU~RU-blIoCVV4x03Qao
z=bYvZlOKB}tU)elZli5~)I^So4G2EP`k6B&|HJsuGjh813*rQ@;Fi;4lE2h`|1xJ<
zi^7SJ6G;xW%}p^!r@(#=`f|DbCG@v=Nt^HcIz#-+_O|*?K6h`G>mfP8*MqA>-NK_n
zS=*?sO;ytMjv{MX*NEn3;!#Gz1A=y?H3#05U7Fo-BipZ{@;VAvu^v_3;vzbWcCVTf
zSZ=*Z6n~^SP2u|eiyTevM#VE}kagd~jF=zlP{@}m7pEn*k-lp(K(uE1U_W1>a@}MO
zsB&EUJTo&LnzFow*Q?Ew>==C@`505FeY@|7`qA7I&L=r4sBi^KO+A#ZM*-+R;|`D@
zIO?b3#+9n=m`tf+M$YuU$p%!-o?C6lWW%`O*SEY_Xm&^w0|9|yR}JwUb;i#Jg^n$k
z=&xFA`1+wr)yfO*7qpLAVYr3z=^uSfgnZM1=Owc`pWk8_%5%Ck=F>hW8K^1ZHpW%B
zPZ#{lyVj#GXSpfgvD21y#?DlaNGn;*c8!;DG_EePZ;(0S<`sW&qp$BHY~eN?2YotV
zG7^-Zi(Pf=z{n3vHPRXTS;POB85ZmD+m^mU+B5<dFc=n#_fHAG61|DDFQvAUk(I+K
zcQYa8nEZqxVKJGl2G{Wp+d^E+ZCUxPx0w+MHh%}lB=zdD!diq@Sxi2sl+DMB#P2^m
z+N#9rgO(eoRJeCA<)@YxKkFO}`+P|+6E^}PJ^rZjQ^<nuq<q<f?O3GMK@(cOcF_9G
zLBIM=62N&mxRzNHt4-Zsg9vovRe|mCK~X76kVL|oX0>rUy?2F)Y$^V&TRbw~1me2f
ze#~W|SmjzWQ^B^Bl>Fd@-q+4&7BVQc=@ikJeG91{=$KJQ{_57wd29ggfJ#M4NQ?tY
z9pC`eewuEWcE4iKk6h^T{zgh@7JT`PLk*EwZcO%H<KpC6lJ@gB>3YciM`E4DIb4ZU
zml?uJA-h0kRq~%&Fz}ua|0|i3>%ZHP|7)_x|7b{#y*B0bUwp<Kshz@-OuvP#Ycbgf
z<bJzfWG_1-o5Q5y2o@SSP_#`I^ZJq#hjt$Kdjs@4PTm#_ozBoK%I+k;*HRbuJlAs#
zs&0^`(LE*pyFHGrGhZ0zb8G(m(0jC$<Qb=vF5>0koeb*iJddK6aLV?C(u=t*?{kUM
zb*7;ssnH$e;5+1I9`$LUkbZ^8pbLd4M;-opVp%FwtGX9rkBW5`bKP_~79Ta2?Y$ZQ
zbSPZ**SyGEp@H-fBhe1pv*k03NaRtJ;v(f9e=+nyZ}q-?ifSFzavdGzzcM+S^2gl^
zi;7II?udx14N-@58L>Cu&&Bi}Vu4M4`+U>>qOg@IAtYx-#m(~%xp%=aLwLIi+D1a5
z(BxG)>vXb&!<vjbhL7jzmwCtce_i*X0+aIa|5w_XM??L-eOx8^N{y5dk)nkL&4>(*
zvSi6_D2=6zrLynBjF5;SitI}p*+U3f%bI=PRhD5aW1F!K&pr5lf4}oQ=Q+>soag?}
zoX?r_88i3wx$f(FU$6I<t7y<#{N*R!f>Smg^N!Igf9H%7t081iz*O^%6-&VRdGaf{
zar0yq3us1$>yK>lP<`9nWYUFx2IGttqnMg;8H%WDS}8rT=7}BpgzC#t&(Y-ybWo|<
z&Z$txp5V^}C+B9&7xRLS#E;7&O(@qI3)A?OMRRGbrWX}KY&*XnLD?(JHRYM$paOB$
zg0_5}+Lgn)zZRA_&RHGh&by<5x#IlW;E_Sm&ob>>!lZ~@5VEGOk5YN@Am#7ge{m_w
zS~4})Ss=~orD8cM_Lea#_0(%zYJnQjWV@GhDRWt9m|#l5iFZau)utB;+(vdQks$WM
zsYy$5#c`4Ncc-UZdp%=2NxKqsM5r5s7EL}|Y<16kyZwh`AenP&$ta8njL`O&Omy(W
z_f3y?0ued^wG&d<SA&oA-h%~fxfS!r7JSGs<yh<$xzK_W7N><{Ig91=)jUn9{Yx=c
z_6aN1?&=S-cDlA&VXyJt5H$R@)U{_<L`?@Ieko!bnK;gJoEB09y{7=kk)O%XOX#cy
zJpmY}ewa%d-nA>U$-La@oj^2mQLO!PNAP<R@$R%V&|VqgDNUn+7Prm2UiY?Sj_k0J
ziE#K`hZgmct4X3<c^jJ9Bj-clJxl6-fR{>>&=l=NpR#ANuy2jUiu~~3b1Wv^JK=|a
z?ytWfwBXYs?kN~sfa)V?aIP?s$67_|)j@jBHR~i+ITM*P%q$;+kez&-DK0#D?mZ?1
zS8TsLv?J^Ln!t_;N+b9azi|L&CUJpSsCw!Q;q49x&7^_L)|?ju%Y#hV$>u@i+=HCs
zlnL=#8g2h+$N2kB^jceu)m&FP3|vV?Da4iKn2+-Nea+<)uRj}havc?d{p^FI{pV-i
zE=!Qm4t*D{N3*GsOO}#|g+>au?>%~yii?c?cbZwv9?gt)&NO!L&W1Cuk0%62L0}3l
z5Jb$5J0Rj=4(wt*^@>WNOLdO`Ne&eiMdO4vs{bA((VuOgQTml=x?S1|Kd|!z0bw<K
zSD_AdcSuxYzeku=-gYn!>&#|n_gh1n-veNXUCF)HA6n59(Cc^KEOISA=>}|nQ_Xin
zBGz|O`eKWHSffI#=jSn6mCeqf$ekCon6K$CF#C`N3Sd<Q*$ZRXXmNdWNe>1#8P5jK
z^)l(rT%dEgKCpNet7#_i<n2#}ez}JsE`RRZ{)jrA`QC&>j{LHkH}Dcwy0c`T#)Z=u
znNz@bY3z1*7`3$SOZ#axHsTPAY^BX7J>A6EV>IQTGH+^|Iz7AwZ_|>LTGjZOpO{eE
z5{j7n@w*u*{($>+o7PYP!j*5EuD_G=<A-elmMyR8$Sse>3ht#S#WoXFjI~-hbfY(A
z^v#ypx@7BY72uzOl{?`p;!c0_+^S||>Fmu<LYDM<@y(JJ-<teY*AFGgYL>q2+UWY2
zt4txM2F>2roaNPKr);3L3|WD{8ng4(EezAt)AFMjU+Sa&7%1St&&#5<^_L#RL(`}`
zdSd78gT(+F+oY7#Wln#}T=Tw64Xx=ByO>K^c}E<QOfJ4?CeR8rgE!#!yN?0MVA}gO
zMsd`T|A&`0&KF2JysFYk@TuO0%%!B4kMss;0%HN*yi042YSj;AzPES>?h4LmagAc!
zPC78(BPXL~oXfi-WpXNtuDe*%xiM*$uTuIlHHfH!wV%t5gsrzDfLZJaP#8y?X_t8x
zmCdRv(DmsuZ^!J%$3K-LGKI9vJh;uiU+X65RQl5E*J{(#Q!prgITPt~in*M6+d~F4
z*~a}6IJdTU^_8I*L^GJCIqDq8P;XGw9sjK*)Cx|q=SKTETeZ7j9R`3lYWh_j@q@|6
zW$oPlmNCa9lRYUBT|G-(;pT*p$hnxEh~};FPm)xWpoTV|sL~gQoq}(1aW#!q8HLd#
zRO;^&Lh;Kgm5rS=6WKGZSyet_8GP>6(Vf-=7b|lH!O;SODG$<7@Y+sM;ZvQmIL*+t
z2#=vDjtXomUam*6^~#GP^g=)dRJ0cY@2=kqcbsy+S@(-7R{7C!o=omZW&;xjF3P;Y
zY^e&s7e|BKC3V2`JyATwR&VG9Cey~cAf7850~g4Ldf)S?$TxUAQ50ffg&HCLiMTs!
z;b4bq+>5qByVk1v9HZ{Ia2{OZIaO-g>R)!QRCLZO()s{F^9~6PP#x*Hk8Vd`x5DkS
zLnY-KFIx_u<Nw~XY$tw>Me}A)k%O)^1WfE%9Abby%RoLXn39<Lt#Q+4ERup~Jt6ht
z#1co8sS?_-b!If97(<&<=%0P)GduW|H@2-HCr){wzE(Q+@#q)}5&zb~e582_s<%;u
zn?Oll;{w8tW?;R!D&-xpXodsaXFopgpvLFt^E#$<<@NvUx=I{uYB1+F%Ib^$mIu3b
zcu2VIPvw6;H!xWc>hZX^_1>%td+;D(^s4XOVybDZkpXHE_{$)N{p5%DVin?n)1i{C
z?c;3*yC9IW7;|L*KnV-+v0t=O=;fyg5g9`b;BYk+-LQXlJsP?I0+6jVoCXGVZ{=y#
z_XAR2?Scr|?;XW9d64s|-xCgomECh*50m~FQ+hog`T{F6T^XON-Zj)e*Pa#YG;TfH
z((t8sz;!A%-}syDqFp<IwPhkKV*Ty=def0J#NT<>J?dsGHXTL6U?Gl^Pt+Zse7eN8
ze>X{gwxb+&`^>(`$niw;LT9zTXfLSh<<0u^T<+=avyi6ikeNT>Lj>N6*}{Hm6LLtY
zuCm7<XsB(B%Od{Hjuaeds;tT_G3z2N_Gz{Q58*@}pX^kD;VeUtEUl_L$BZ*PMU)!x
zlQpc<d#3$n{Mq{(%ff*TgxeXD0!yCPt|fmBQ=JkLftpy8P}~1zkTg~%ka!`_b_WAv
z_=Y^hIPDK88qwJ-&sp}y5|-r*$%IRZC4{o`BuBYwnvKQoUg4+)z(nP8NJVy5?sQjm
z&cYZjamTO0(B?cW@Cq5}uAiw5j#cl9+8MP?jW4}VjN#;|2nB;cX(}vJcOv`CR8SG9
z_qm>`g^_7c38D!VBto)=#E?SE6k-N^y09TW$hfX#xdr$n-~`e{US(=yQ<ac&Wf=F+
zIExY&BWm2xR*}Qf=2x;*s%;iw3id7sL7!M)cCTuP(Pg?U`J;>m@cis5dTX-R-=M3f
zQ!1$NH1nK|Q=z$Q606E~<vCvU#Xl1K3mnd4!)E-tB9|XjRM{t7m_pNdJFT2l!L7zq
zHR84>mx|tc(x6GZTQ%pk6-bP@w3CIU|1C4J`a3h?nDOVFZu|%p(Y7c`%WG(K`GoAO
z_N7zwXqQ=v|I=%0)QFUE#&oYm4}mY?2{2Hj86A?}YQyA#9g=C4)wzTm{dq^Zpj|z_
zpaaO#rVhj)?hnh8u71obv2$g-VmXoo!78$@_&z(-3>q#LT!^cM1%s)GL>aR|9n-<D
zq(flu=Jo3gu*y|)Z#3y7|9FA}To|py#6GGzF?LBh`dC<k*e?2&mhm*+5V~^H`!(45
zp*(_w_O1PKT*cJ?-}F%cliL50$H2yOnuRALJ<k7e5emn#nuYxD<A0L7nn-{t+mls7
z_rs2(fz`~DNS5(E`PNxM6;3tH&sKe~(&ralR|Xv+7cO43ivvT4AYfg%7|MJzZ$UK1
zedG)RLOE;FD0WheS5WeV>}RPsgREhH;8U-zCk@1LFEa6;XDy|jx6inr`==_iRKMZ9
z(=W`hK-)A@-lv#6eB7R&j^v&R{^Xjrl?8fs_^z6DxyMwzWug=+QI{_pnNGHTTq>QD
zOzUrTpuAa``A*E->b;n<-WoaiJ+!|iqei+WnF-$UYSPzEs)l(W-2d77A#Q>~$nDwm
z*9dboDCV>it_7Z)O1Izo7(VAg;LE=Z?IV89*9eML)dY0atjKT9t^kJC<l^Hac}S{V
zGTlA};NX9*no(Y8c<$f9bKVYW16AXP1{Lb6s=q*?(A|1Mo63Ec)?K3&$wZcTXXt-R
znH@a(Sj~fRYhO`7<QWqgJ9*)#<Ksuk62Ddw9#!=oww^58q%TGY+O;z>G-6}l7Yi3@
z-npqpcx&|QFXv;%3v$vQh10kOJW$aV!LT`N&LO*2b^>A9uc-6%v!k*zAL4iqXrz+i
zHdsAtL!0<6f*Wsw4%W?Rzt1i7b@QfML##=6_uamQ6`h8hl??s)Rjuc~q7s*&+Y@m~
zH)YR|_B*8e7m|<%wx7}`>K0Hq=PtVdcY)OXJR4Uhe41<Cr0K9uO3zmu__{Le!8v(?
zZVf+{_o_t|Sz=(y8UgG+p?I28&D07|_q|R0AkqgYRpOIs#d{T?<=lH8hiiYyndMtW
zf&x&8Uey7PMQa5)-M`LK<pS0OwRE+E8y2q&8Ko5r{%Ccb!AE<C7LU#fvYy~*DG9Uk
zyO-TBX4Y<j<`v99?xZ`vI`-A(Ievg3=Iy5BS~8GPU~=OnA2!zhw@u`Y+90Z<szSc;
zop=2t`!5=PRnxbZoQ#uGUOSrC;vP(QzX%Lu8vPT^)Iy%_ITn12tZm*-m1YEUcO&_h
zJ@ddz$YiM4+5N~dEt@e?Wgwf7-3WGN>T2I@2|V<YTxj^Q&%HmD8LB8qBc!hQO$(M?
zFV`@+(g3B2>U^jKg>srYm;_hq{(LPPcZw8GRUJCyc(;$kNHkZXIkz4w`g}sacHA9@
z7mQf8cKIZ3VS%5SvA!F9x;EF+IG#|=csljQwZy#Fb1@D#VN%haz9MoxpG2F;d6?%Z
zZuJT;4C3k(n2bFas(TEK9FI8Vp6fdZMCNy=0<HduleB@2F&~6aTaE*2Rp@CYjw5}d
z^NpMpDnIFy`1C8CE06fse-)s?s7G8N&9QvBusFX@8Yy&N3o9BTlnSw_jVfzG<_|s8
zf$7Z_sA|+SivQu{TD!cAc0?CFE^o-k3Ucc`h4<h?1g0B92K+M67UI_ZA4atJirp68
zfn${_PIwQbC!O~m_47JZjhJiHYtvk4Av8m>Fk|squj-FUs<<mEJm}$rj0+s$&;AN3
zv3(js0A@7M&wZ*&v$RFP_d#i4!@&B?j9ly>{M>B4otVB^A}UEgkmEQHKW}2`w^E3n
zapu-kF(4!?C7kZ-#Hg}7NK862<rt0)?&CONk%-!8x!ytVh&-5%ea{ayX>L?U9ERQW
zUaERislE_x`FWHArxn-(7VD*Y-!?{9hV%fl^EL62N_F+`y)b2=`WYis)Wmw9+2Ybo
zAR};6y1^$gcfrUobMAX-z{PThgkb2<L1;=c)WC6VhGP<(<0SpsPBWi<=uwYq2*Nyz
zSPs@dEoihv(bTdePD#y0b<A{ssX%V6V!n~P(fTr$iqCUC9(KBh2lii!Q*#>D)rOYo
z3vDH&$*c0H8B@lA%zDP*?dl|>QK$%nO$`j&L%AKXpB|p4JtMWs^npzj^hh)V!ekg!
zRCYPZ@?SLD8KgX)o*92lk2t(xa1b14&)!P|uT?R*1xy42B?VZ}aJ<jnXsPVE%A+YN
zU^?Sp)1{zV_m2_TKcK_iIW^iv=kioi;)0t9OPmlNS__AK3cNZqWM6yQ4fMHKf~xUm
zTUdZmEOOYgwpWoNFZ)7}0V^Y3#sH0YY}^KDJ9k<sE1Mg#^73o<w+H@&yAU7YMnMg7
z4F-q5A6XzB1{eBMZG*UIMlZDW_cQ5#O8t*%X#rjCKNqoGl<^s%3YT$tQH5iArqvQm
zd9xiJ5AdP~#;`0~tQg-Q6#3e!uRbLVd`gw}5pU8TSN1W;&68d!0fF2=R&^h<y1?ss
zd}K4(ow~-svmKAxry|b4vaZK?Ak_k<YKw*AR=CDrAaP48_KShT;HIlJ_Q%`OdD(0p
z5j8Gvk)fAAOyhj|d-H8JGOEvTp89Q|M?5}~dywjG_-YK>EwP;?ob7YTF`{1Y<%)ze
zCZK4`@U{4|1UBusIsVPJ<`3QVg^o=|)<v`6Qx%T5i+L%O%`-i?k*%ybuqCtZ>e@~s
z&)^8P+b)y2n^HH#xWG*_O~;n|v;^0(+>Q;tR2zwvLvStYc+PQ!(3zi<alt)N^%An!
z_BHEXf*Q6Ii;&{tb&DNXx5>5RtIyXDjBRd=Lbk+_D|s>!E07~MilNi<>?7K<oBMDE
zTWsj3Zw4(q(8C)n$J(s(%Xplx`SbONe9QVZwte2~&KQ}%;W4-+!N2B;E81-CK}&DD
zY!-EXFFzn}1Jv02bi7z_wVUG8uKZ`#M%2?}c&G5cYg3%+V50P73;MEfFAfylRf?qN
zch1a7cYJR{onWfFVDJ&;thi0=C?q=2ZGLFP`gvbCFB$Uk0!5;(n3c_wnuACfsf_%o
zi$#{!w-MygsTA;QQ)uG-!OO)NZTrhnfKtw9<dvdLoegzgb$wcQg!Z)-c)0LSzgnG5
zRJ>!ixKjQ?CIG8I<x`G4xCnb1>N)yc1Y^;_G*i2z_RRdHhh5lDq`bTsDeH%*o{_(M
zp-3lx>zWGlcHim{m9RP$w}o3E(P;?+ZDgI&`CDauxiwF^Mt^_!Z8rX?!|MtDtu4k#
zj`@|L<eKpUCRM`h<V78G-b`H7VE4z@v^V}D%3w#Vt%%&tjOb#=iJ?auYfLyIwwu?b
z#s!SMq`+J!gA~dX{EJ_D1^NfSH5{pSo%T+gf+k<VuWe=K%(|8_Z?2Xn(>yp=*Q8b#
zdtc_ps;QY{;FNsIwj(t-7T@*eN`E=V=5T{r^5dbzZ4S6`_cW~G?07B&Z2l9R4V#Au
z#CfTO@`L06swR~$jISQz^_{y$e3}%_PAWhBYh>S9jekR+q@}0ZPj^F0!8Qvop*hEg
zDgAJ3DHj2MLMY`>b%5pGEmea}_1}mP{~Egkp(7mDTQqvK2JHKAUP}3;-3SmmM^dhz
z8!E9F_8?uS+2OhC`m_*soOhz5pFFvD4&3sw#o9^0U*X{5g1=c?@dL9B4QqwfbHEW>
zURRe*#bs_Vb*sDa7r@H41LJtwV(Otiy8+I0Gz22E$pX9(I?{I(I)KBE=Lrq7bX6i+
zfLO#WqqY+~4r=g-t=DVdSYLI5DQ+Ddom&;VQ3X}k4IFIIg*Kckey675z(?g+nHh9!
zx!yRxTezzX!-rhm7sBr(FP%$6qYYzM3`fm*>KE&<(#)PaH}f#(m3|LDjt15E{NOtS
zW(_Eyd(hsm6nU{?kA^ia&4XmJYL#SC9GUX%n?d>Q*?8CCHj*kVvmi7hV!R`9OAJuq
z$*drLemrX&z*H2aB+%gy6wj@AzE+dDwxlye_k$DzkL82txHz%r8TGAK>nHeS+UZue
Y4<H!%nh<C6xaq)BR#2DElD+TqUv3n-ZvX%Q

literal 34379
zcma%j2Q-}D*KUxIh$s;)YDfrzAlhIM1QES=qDJqdi-;C2h~9#T-g|Fh)X@z_i#8a2
zj5dZl$?x~w`~TK=*IoBr%d%$H>wWh*XP<qZ{p@FpP*s+DK=_#O)~#C)6y#;pZ{5NZ
zy>$zx^DaL2n~)991?(>zH+8w!x5^=O+t?4ct)-NtZr!Siy?<qP2mAS+v%H?$ty{!B
ze|~VlPK6fOzgtm|k<#=s-ouc%YeF;GE(1bdvVKpYehGLeU!N%X@*+=tFfN<JapFb8
zWWUe%sIt_0Haou2@<Gd`<|!qsR_#{f9^E+Dj_;z|<RpzphsQ?Yijq$q9QAnaUS;^!
zJFxf9wcI>iHTD717XbQ}bB$+uD<7keOioS@GW?5`=`%UB65qbox(sNIDXJOGZW|?g
z4KG**`sxS>3M%*f4yASMl#{qrTku+o-c&a-Dr+DmBO4jvYFPMWIh3?rcYFvDJxB>G
zH*A`?nzTwLCrf<m;81q`4VJH%e8Q$!A6Venyv>R!a#d1MS(~r3+dS?fU`#<M({w@7
z1nh>>uPUymJG#LV*Dh{)4UU;hZ)N^mwO;ZopwnGFw~M3LKzsavgN~c_rJcK;g7&i?
z=|w%69uelWw=XTo|Gin0_~*}`&Rb(ot}dY+%9bs~&{91l*T9zFwxUV*TC9Ylrx^?L
zpNoU7M7yjT4m=a#A3|OtD$<Q$NduyQ2@fu6qMgO?zt`Yoa>tdW-#QDUl$I7nk^-yT
z(zqE^;Ge$-A)pmt@w0{CjiF@o)Tl;QJTmNTU@xstO6h{Bd4bvv%kBP`zRT#P(!6q`
zfCK5P#U`PnKn&l9pP#MV%u#$N*UN(44UUQ2PyRkJEs*c6fr<)A(tsGC<_@648!0ZM
zZ1QV+=wK&)t_}TLAj20S-uC97IeBSuOAwh!-<CBw)xx-nu}dXC@$<ykik%NUXf!WN
zY|>LRvMdL^DhqCdE3Q@i4s7={uJ~&m8COPbLDhA4pTK!&2M&otot2M6dw!qcO#_U`
z&4})1gOgefhve_AYTP63l&#KJjmGKQ=Mq=JO)5{m5PSYYGaC26ZOgp9fhNA><x198
zfmX=5(SVr@DA-szLpZ0w;*2Wrh-!1y(%G5x=6d<Y_g#tSRoKlT;~~#=Z^ugs-vJMX
zza!Sy_4mKIlcU<tzY-@2kCS8IJ!Ais@hLN~{e)PX+a$Cvb}4+6ma+G|w*i%Oh1t>R
z=uUTPk6^@X$!-4nnSTrqyoR4&pLJwIO$q-_i@U$WP1~~c(}$^KhqFPDAUuL$e?r~@
zQ+UtzhbZON2>J&?J-ThUYaK1c4Ufvp${qwB5(IwL@eKRB+#Io@E2)a#SvDW-hG(-a
z|LSPZqs&Wi%IP$=&)V79;cL#jch>Ce8H8Nj{mBZ3q2EFU+0bIg1v<$>_u6;OEg91@
zVBX3ir_(wny-Grh-#C&zd`<MKr#HkxyBPk=D3>MVqcwL>%yYnOoLRm}`?;X<Q|{j<
z2j!~=CcbzTMgasj$Zm=@IkTrs7b8vq!7#@brDTgU#+$XkU%z|8M)sWokJ$qGSU$QW
zq(4OuG8@6{AxOVf^6bu<QD8~KkG;7Xw(048tkdS}u?7v@=V|@wqP)$`CKVO6&1LBt
zb=yYJ+K4Zr#7M`@jlZw2PaPhA`FG?t``CpgzOf>_*@nAhcq5H=F-O8#5=i_k5rLpA
z@`~KA4HiIT>Szj0bQoiRFvYv!H@I}7&oBFg+Jic7&>cb&)+~!_8G1D7NHJK06L_x1
zdSq1jY{4yd?hV^L_jc@Pb_60b<Em<2xkl9(L7LmodwJ446gJ@v9T*3WHI~Ry7|q{Z
zkemOex%^JB6cG_oiXOd!p}ZdN=0dbX`EF^%i{56;DGbHtG%9|Uk*XDE`o8|fS6JZn
z=*^scIvs-IrHF#5`^E9b6l&c~X~Of2_rjv#pLLDqAG=sR-LpEYYq~9VK_Ch(|J~3*
zhZk_c{1Y6I2K^MN;O}fE=(rFL&ki)Mz!?=oMqOLP-LF^B;l0Oa#e(zs_QM*>pz10-
zs)1&CtIg5t-O*u>bfU_`HO8C9?;ywB?|mg`x<4yCuD(j_Ztr%_>zL3pDsg(Y$&n@i
zU1CyPa4n=hqyqzn)Q5UBqU#NuM>hdtr-3)P+J;(EL2aYxgKhptZ*U2`D|+`IdLqgi
zcDN|-Iqo`|JT#R*eMSYpb&G(6VJiQ^#gjLI_65!t_sj%|Jy+k4pE}Sj9X*gtQH>1<
z$g^6+ee0{YF}&&Tu#+BoCtWXJH&l$?b+`BItN}UcCa)LRf@A0>CwlD!E0l~S4{yZo
z`Vv)bOb;FI-M~BgW}Q~ghxZ<w!)}&G59QIGSAj7YyxbdP?b7}8hO+=1lePw>f5XVg
zQydj`c)#DtxLjnQHCPwTd$rPQvJx#+vBFlB?6Nm6aMeMAp=LCyQ$LXUyE(sQtK$Re
zTZ1#x?X=DI<a7`ME4v7)qlEE<^J^73XW`5HMA?_tzpl3ht`<iF^Us+6#)#&C<NdyW
zf}SS#=2Ud_KMu=lUMc<esT2`i#D8X<OzSDW=-+QN<EVH4Mq)MD_y6-Ix2(*a9ox2l
zjuy@9w6wI8xqm!w@R#Yoao}Mv{oi*N%M*G2eO)0l@9aM}ebM}6T0mpseXJn1t=m3P
zDrBjO#tcARDsm(wE+|le=o%xS4g_FtZ0UHh`;UbiKV(ufp-0^&``~NL%(0Mpvv3LT
z)yQ>++6~)3fu9k%5Us?=3RpuXs^Dog3nz}mN!&c!@8mjPU1B>z-BBo$&-6@hRaXTJ
zxgF?O4QT!y@c4V}TvITicIisze%8<K&<b}m%uz=zAFu<ze&_hrz~L3BwUl3a`GQfw
z2uKB~@6Y{Ir1|xk!)0=3U^3B^$!Z9yBRe0F1^|be80=ji@T|oIrna;GHHm`+ITk&#
zpEVPu;*{AvV6uJ7Y8NUj;NYKOl4`Vbs`xUoSf_5AxNt@G)AzRXRjvk8>9VD7QkiSu
z=7db!vmxEs2Y%UqXS1+$*iERuw{Yw%@}H@s8!@ls4;m;ksNCZRJe#=sVDI71)&kT_
zHwM+Rmz)6m+B#xIjV11hO3D6R&J8n$rMW7C$MUOzS9|wWX-kh)@Cr&ZjrtA|$yBx<
zadpz^4yY`B=rw4s`xmSasDh}jPXh~CBL2LsFhg^1w#vM@xmmv=z7>j0l(_JJcRdYK
zjX!$$*BYBH0RaK7UeG_wY{PD9^{)#M^Z)BiRsSz%`v38`A9`#QZAYh+3zg++6=W0#
znENiRXqehR2l=Z&3-$4gt{D0)!*)NtWKxQQpXrY8JO4V){r5Ab1)C6M{;^cA-!w+A
zHCuoBGQ36=3wR;&rJFzhvEL>@zOv_E<Nwn~bt}p5nln9=`eo=dp6Isl=~g#hwMwG#
zs7^b$2&3*$m1I2q{k0uu)|AOG>K|Wv-7hiwVYfRWmRfj*{Pjy}%^@IBAF3X~8j-{B
zA+l~)<3ZYt!Jiqec4)cbUFcA%u%C@lwGkEEnjUO;a3(?7eL8ig1)6CA!|dEdsujVw
zz+$0bI>nuX{@gf3nxf^Co#!NXJk1qXuV^ZqyW=eH5xA$OTiCarx-g)frr=C|TKMxV
z1f}nyEfS`#LpD_CJS;6tO6}hXFGR{aQ9aH?*qRjakTS^EjRT6wjM`3{O8rZbg`VBx
z%5ElDm(_pHrjpsWSvHff8(L=Y@kk@(74-R}g4o%V+s@6#&sk5C&WK=@-$eyet}+<<
zxjJ1uas9i~4a))Oh9oXzjJNibQ*X;bdn9KChOp87;Z5y(q4uLK9cRQ88BzAQD0|Rh
zgKFTbaQ{Gxo-dHF%DwC?@POijM!Pf0R@5iIB>!f$o1Tgy|2On#UGP$J6jS3tg|pXr
zGBr>v!~g^}KZ$T!;ZZ51f4twle|bAbnDbQ;666Rzzyz=XM9X>|lc!Kkv*hP}H%Cz6
zS19(Yu&~FZzSmE=x6Px*oz@V6-puA0+EK&a7}L8#3be5cA7>=yKY?P1)}rPS>&P&d
z^U4<*=Tmv2l~;!~UfT0>Me}ocFol}trfq&*&z`rfplb@F*D^A%2r6`PJVCb_GJuh&
zAeGhb$eWMQ@_wgU#;*OAgT6)3a?s9XhpJ_D%{Nf7e@&UF2t*ByZ|v7Z2$S|bT4{5I
zw7AHjK3sK+$!F(X3W}YtI6?&r7CfA08M>DU4z$3~)o3b{K17juhC}6Bu4)G=L34`7
z`nv#~-!Uz;ho_>(4g&?i^d+c^Qk_%l-4Y)=7=2xK&pyx8$_bBgPvVQc;e#|sHN-x`
zc}di|#kzh7ZM^(`F)XDWdJJ0MN2Tz=Dxbii<E`b3XK5P;=Vz;Ni@k;#<^CbN2Oc9a
zNQ<ks5zRDov-^S{awNpkb2S)EM)>BV9KO4i%<Yvk9H16MgnQoNOVx&fg_ZB8AIjCy
z@-x4hV(HR<jpY<JB^TH*zV;t~u{g=sQiYPW<SDYl&EweNjg5#gEv>&(R&*8_Z<}6o
zlUWC(mx#TG5^>R{NX>pQCA8(I#8k>Jsx4TM<yQI-3-oZ=jwZ=FDN$b=Hr_u1vrU^X
zV_GUte@S5sFp)MeBQL0+2zYZ+uGCG8%{xSaj&UsYQ$ftid)VU6(L_D5141Rg`YwX6
ze#4x0-?1f}WwU8gkLW`%ho&Wg%X^2;X?g`d203Sa>zDZJ-AWg=y)EtUQsD!`QKdce
zMLk}&D~+kLNJr~-=(jyUHT#t@c6mBC?`x#+L0tpsM-YI*>(_PSQDp^Fz#U}Bhye;1
z;+N^VXntUqgdDy;^K9R@v*fI#O%KoInF`L?&fI#3dgDew-z*%wYu<5?;E*jVkDD2D
z+h^EQj&!mY8>HPaN?DHy1fBYNHIBC$9vBFjbe^+goI%Hrlq+DL%I?UD&WI>qy+V>{
ziL32^B-e#D?W%wt%HVc&lfHVtLV~0F=~bL-y$?SGH<uczFZb9OG!P@82qlq?Ny>`L
z1=mclOJGfX%{S=!w}Uoqsqvl}G=QWc_9rgCModMXw^4#dV<AvQ!QCRD{)~M+?YIf7
zJhR+1ce4b6`j^?u-WGMVj+1|EqfnqM)(@<+&BlkeaCy@i9EysnMMa715T1{V@qUT2
zP|k^mn=zC_Hu&#{7seYkyWczV5<8GRWy?kUx^M=VtmBBh3<(CXIO|g-hbB4*3sb0)
zlt75S_*6D5i>gJYnsP+gqbP<-GVl8<IeLo6Z_g$&d^c4#0lzLUnmU{HY&)>?9+a4k
z8=qC@!GQAoS3g1^zj$XQZr6ek4rar2xsrRx6W(_RyED={Fm&OuKiShg^O2zYrKXnL
zJlAq)Vx|vJidW91H+r19>~Gv}^O}s=W;4bN$Jkm&;XNYNV!mgb#AA|m)@>SQQzaas
zQ2;fI#Bd%t7*t(!3zwRt3_11Ecc79SF3nl(I;KSIsS2j@e#WC34XrACkI&6A8drvy
zy=rql^C8?6p$;B+H3vBc`<~n<0wX^@1^2L3&dfb<!j7i9oc&DPa}agr`4bUnGNd>i
zLofQXq@)C8`!h{c)aByX@?Gm;6!#Mj<4JLn9G~gOt*D77Mz3py73$x7N}22Dk$Rm&
zx)gZh|4Q)K5}1pSHii(J?yP*gfW*{s8-4qH)d%C&Sr<aLoUrU~PYSnrm#qo2fkoCA
zGvO<`AO^TrgWKX0yT$$HlZp+?=X+r=&Dkf)YyD9miS=)>Qp(=He@PM1nPlg2?T<2`
z@^#T~=gpB;MT_1fneaG|-kMCkoqkuPROs(kmwiv`7NDE8gH==O)Xia%3msib_hL-|
zy_-MeEUkJM@e-Lv4{p3!`uS)AzXFhy_46kyzG$s8^{y%_Tw*tAQf^Ze!|maNaUTAr
zQt7tRiGx(}CgAn0<X?uSETh)hpiOV}RJiYJk&sz}52TCf9`1fy$)sn_eV=G8VJ<p0
z5WDs`*14U4nK?J)+l`p0jN317&*uqt+_#k`_A?uF-EdQo_s*Bc-S92a&!qaDnA<kl
zzPkD<hZ~GLJKa)(coS&fJYhh$6;HL^74#-xgLOngB;~3BlarH;o_mjHO7-#-GhIi{
znCSMDM@CKSM9_v0A?8WHSDRyn_svd``S9LG!Vb6?d2?Be2w>uD7E^az3?8Y9g&MMD
zL9L-~lnuaIs%wxtW&%@yq!ce8ARDQG9vw%Xo^h&qb9!ZAhcfY&gv2)Xh1;=+?>?S*
zwj{@5g8x$30+M{z?X@4{%`)yL{a2<pxU?6O#u-779uf(Ad=d4mis1`}Qcv@~D<WpB
zO*Bv+LK>rW*GwL9o=}0bSnt+m#-`2t14$u+#wzpnCJ75}mhV=l&O=Uy&k@j7T<bnI
z=3M4Sl)L>e$2M(jt50${;pj%3&jc3Pufgm?XTo*awLNrQBZA8w57j=1v{cRUEDt^n
zva3Sydh1>nag*Dcj9yS!rDu1FuzemHfQy;Xc>uf)P5ZK6<7Qsv<27Tga~+9R?X1(!
z{<Z)gY9xqfXZLCU>bL2hg0bT>5a$C8hSVXnKGxzGG%%r|U&F(nhg}8J)A(GH;epl3
zgZFz@3^&W!Bc8^;0l$!<B1=pkD2m+7rYfKW<2fD$#Z=+}pnfE*zUg(tn9O`Jh){ty
zt9`y>L)d@@br|8-dIznWQQ&P(E{_Q=zV&|YX6TSwQMp;YFAHMhnAj}fOr}|Ch{yG{
z?6R1(_{Fq{Xa&0c&?KyBIo<xPNA{*l(Bf>oaA04_P$;B&xF5UkPJh`k!mDoH_!D>Q
zY@~EpB`L_t#m3}Xs!+AA(aUA>^Ql36F#V;SEoIS0ZI_0|ZuiL4J`@HDj~J`VeT;I{
z-1ffB2lsz&AMlCjcqQ9B)DC2-;q`rOJ?kJRrHRZCY%xr()_GA4;g8#65Z%xirE6zp
zpGbV5+u_mn!(%oix^P{2wMp|$+e2L%%M00e-VbV8Nln6B+l2DtZf@O4R$k54-t7}&
zzz{lS0zUob_hEZRdQG_#i(hq6@m_cQg0vnpi4^uO!U63qeQGfNI$EtFv=ewPP&Zm=
z&WM;r$CKSY!%z^D+&t_FD{w~a`$Pec9$anQtCQ|Anl;MqB(n}-^|)5{xMm5AFtPV}
zB$~vi?U1Gihrd@@p}hf{tc^_-9BxTRhl>Y3<ili7p_|4T{EQq#Td%mUc(O~nBsT2r
zZkhO>u+lx)?=hig2yGE~B}%L+nYwQ2&X{IUO0}^^HNAXvLslQf*tgtv%E7G}h!bc*
zta_{Nz{k)Zo-o^nHm-eT*c;J-0V?lM*_Z@gJXkngVbtU4349piuup|Bk<;31YlJgk
z)UROCjlLL72o51JJ>WA>;Kh&#9=*2{TLlhbd248mtJ2w^Bo3R)vAqDW!H#NQprV7)
zDFu(J5w>gC@d=s%e$f&>S%gDq2&>Li!B?1V8*0{}0S^Vt?YqPX{@5A#b_4y@l-0C1
zxC5(fap3B^zGggWmr1oCjT(VS$r&41V(49oYU3DgN%uSD+^06|S&$?7y2@bDW7q&J
zAh@L$EitT{EG5voGX+oKRRxz78#X5cD%g=c9U{&{!Dr3wXRY(QVxwU@=p)5)<XfXu
zXxwP$bC9M^iQ8g&Gvm@;l|!fJD2|$ysIqXyhx#sEz6$7L!)FGIm-^xzS*IOR2b~=a
z>g~j?QRt=Fjpi~vg43!S;sVPVjgV#J6?#V)6w`r(1ch4NpjGK;zJCw*_I!#U`|R}o
zt~eT>Oo;!ft&tN2Z`~4AA_nl)>%9d2n!^ll%&vlMcKCb&c<vd*+pwG}FcVxn+J+LY
zy%7U+AWA2_8KBoRC;(!3X6B7M$}`Uhx2C;t>2=78n5d@Mg`Df}P5-anp4FI^tqp7h
zTmO-Zlngl6BgdIP5Fu-7x^ejGfjYEQX|z#ZXHR{P5Q0x6S|ixEeb`C5TY`G{Z<ONv
zJ-bB6e(2DjHfv=Q_5IGE=4;C;gBb3)L*Y+h^{d}F$-lP6*zb8(48a%9xL#TsC0zK=
z;p-+C`!s;l-InKK-DW=2S(lYh&I_VZfF=aQgRvEu&gSBr#p7@kK)>K&l{Hi<*DREN
zGo$a|d`+*6EC!<&LT)lgF=sitvXB~bS(8En=}FP?)SaQkU#hXKU~{ges*nHTx%aXz
zHnn$r845uja-2yz25Zy{R5B{L!Hcuu92piLo_-tv9YJ<fkJbs+&1XoCdx+c%RjFKw
z4&#<r9v7`4R~c^iHf5DS?DvLco8uh&%A@uhE(~>mu8R#P0!j?AfF%^tHa1dh3PMe4
zS--}IsGT?GT=5Y{aEI_+0W1z1JG>w4Ca8!v?Mv6&an@o&*qLWtL?dM;Bo*z-mu(0C
zLN=Wj@!+bO)*ACj5(ZgU>-$kZxK(k+`cv{C9~s-%pNEdTizzX#D-+R@s;}2y4aQKb
zgJ+P*jWYM;FJBb|+PzwS>J|4+sr`O%rg}{n*toGmgo|Rw%&wgPnv(O)Lw}i;pa6GA
zYT`n94b{jUS0<j8$@>zvK}Twtv}TnEMp>1$JR00ZsPbLRXl(hXET6&|cl&MZi;^)d
z<3Jat%%d$v-1!!_*4Bzs?@Q{RAWuY2$)5jHgNITRz!^HCPC|8cyhkbM4VEwMcnVXG
zeY7G@=~Z#Qmh;<~7Me6K-qT6Pbf)NWSJ!DZw+}SCTZ$I9bYL@cHSe#>45NaLp-`Z<
z-cG|LKmKX|vuwb9A@8e~%7)I@+N~!ZKbjy1E|}CkmjM9N+wwKnX}wOA&x`}T$pVyL
zL(iX{Z`gq}bpf^BOtS4-A?3_B%4r09OMd?72tuspat^_=XNhU8jFpPwD5IClyt)TI
zft@H|SLohd@r9oZO~1CMT1Zn*TJ9Y4u3>O7Hr|)7l%0$bUSMW9|Lz*d0@%_x!Jql}
zxM18y^8$Pzpu(z&7=B@G*dgbuo&mcrqCB8qU}pgF-O*~WA3Q+l>6s9~y+hWh`N<RV
zAw)~4;YJmacAzaqy3i0MD03hAc5Y#LEe_;Ky*u{F><@jXxg_k|zp5Hw5@skhb;a)b
z5%&*6rO&b6HSaT?jTdI9as_x4mP)Vxa`-RpH~!k}zepTyoUWL6t?YSmbBa98o3E~_
z#hdk>z!S`?_t^Fl9QXp#{fJq<dOUA1gbzF+<^JBb4-lJitB(sWPgYFkP9=}rZ0Wzo
zrZ=_ckH(^v7$Bnm1eD2{;6PH_ZD|)|@L*2|z+@C?M-6X<zyYkmCH^8C02Rt;qpdy1
zE}JEABjR~3gs{iaUX%OjN4<8xCgb!)0!BYmNQ1P@{ex(srB0YrM;SD{aH34Vj!<aX
zuf}+&taE&Jq3g3)E1LHqU66_RFBbgsD7BN_geH3n15%)f!i!I;CXe`gNGePvvqz0o
zY}-ZvR?j0&J(0URCsN|ev33$*k;g4rG9cf~-LhbIqlPuHfgFZiod>B&3hyv1=V>h?
zR+SoId0Aa4Q)T5k)vq>DxW0P`op|ZdCvyQE=0-d7pWF6N8HVgf+ch<x?$tq(=^m@Y
zZPm`W{2gLT>`LAm!B%@s!v<yByJ9T7rT+o*SSkz}M88#P+@_yQs+Qm4y76`iXEbAJ
z?!#^~NxKEE^@sr8n_NaI{xP-KO*4MkVADzh={kC^&RzW^19P3QHNPfmn+jSrxHdfY
z*UEh#rT06JB;k;I({vwV`KkNGR2+QS=3NE&f#KIrr1xlpM9zw&nXc|SGp#o+k#F69
zqj?_pOI1bn4wsw}f}?N({L``?th!fK5{Ld!xFT1ND*0NVmkfh?GOf1@GN(Ba5YtI&
zY3&EXEcS!Y{8lmvIYQF2`x$mho4$7)!r%+`dfpjq&!B?2gYO9dIu*tn-64vp-0|-0
z7IT$m(o%B^xWV)&$t7{qYr&cpqdTO4#vq??MtWuICs)8iCYdF>ZEcc6{2jrf)jn>q
z4;{#aFO=(k+Ik@0372+5%}!@|i5WRL&0A*Qfp8wpQRX=NH)HfUjSzmpGRWk22E$x`
zJwCOE2fG?lvbQ-NOZ{lLuU)s}lU_1~8uWKDbn5yc&Q=;r1ATVJ?;p4pETQQjAi;4t
ze~SOoS6D$NpE*bwsGJ3e9x<RFht!wp`r^>=D>~_RP*U}&xSXqE^9^rR(@K`qdjqD!
zNeY#G)H4ASBk#mB!30&y!;*!)JD|;Zr*=Ma7ovTV9JcYCPjPeAk{98*Dty8=a@IQ*
z5Oi(@NNN`9$=GfXZ^x25CyYmb5s;k)Il=%1Lhjo^3#tWS^^SeLM=lYb?sNF|i?~tQ
z)zb6>gSu|d#ggJOtEvUgmKg`*@3_)|ZnTXAHGE=1(bHtFt%K^9D~2*t3m?ofOu#i2
zpYzji6pjKrOQOQVw=UDdatfZoOuy&XRrT8k)0w10Vs2mAK!oEw9L+rZX=OQzzDfI4
zGD;U4HPuLdX{{mWeyZ`lt|7n9EUTJx8~q{8MPhwEtFKCi0s2P9JK?{jB~f<J@(p57
zRuwZk1Jh@&f~J`HNnsDe!I_eqA2ucP0AkUZInNvJQgIhj6>-#~EPyMSLrZ4R2%t0*
z5LF;%H3Sjfe^jZLY&{>^0^?o{-$hQj2^T4Dv|_oOZGeh7l3SEC?bi{`oK6x;<E&=`
zcf$_M?=rk@PXzH!{ikyIAo1$2`CBdH*pNTo{k!t|6$nYX`!6|QF4<hF(3kW5xg`Bf
z5AUn=#qO!20MmC)RZrteVR<d>IMSFJ5C4QNydU(7HYyCV<19G?x9)7BX5nA9g2*&|
zvw@-8nfr+7_fM@nCJ_SQbco^TP1278_%Ql+V||2(AuXAu$Kgs>ltjpFz(wjWcK*1$
ztgC00O<r&B&?KZZH_})g)T21o6+Fyfp=IejKWfC-RDPcTL{+iil}0S42H5n@Y^U35
zH!aSi=_9$sbWW`Iu6}6);@erouzfV4qxy!ne~~$MoS#aKst^9qJCN2_STB4%7o=Q-
zn}z$vJg>Kt&cEzgDBEcXlT(h*P~u%V^E}rlc~t}0oc0!YlVZ#7{CC)#oH?wLK4($V
z-S7^#2Hs2ZCl6)p#Y0$TL&^%Wst2*#>c$-B9X(yA3%{dFIaQ0&48MX-eb@+5tOdxG
zuEn^H7t7yRv9jy<GlMc^kQ)n4Zdj-sUMMy_HMOO(grjU?l6`HV*W~()m5r^+W$leo
z{9*>yxRA-&=@S08@gv3ERoB)-++$BT<n}vRZ=zy?_XjCwUC9b|Ey68SXYfg9{QyQk
zU&mspmwW=A*?J1>WVJL}veD2&U1r!+62K&DzwXGL;%}P^*^^kzc)JV^0xUBowXz5P
zc=+?cIX)4$k;9j>?07TJolhl+`FO}!=yOBf69~)R0kD>E!T|T~x<}B=8XAUq6yzHi
z%n!iV7gNH@%FSD5R)76Y#V+Zqh_x`4Tc<7tarw0A7AEdOHIZs^_?x)g<;xBXXlL39
zkGGQb-pOE*4I>6Q(Gl!C3I4#BWYT|O(cWyF(l%HVU;evVr95WyB7=<<ty_T{syD=Y
zurXP$o-%|Yqj0MKXvK{~(o!}4$xKL)gUVB=-fv^KufDJfO_SJg)lxMe?H6Xw?8fs@
z^#|M2v!qe)>Z;fgk8Atm4+iYR8<*i<)^_`nNIcD1nA7qE>}FDM-nB>Ws>nn}-@dC&
zbtpeuF=T(N>f|&eh-<eAobe$Aip!b$R6em5_kM>v-VB}B;i7>%TWC%!LZ89%5M|Yy
zfRj=o7FzR6PC9M)mOu4PtZ^!lkx5RJFemc%PMkIWwhv#q%1-5IeoRUA%%X>7IYN-)
zRW;Z66+6>xT*u0(P$HU^lNO!cji_ir(#imn0sbX0#L<Wqh9zDFos0{I=IG`N6O6Au
z>58<lJvJH?niYwFXT8@B<Iun!KvCx6Si8vz!_I3Zh3^&;puZ2N>%f8t#Ikt!PI&=S
zqr$1yJfBjsSe%zl7cxE??sVa#+KmEq_OnAcz82C-$<IHE$f<85ci=B3{;t8QFVs>#
zMEALQ>4TlJgmqgHBJ$~YyWAa?nR}1^9G_kO1V>jkxFgqsNWH?Uc1rTR9%1vn^;LiW
z)27#aN9Y#{`F{JH<F7ei)~uz7X|z{0yWM#n^3|!*J56&64#G%JgwIe)2V#qSxr5{%
zJG^o8dM>MgfLw-E2ix>7ettV$OBu~M5c$!)<kflb;k=x@xR$L%DmM$PDPziQDu-N~
zG-v*mpu_j}E_%}bD<9x(H>(J-@==>0@n_jn{KaffqDV>(dkf{H6Me3av{J$E<j|yV
zl@5WlBFTU^6_&}P{?GKidO_xjn4aI)W$j?63wm~#CWnCZCNE!WHJnboe5!(-6cQ(>
z%uLBYcJwiiH%PfQidf`&+)hTP!b2I|s-=FqF8O92`fk~0Uo@e1c^*tdG$^oRt}(}|
zwJGmkFt~2)UIaj07ugAT(<gN7p3RiB8$uDSS$@p~-&kK@hn^<N>1#%EJxPV~`35@3
zi?nvWVitx6TzoNiHX#*{AV#^>-tN$hAz=|L!_BGJuGNfwe?Gixrg(JRR3US}WXrUm
z3IRNizn3wMn6vz8pC0UMebM*eyBqvA@#l5ge3I=0a)j8X&{sh0_);oV;#P#TT%7#}
zt=PS!kIS7~hu&?hrGc8IPQ!QOMW5x<ft_D`_~|ce-WIgJRXIOd=Tv`EV;cy-lq&W}
zoxdkT=%RRX43k7rnaXEY9W%S&^}I1(goo4c11r&}oYfYBKN2j)ftab>{JJjv2j}z>
z1s3T!_1-t#6Y)!I4esLk*9ugOyWp?3(rwn{xzsdnMkeZa__Bft`}s#+?Ob`Nl1RQZ
zrym7*9-A3CahPiy`ac`o$11%fjf^ry3Okdy42ETaimCRT+Cg10KF{})G|Pt1av8Sr
zZ+<StXUYu<!aL}XM<$|Hj6pNqfY^ayj%}n2dU)kY3pusIzD$9iijZdxo}6{eOXlSh
zE7oow998u}&v~6{kut91gJ7V1wb*I<1persQTItO$ImC8io#MkQG2sc?=q3t@hO2*
zKs86I>!Lx$<)c_%^E&AX_+{3QYQIk(?3tOHmsY9${w7=o5+oSss|<D6W!QHHn^s>y
z$^=?h0=Y*NNyzv9_=Uxpr#v(PkleIvINQcDH9GbKGyMLJ5SC}j^(XjRTfu`(#3a!C
zdRJGs)BKNzmgbuCnkq(>j1EY^C!=0<kNiv`S`}WpVWk<Xd5oCnSfagL(JUZ|Z%*63
zQ=@Zia>9SmZdUr@r#rF6mLZ7IyaM3>!5B)@zXg?mwIn^5p3>ZnMGgaA<*reSeO!Vd
zw^ZD}Bd>rbvh-jl^)5v@TygY9uc)>7gDoFdlEWUgTK8L+hqDUbS<q=xS^mUln96>p
zyNjFmL*o~ZY%6NY-yc}JSS`TpQI>5&4wr68f>s%$l#-L;4X#@sIB12Iyw)-T5^70}
zy*DT@Mb3Y;ZX-g=rO=7N-_47gYd}@+{=lv6{E@4s<%d1wo1<<<^0o5)W0Uc1ao<^!
zv6%>Ygv_cBk+?%XSDQxKYxOj3AD!lQ0Tm0y8mliPz-aS(q6uGvZ!^{8zhCR2764Qh
zI6k5opfEUYRYqKnXB2bu@1@&T&qICMK_=Eehfmx9b?K~@AwSzAMXY|d9+Vxn3VDj2
zpk78RQS=3@sIVqP`jBN`t+PeyF9o0-T95i@H%06>To?Ccy^PF(kx+l8G}?>&Y>401
zGYt3c>zXC0eaDJFr!mdeSS~6q)=wsIkUQJI^&8V{g!!S(3&pn@g^X`Je22eT?W8L?
z9kJ5f7SR!!XNy^#i}$mBOFK>S>obc@l>*fZld-o=#r3h<@1J}y$xc0;mfQAktC-xh
z3FN?(?kuw%oNu|;TuiicxD~WpM-zV$=_~5=O-C*1?#bt$rS|<KG?zFWa*CrwGM5{*
zgpvTyJKc^h{IWKx7d&AOo5AfGO@<A=WcjTmGHxs^!}A9%`jJFye*T5o1LzHLlWm7C
z`7lZzYiOPQ@f=tYXK^-(K>_XA@XNhHAgu&j?|+XyWbenTH!xmO@q2gP{9*%|U2mUW
zj0PG9;s#tJvk@vET!%|4+SA4#d^aqIl}()m4HC3ekzth%b1cDR>*jubS3d6MB{JK!
zPUTeB;o+3Q+uPewy%!&OEEd~hUnKVV`zxY=q-1LPsJ({e>oUusR`V<hl)(|UApCxk
z%5x2&l<d63sLvdDt+;^RF<H9-z&`szH)<qqhT)^LzO<FQp^07xen&jy<XoRAIJH;G
z8kV|!584V8DcQVLO<Fu1-n>~WZ`q&7<{NP8gk&kHP%?pyvBfo^MfU`5_H2YFC(8f(
z@e@7y3tvv7hl{wsas2F5*!K0wdXQ{9+Y=Y82Z$@tSAALFPg)9^o9n(_i_IQBTn+cB
zxKkGAuv*i2Xa|h%mXh(}>@_qN^Ej}^Cz<;h2Lw%iGwf)u*eAGfqkBt(fWX;Loyt3D
zBn0V~FAfs%Fh`$*CH61A3(<P_$AZ@=CZo%~VdqZn)Y1Mprda&b)@!SSr?W?o<GzJg
z>pfbWrQRYXv#c_st#?{><bnxqb%#77+3kJttQRdA8G0Kqv*66fqvX@6eNV<>g-*{W
zj)6((^g#As^+E|9R=z-^z(qO(&R4eb05w1?M-}oAvOZal-A1_)Vnrfe7S{l`?^s^r
zuJ;{LlP0W4p@S?Ib0qC0Sho;XF?@-97c)?w?UwG>P751x<!OTOM?T2z0$I_Ch9NCe
z_AXtG$j8;|abVK1zpKEd&uSO1S>uV6<i%euA5<yzd-^Y63_Mb)-~llA)M5```RucR
zy0B`c>9two#s{<Y9u%uAV3(`&yQ?Mjt3G1zj+<-r9iDvuez^bl-lt#MRc}{qKMnPH
zT?wZr`5gQ*)Tfkef?1*VAg;4-o^{fKIwIh+g(New;&UCtZq*wqRBWO76#U1i)14PZ
zY7mRsI_ya&I<B3MNQ`Lq-6fmF-FgLINWfSui8Jfl+_CcH{@oOG6H0Kc$tBSkg_h3u
zNr_!6lEARXAnMec_hRrf0yp^fo7c>nEpmpJ1;`S^JZyY*3FtPf@28_EO&@{@vbr@?
z23&7b!S?Gvkt6^dG3<7*xJh03Z2jJ~k*@FR_qx4Dbnv04=-=TPXeQ;-2c2J%>woXp
zM;7Z2X7?z#jf%`yG9U_8y-;6D4Z9E;PUh3a)0;m-j?<T~`Z6ra#(FQ7-bxADr_=Pm
zz%IBY>#Yu+RFTBb<DX`x{M@Sdh$eC>mV^R~S;r(_U#F#H?_D4t4UDDG&~iqui-R(U
z#o^LpB8;ZBBu^-Uc!yc_sqa{L8Y=hk+6OpW3yD?JgBCIe?}~3;C{7KVJEB+psb8Ie
z?r6jyuabFoRxHywe3@VtMvOgFKyMnhtmw4`Hd^O&?o5RpC=I6vHzJ#}L@8F>*`&CA
zkL1VMz>2rO@ma4Cf!ec{kK_c;Dl3y&gv%OIo|eQDewumjzvC-Qf2KkIB||JfrmDfA
zXJ&-zWx(5xZ|06jW^|FHO>zd>thUS`428(|Bh<hOIFk7ju;o25l;M%t=#Ey&;VEpB
zynTBRcK_z<fq<G7a0nYW%12*<T1jfx<-bqHb&@~ftRWwI-1LjLktaM$My{EbmW-<~
zcX_U9FEaZLVk%!O)Y3Q@4F!)|S_MN^kS1ANv{T^{m)(|ERC5w6{O>ctgB+P%eLQ|X
zr==62__fC2YmAzlDu(B;uKW4NJ`uiezjY<KL)-0!07eI9`fTY3M{B5wy*#vAxxZ)Q
ztGAa2%tl+}<?UZ#fxnIahHMFj<9yZ0-9{lnk`0>y8cV4vSm5hxi<w&{5G&u&B>mA+
zMPZ9_XhZ@!l2=)I;4pFv%IZh+{&pw_kUq4{Lwv@mZoezDfy-VpVd(WD0f&xS)Gwmi
z+8q;Z{Hw!fa=d<4#3ncE-YH=vZUUpnw8Q775~1+`&R<w*7NurTDm}`SvAUXkSsP~n
zlyyyEJZ(_j@)>?DC9#klwFYmz_dq0@jC*ZY6R#b}f;P(pTUaHYcq?B|5izvd-?XW$
zT@7h3f=z(IGor10lF>Hkr(>6vP34{xjip_z$cE0<hXJR@2UGkL&oVT!N0p11ku}K2
z$4$VZp78)?TyEu}L+QDC0XtCbyZBVSFfId>knYTyA-d@ugG3ZLm3w{R7|64{^-FTh
zkT1Kfh=>SF@NbCoi`(A1Aa2l-xAjbKlSxi_>t(#hV!;$f+;TBExir8|aR;b+@#R$Z
ztNlSe{{6d;XT*GZuPMT@LKzVo4|61*dGjoB@dVzZ*<fb(JaO-DEVX1t1ic+K{7wgX
zSHywHlfa%ljqJX_?8*Dr5T-X=CXToG`1q6|h)XB0;-{Gx5zjfdKVcKq>1YSe<Kf+R
ztLMMTC1E`^bntne#NH|bE-z{as=R!f>&roymoLUg*KFE$q1re^zk+91y4@MrN<v~l
zAGP>np(*>tvmR`ajv=CC>X8ubXfGb7doD={9~;~E-}AtT)KwsA=0cRX{Qa930Kj?c
zL<77>{k*3EK3=%(HPW@;zXV#d$@1~W*!S1JsojZ964+e16`vnh?v$Mk2&O`M^?RX0
zp0`T~7*NU&oI+x3!Eh7r@g3uz$p@_yAM0s4e$~x8HB>qCSMUJVE+;%lxgM|`EokhE
zIAvHK>w)-v_eFG?kiyW*br+&_w+y$ADbw2!z#iz+CiY>e+ah=D1zPGasseT_G4a>k
zuE55j<C<&?mi*~&_GQ%j!sq>vO~ZuIfqe-pBjC6%+fkEnDta}dGWvu6IY^Sk(6r^V
z8v<|hBi`~g?jeS8cm_2R5Z6I}W^yi&<#MAsGI=Wc_|R=JWMp$OQK{~Rprh}EYQBv?
zHf4Gkfi7E$XPqmia#5b{!qOxhQ9kEFEg+F*53Z*bVIaNhBgUKY1@1r}2Og0>Z`c1^
z?72J3YlQ6!(czz7n2Q)n=2;8G%vOk0Js+9F9>-BTT6Tvsiec{e##f)#h_EFnv|enc
zH(R*GCm%~(AH}94dmp`JI2p|lN#Movz~Ux@q656dST{Jt47D@e=z}Weev<3TBH>$a
zKbH%2rDbFU4<>T*iio6Q5rC4C(uK9>Zn^zcLLg*ACD)aSWF*wg6srf1^r@Qrv!VO(
zu8XxwPH0}J8xuqKjP3XBhOLj9Nw5_Lk>kPL|In=P)<|2f_0c;0dLXp$9ZFfCW9%&(
z$dMtovW!)g`EZrdmBSo>`*?|A7el-K&u!`DPiFBRl8*bO9t;x)W9txqM8k#Ou)5L2
z4%zX)g5^R!d8Wxo=SFCTo7`s4z0U-t7odd%|N77}*SbQbq>mhHKfcRY2LDwubMfLw
z$w<5wmrhxldvMbaCDqI(9|@?<&!xuO^I(~w6N#ht>#8J72rpcCi4`RuGaZ!6+hTlp
zCX@<hH?SpzF&*jJU#~oW58!aJu;`_v##7VBm;(YB$amaUOF8%?XbYVx^D>`?63>wb
z#W1nLEKa}JWQ#~WC*Wq|Ao*ju;coJYCG{qvEnFqwI6;=nsRJX3$Dp6K8a&HLsINyu
zkwQ8?f#v_h`+JGqE!tBNZFf`UHiJokhlYN@Z0n{M4U3-XG>4>Wyx0(_PaY@a>Cu@?
z*IP-X-HDBdgM?Udb*?N#WUa%k2?-G$**h+PdNQX)K8?qs^>XLMy-w8|CgGQ~Y8Su9
zCTmTFPhKV7_txoy>>4`7PhVgGa1e>am1?rCzJUR%p!WA~Gt2-pxczkA&ilcrf@aM6
zV(kTuPg*$Tm#g88u}K*j#SDJ)HHxjf?4W(N`+pSreOS|7XG779zC^JiNn@uEd|)V6
zhx=yZudErG@KOS=z=6Zf!e`hvA^jcfB96b{UisBka5$wg!-vI?$vkEyPCc2hh9`Cz
zb^iqi-;zg*1gE^F#L_DHrI)8Lr<<8-%O&2?FPCLrXNw@0jXIO<hq<eZ3s~=KF?+To
zdh>-lr}uzz!3Bi36obL7FdCO-9Vm8RjhP=cJEO97zNFImO|sV;e6|#gRi)B`G_(77
zhVkgod+pE{f#43R*j;V(bbAn$Nx&i?vuT-Swk&4kg$k@v{Bs-0QVGN)QpmWp`#`)N
zE36}Yz_ow50I!;NRzx{?9d<2Rp>3DF$Yy?`k7f_FMhcyJzfgE#)7rx&--GRkFxv%B
zYg(Z1&;zfV&@-3qI%u4W!8_W@kq!n87PgnCDjJ2&sG7o?6@gZu8@N@zv)Xe{AG!SA
zo1oxpesS@j-@!3f!8~EjQvBlBIMc6Va4T3wGwVM=`=2e@h^-D8OTZl4FRZLQ!)*i+
zW2er|v@i_Jy^6y`)Pq{(0Uh|q<-z&KOpM5<NC!{}Y0u9yQ7_ybnOUE=*yG(~wiT=X
zs7Hfv<kn|{g{uTt#swVyNF@tB<NULF6i~}<#aWX8goSl_b+(*Q&!vVoIwqrU)96fe
zUMHN>3zfene63EWN8rBn5AK^Lax7m#6*W}ZPTRU^R0SZ@mzm<^AGKzPbMilXIDU1H
zNo*{#yswE^#vxm-f>Jh<g%9esu3l{SOkWqfXKW}_7iY6Xiz2ly&e`RX1qb3&aN;Zs
zv1p59Yz(cW{5$tjOd$Wu@aQQJR_Vd7d5akgjH>rQR0gzt6IJ@loxhdSXK>BL+N$Ew
zqmrdA6<>~Cck|-#mwHy^GtJS8@dQM>ZR|A>h#HfJZq_UWp!Y6`u(e4=a_n|W6TRn-
zt07#-FIwQ?a$S8#Q;^fm-I?P%ZmOYP>KsHP>xW{RZ}*rVCH6qmygOhhGwkibOhfZ9
zlXsgC;Xrm$9G!X*jqi>kW}+L*=R2}-qN;wThb<xg`siK$a##9YS*nNb<LRb7&nARt
zt;jCaQt(4V+ep^!=|RZnp0=V>0neh*&46OAP41Z=MXBqJ|BAWYVWsGJU~*lS%Q7FI
zRJHgbLv9FGn;8CfZS@<W!Z)lgaqdNbvW3Hp+0YD)Kh!EkEP$GgTe#+pauXzhd%05l
z;|Nus8EgJi`Jq%UjttR+HOR@M9+8!gFZd#C>U*0Q$u@XM18(<KF?{|cb(;m7kGSA-
z?mX#mye;KsK=cM%FU*i4gqV80im(byZ<^6{ViEylSU#M%1pq0pNXln&&W73S7<gFG
zYs-^@SAf{k3^q@h^nf`CHbmb7mdrl7OAr)JHyNBWPb~J85J2=N%{d)-T2#!nr%;!^
zTQHw{mcssjlA~E68<SLz^6%c|3qQ(=PO0gUvx_m$|5=~y$NxeZ!oN_)4B^jELYtwp
z`39e6Y;ltNjagf++rt87g9CEC9y2&#^p2rn2kb?lu6SgI@QVYQkpxbswLKI9CGSw;
zGUP)MN+Aje3g!=YQDLx6aD@j{ld1u64~0}r-Oq`z3hJ%9@88_l*C1Knd2;iW_>M)o
zPk)6|f4C<pW6YBeQzf^G$jZ1>;e)5=fs_#z{GWXH>?23=h+D2Db*(>@?tak%HIJ|&
zsnh3wGBaiq#xTb@QpnI0!hQ%9`KUub)c1yc=bwDICta!1V6N?2KG#k6#G&kM1K7Df
z%q9TaCzDHO!SoS_-cYz{$kGVJhy^%cL3qF%kTU_yYs%<EEV;5N7U+W*fR|QJInRnf
z_)(KMM*D>gng_f6s*|9lpRZ{*21~rQA5~7%`OL?nG<XnQgqwXdo&Eobe8O#leua^x
zYvZVYr{JQNJ*8%f>B2lYdAi>NT3noMm2aqyxt;ZrUn<^ce4{4*MHHPmm;d&o_~1l=
z9R+tR;2)s{`MUFti~Z>%(yUa-5DVbTq)!uzSmS9+V+hrsiDeW@PJT<e?RAH@y8mfz
zw|Ht{8>w15mOw3$RkRCEbhvl^TXB<6xAhlqDRUekF!P6p)!qyRqu*ojL(e2D$^oP>
z%ko6A(MZwaGfwlmxu*{GK=$epRoKD-rFSIBsk!`~lU2Of^4vg}mNkd@+MM>OQC<ib
zyFEBEI3qQGwtk|~!*)~t)^p^M`Ic?7jPn%aX|UM)2|x7GI*_E7D<A+Dn9ZvQ<@R<l
z0m0LRzgVx;_+`I6dxaGRCo@t{_F8FgZkwlQI|!Ow>cA!zXQ%3~pL{nmQJEo%7q|In
zt9bley<*j?8n^r8)*Z)UNFMK^)<{d)L{?N6X*i|ie;4(R+}ma~_IiWuPpR0>3R7*f
zeX!)S{gwNPeuiV~(VGS5o(Jc9PJtzg<&3GbC)lPq;iUjk#4u2Az)%#+Jo2$=u@uX|
zA(=fp(<Lsb9W5hQ|AFUri(I@X>qp%{GCf;c+e*tJ%C;of`MI!mxnab>fP(!(qgt{R
zbZQFQl|_k#RUB-doo;Py$Ag@g8o#NxRPznQx|CU(v;64xJjkhc<_h?q#tYoDiu#&F
zx6>6+7bl{V`wCxFllM>ijv6~x{V*{Zg=2d#JvIdXZ7cd8ePf%?KeTPx4qI1RF>_G;
zx4tjeCim@!t4Cf-e+pF_x!CR#A8zWp{tRB4ri_`kB8OBryLq>XLRp7G!q2=+fjea~
zwZeb;#a!c7EU|~3HxKq{g9>!P=uda?EhCtkYRDam!h0os7w^8V=3*wd_{r8m^f~yj
zmwCp;UyYbiNt5-D(G&^+JqB96%ZP_ufM_ExSEkI6)F-4fbF>tlnlxAp*AbgQ4RG%!
zw8&)%FIp*RSJTElL|YhWYQGo<ex^Pl<?{J6h%e47ok3!_nGTINRp7%E^Lq}<--ix#
zZW_++b-jR`8<wVeEIDa?lV;x;(P{T+I!o|CXOWFC1H&;-GTYQ}6!7o410HUTr)E;;
zQRII41Dy&bA8xH5;40Jk5vqt=a^Zp5wC4Wpvq3(qfxtH_a__uaK8s5Fw(k9FWAr2A
z2u(-L%dv@h)AlfI9TmsK^-<4e3|5doD9Arz{##U3#xm#s6Eb1_ZJj>D{)QWX)f<!@
zot(V-!?|Lsh+FCf2F~Ec2VSD5_gg(>sZyURjz<_MD>k)_iXI+dvm4!z(4_y}x^n7&
z`!A@1{smCt9#{X-gCc!-axt}S3}V!<$ux%1!5h)Un&~L{RP<vVb6*=ChE|=^njuHj
ztjgfR9w=L4G0C9VsVA6Z-!o&<b}w}A$*%vQv6e9we)-Y3T57g0`5~1`b*pe0{SJe;
z2YOOB8a-4<eF385O)nyN^YES84#kv>Z99!x5JxkKqDLLO7lZ+UNCWE2Q<K%t7jKuI
zW%vaUX8W8h8-N!9AuJI-yX7h?{f9KjS{Y5c3kG9sm%Q=NUU$g-&6aANa>Fic+wl*@
znigzYMYB8Bjnz+Wy#7SLo$GnHB6YPwATgHz66%13&y_S=cQ5#TE7zoJd`y$W9QFPn
zLY|I&BJSPMz%X+OAG|tH1^B!R=y&r2<=nn^EmsM=e1sq1{CL{r9B;vA2G|!?w-y-L
zevs{co4(tq0Hb<PI=M8uh;L_5<pF3I5Wz}eWtRCRx+9$mJJ(1Y)uhH0y|!h~1dO}v
zI<T*5e?COpxYsqBv(vjK3^eaZb;$4zxK~|T|Ehz$R|8K%6=v&lARc|mVBf<CY<xUk
zfPaXG51_~?G$pWp>39B;c!*D|6sY*!JXs?4_iuQaLy>DbQkY^TgQouaX|71>foT|4
zycq6UiAM+ep3u?c&i+Ta5H!-VzL*|1{xg8O)TBbF2pN+d&+THI;Xyf%Dme#C!q(|x
zPzeRjK8uw0Bd1xAdNc|x8$Y5KiSlk8O+a7mTm}|b=-1~%L_&(N$lC5SIR%^Pz5bJi
zrO6%zDYF~Ko;gugD*r`eHZvYFcUX}h{?e0OMIQ-Eg=cZF=|?Aa4?VvRGOalbim_mx
zF;krRCjX?=Ex-B|tp0t?bxP4AkE~xslQC}cMpS)q0_^TCZ$qBEoe^xJ@CryCSPOGm
zeGQ~}icR)GfA%+agc%|C+)KmG>%;b*6tlTp9o{R%T^!+Dw*Txw?7Ou+)s$P{arUat
zUN-5)+bRz$z{LWYVeM#@9hWj4(DBZzeY<atR_P$`+5vwaK1+!}Za%Ld!^s|-7U~d@
zm)Nd#t=eMjKUsLEqoaeEekTC(Ts__xO8LL_Bigup0k8F+9^@ut9gH+O8VfZdY@{+o
zLBu6G6@AksIvxr~SZ@Eezm_~P%JgQ1bvOE)_u;PeBb?7H*c5uV$8_OBkFoK)CI+wg
z8mj}jq_X|=-4EfuOe><ii0!TOZDdkvV>k<aoAdK0zCpeHxLs3pY^?dlU}8!}#;?9;
zT8|H&SQ6lm2(W3O-}YhWdW%==uQxIqEVlxYx3T2)Y(dskfmZmWH9kO7%!5SwKE)QP
zB{-+xLzgqQWJYytz;e&@*vKM~8C#%!Ail>+6NJUF0<%}>7MH(WfN?K+JEYCujdn~n
z-N9~L;{6M^I!23*|JB@EhDF(~ZNnm|fRqx#(4io$bV`eKqvTN1NXbwlpma(%h%^X8
z2nYx$p+gT{N;fJcAo!j$<9)C7thL_fd*0{Q$B%p4^d5(6=DN-!_G91oLw%->`FTz%
zROj>e`FnkBP+}z~NZ@$IQSpyD6rr4^z_7?ldaU%pF0}Hu`~WVilbd5k#ZJzXQSR=>
zX^!r7ch9-dYc^*!W+!uo<L~fHS^{H~+L%v`j=mlz=4f{}?M8Fzcp7exdG?F6nN%J=
z_<mF3WGx#hTH(u;*en(9B7JgAFM#Xy6_UmKj8Q!)Db3H%4(*Hd0#B|>Kd)-qEo=4{
z++pL!xgx0s^4@J1R%|j^N3lmXUMDrLnOUa`4uiL-kTi@3VRQjFBBbD1MwPoBg|OP|
zeB@^YJGAok^e&UJeHvZg6_cCbHu?h7R0Q}IL<gyfZ1|{>d;Km{Z>6QWQZ%OB-=1Mo
zV>Z^xx9Bp(yWQx-TF<WI1EEK%s6@9?Pi;RcI$ioo;%R>t#Rhp{<-;_gDzAu1AXaV+
z;I{jYk!tH+T|d{yHFLcXuiOAL7uIZ0anU9@FX(KfuXcxIkc@v<Wb!0jmD+eH)eQpz
zr~=#yVw(^AiB<;8WOd3y-7;t8K|!Nxu3g7E-6f36n#jwV$olF>p6c)&xH4-7*$izQ
zcd{MBGyh{RKE$e280t6wQIhN4=E^X)7JJrnDmrsJ1^V$}EblWMG03I;RL^@two)JY
z-%5vMfAHrdxKtKrC1vu$SB3By8n4mPV%^h>Odi9t>J3_o+cv!EZAE!8;OBn#{q@CF
zo{0F=y#7KRZf#qT_H1kRgH*E{nnJCeGBU(|r`C>op8F;6-1GbPh^WNZ(k6~|;xZM*
zA>v(CUkR;rN)-#Y7p4&TVTp^oJxjLlb*B`6Q3MZ7=$fVGYxcaB;NRm_&MAF8nD>UY
z{dX4CLstKHqlJ#nX|Z-W?*a=3uHEKCy0q;=aXGhVvB&PHQi1xgz-h-f@#d7b`O5J@
z{g&0>g~od4T8`L$ftiM~tft#eEB=s?2Q`7*#pJHp0M5#^1)Au4B`@~?7IM(;1A<Oi
z*r#NoigNfR*!O-31irZ7W62G6W4hGIJlsxDXOSh51NHQBY#K&IpU;d6kl-gj0;8}m
zURpBAnj`P~z`Hxw)A(+#{-(9$@s0Y{P-l+#(EqCDul-<@mgxGHDt?Z~@Y2;@`86$s
zcB0|Nmb`(;=QW#t=&vS3vX9gzwL!~9Tcv4Btntzejq%az`cUl2F5SIS4%+Tk8Y8Nk
z1D;tO_6{dw#s16JkvZ6c8%di)9WVAJB)lN&4k`Yxh!5lGH@zO{B$4;Upf4aEMk)**
z|7|$?2q?{DSi?|kRmB%9q?#mKo-72oqxH%}b=z5XBLj;;-&nvv49RalO@Qq5H|{#N
z7yl-+!8E5;b>F#B<1k)<{dh|^_Gdi;28beGukF5_&Z@L!pA;UQQzqZ`WnFt?-KMTe
z*IA(Q^Ors$?Itm+(hI$klp7~^$v(sZMl0#5HaysPoc?x|WW$yjN&XC~HY6h}!T&z=
zRZ!C{hWx3S0_T|H>8zbF5z<LO_{K)inI>|ISL|8!BkTiWa@=BQItNm8AKE-c375KA
zxi@N^&1+J{OhYahY+-$OLx<!*d-qZ-EbDRIwAx`(6J-02@u0Dc|M#z2tkEz*meHw;
zn-4)nd9r_&mQ-+_dAX4%|32oaw0ToQs-Mh8aPUh?X=l$T1e<)#gLM$P!;%(fxum60
z^5F&l<!g+%#-qQL;tgiBYqbL<?MlqimJBby-Xd4Q=3c+8M8A|ewa<^$RzUmU#BWkO
z=~3^VeoAH3Vkq6bIsN>ECqp`iuB%%Yr044J&J9J&82`dnt30eo4{L0|T}c=l+CGHY
zaxjdYsaiYg`ljn}++5j|wL%le<zF(zw1b|f<$?E2Lg=Bv!YIE6gDS(~3l_mdsrje=
zQdM>`O$o=(=({o4<6`r48A@EaH=BQ-e!HK{Q~q?Rg|WqD5CD=}yZvuJ4sd+kqw(=j
zf<G%m_e|T;baL*ljGkvuSmdhbI=4K$WU3n4?cwQJXWFOhZp*=A)*2N~l|95J|Iwjo
zl}WeCIJm)7?3F4wKoQ<MGopYjeI0O%N7-rzuQ$VnW(6X$CGcn%e`xFI1am*AU#pwx
z>h7)vSlNAbb<4%B=%(AvK!OMmGw{QiLiF|4WZb@hJN3Gyp`3<yLqTyADVqFFNrW;l
z(7gvzVUjfF)!-MR>JIcj#JF4JCtPNvTkjM2-1bh6WqRd&4DpMrsGi*CUwk#V9|e7T
z3Jnnu&#<WMQIzjEEayq6u2#C^ZX;0+?f7ac4{PQV%v%)U+3I$b%j<RR*M}VX2{fsh
zlyaX)d_{u6c(I+A&kCK;<IK6_^ff^^g7dLyf!ZNqhXI@W;>1z6z0!%;C`=LWv#IwS
zm4S&oVH5@he`HIcf}GMh!v9sAC1YQI{&fC@)k67!C|w9YGT59i%$zkm%a>lJ=|u__
z%TR1?x1S(Qcl3q6rkMv9vbI&^t>(=c@|$$~=S_v5#Tj`M^|iOaItE4Xj(S@`JD-=e
zK}1<HE=*Y+vmSYOg^@Uf0qaT#vQ?5=K#VRZ;=xt_JOaxR6{3TXH!gh6^f{YivjQ8X
zeR@<wzc7!Ms<EHQb1OK56Xz3xpAKZ=Vw^))u8#&DD3TX+{xD>CI&T}OpU*;F<|OM7
z4B76f7d(L{cDv~#<31X(CP?AfTHVzhbXyC#=9;?7r|B}zokk-FFL*|KEee?-8>;8B
zL7m9yQ2C5kB=>MzvDxB%)c1UU8@`te-E~V#rDf{l3bpUiVPI&Ol0os-&GulJjIbrO
z6n~T!(n1HyWsEF(m%Xjp^$EGpDyAD}?hXAci&kuV*l@g#gu?~y=(FDldk4+Tzhz}2
zKZkiMa;k1u$Lrj_V&+j-77?|^40pclmSZEEu5HTmlM8CkPQPk?uorSUq<`uD$c=;&
zH%Q9HNwNuwZ%zKRuqmKd^g80m`Fiut=W=nMIr{>!hJjn8UM*w%lsC&flWu13ZY_0|
zvLscfX|*Z+<1YJr-=iqLLv&3zlfT&?eZY>9FtG}X?L=?OrV1XYEOz%vj)Gskp_0Iz
zGr6b!nE=^%@UB<&e3-3*cDuKL`o3O{e2p^+9<qMtu+(FAi0p%3JF;;k4bn?ma=5c4
z6kCmVL(^J=p|jRR$YDhp_X)Hv2J7++@;IjJ3*o0mi4ERjp8R92I%s#yI?5L&y#zRJ
z051+23SNl<)v$<hj{&)2(>l<pc_^oVz<X^MkcJIgV0S>aDOKf6in1RI`ap52_f62j
zLqS*nzeh4qxshzB!=31Jc?!a!AiVhMKT_uKaPJnW9?$>nxR#0py}57GXgC)fPc{at
zCRMu>a(qq_k3tujnM?Tue1C_C<}J7GPxPriZF0`JzeMxUa$M~t1ph`ZZYLPtfq~RJ
z{2Osv{m;Iwt5{f)r8Sxfa6wjB`J|v%QOY^*9jZu1B-NeO@m>+rBz!#|r~z-&G_iZx
z&APyPcM+9YdxjPivU1+8HX)unCHQ(89!Omg_(NoBvt04Bl>QsbI&uD&^1jWUc$+`p
z8fies6Q8_mxuUnx!Q4*v6LMfU&YeT&6oPa2@Z0EE<H*sHgxI!cj>VXJ?T#DHvdrn!
zMGK;zN{9jZ!Vc8chK2p0R4}{oY@$|T;>A988=pDr3E6FI$U!l~m5cay3GjURbOFis
zdW8%NX#lH<vq!4Q05E$%!Zf)z-jN%w<+4M~x<v&_4pX}e1$p#ktm-&ex6@*vu5Fp!
zr7V+kC3nd(@}4nXGw(qqa{C7vMrs$b#5r^i9^cO?WrNe7HWfw#T-o1`T>MDlsfVE8
zu8Mt2cRJ3f^p87x?)j5do2;DD=qzY=N!ik4VrPnNw&jAE=G^AGetSqzlUmceMotsw
ziDgPbnFwWbi%RRA3^AqFSCY2FX}K~Je&g(xHnv2_BGX2#_RmaN{1Gwcj>b+7aXpK-
z$a`&Yj$U`>r<L#cmB5yMPEppTcN4BklEEYcO#SaM1J8+)0g7RIQTD0s@+(OYv<FQs
zj!_x|R|az$srZ&_%BJPDC>%03s|fje_p8cHFFZk3&Q_`sJbqInD;a*O`}C^51u>b=
zpHLQMr2qzXLX2?l<d@^=%V`(iB#8AZbF{dqz@D%TJTU3Kc#iZHJ`Mw{KPFG^_4{!;
zS6QGjLZ$A)8c~24OZTjXualD#1#$sHn(%Pwn?QmQ@n(K=F9;!vxgvJyuXU(R<7gq`
zQ>yaOotzV1yX2C>2Eu5)b$`KuuL`&je(depvA97&uf!eeKH1Hg0Qab;5<Ty+wOxd#
z5|!eezSW`7&ut+*V!F*h%9Wou@~SvM9e~?81Uh{1SSvwU@*j7g{s8LIXGE*FCX@F&
zdL_dvdC^~uJR4J|^n>7Q6NDT`tWB+$@`>!<yrHy=;^QZ_hUS+f^Gsiv5holB_cv1z
zeEv{kq?n-U)(~vxhN)b1_4C&V588dN==iuOJB>KFQvn)vN2Y|{ob*ERsIK#$V7frf
z&rK(D?fTHctE5I(TV9agJsSme7Nn$_%eyo77DZxHYD_&mLl4f=3f}hm2(11XIu-tu
zBY>|7yTVZBU!!JX;DTe}`-35k6q(7;^RU-0Sj9=hUwvq`Dq)Xg&E07Az`jTaoHF`7
z5|!zP2jqQ%m<Pcsl_I2zdCcySzt;WF^7*H7u>D#z{pvOLv;IR?W*Z+d9p>(`yLw~j
zxrVs{34IOZH-W3nhC4&m#fT;{y~@Mb59YPrrGf;T68LvdBxp*KfWS(DRE}IuawmR%
zftp?|e{$XiPZujtkX`YGn<6A<2(N%eX<V?Ev1Cu<^Re8TAeX_BLr$#%rDvP=wuiRU
zoG5=mAI%YuZHs(iC%O(v4!iJ6>flR2&uFh|4ZTfQ`zK4Ju<{dE%J5et?NLM_bR<8K
zasjNv70)QJJu~)S)6~$-KP-$%xu0<QM5#HSh4ZP_HeWE7e|AeFT-kJ?vq1U!fnBk^
zy#F?i;){XeFa4u<at%yVws?U)@wejqQJ0Y*B-}i;)#UBfBER>i$S^@wtlvV?LgQ{d
z=NYGo%9eit6Y=(vgV)^9w_z!ULrfn-Tx=7-f8Yb|46PYMY_~|hTX;%x+c`NXsE*!v
z&Q<|^+#pM}Dt8g$*#<*E*~*qaeoF3hgrCl>Tju*<`kiEgUJ+`$N1lbu39EfOCIml+
zwl1?{B&x6Ax5mC7chL#PR_S#MU(GJ0LCp^~By7fRnz?1>6f0!4T^Tf)$aL!Ya@?;@
zxe<^CSwWutNW+~In9f|DqxkEt%PS|#&k3&AH(8XtI4xZx=t>XP7Z#G{dwry<@#Dn$
z1l8Ylz#xi{d1;*DMcY=t-Q?w;MX?qzTd8h<a;Bli2RrvQud?v3UcgPuXMx%s(lilf
zC^xikM64jhmSvkJj-QQHZv^<*dRducduNOsRTjg-BXs|li4%|)kVvHY=VWfc<oy2K
zt^8pld17MX#9Oxlp1#VGl5lkIn7=S-6t$n=Bw_<F8BEU+!QLrYWY(0z=1yS8+?4%)
zJ<SpCf=4o}y#i@y`sfu9b1wB?kxSI4evc83EN`vLGQuL-(U0K`UafuHQ{?YRw%w!R
z#n}QSilKLZ!s1=VExMb1Nokh=roXpi=pf@T0rj{ezQ^2+_q8nH*a;7@J?2(p68mXI
zRMyreE80XuY-KtgIx6}#Rj?>7Tq?W=lbnso``HutHiV40u%zudo&umiQ1jBy4E}f#
z2dBiR1<oI?n{bl{56zWyT;=E;lqbzlw=CwcifLu<O_%veCWCvc-JIlkRE$wm0q$U<
z`$c?2{0!?fixG>bdXK1RKCM;>y1UM2W0I1H0F+BS9;~*Yi6O0UuR+bxFxa)@s4F@A
z!IaAH-ITrcBV&p$d;lQH?hwuwm&#`vxVPe!g{O$Iy&f)aV-k;8jf(S-6wYbH?rkM`
zOh_*YBZ1z&85DW>ev}qbj^^fw=LB*vBAK%;z^0OS#L$Sww>4|V?H-tK$gQc&yx2{j
zo$%l%OS+0KO^lfrsFSVwv#(GCrHWw17_{!2_ZZen(_96pAxjigH_LD45`Awka=Vpx
z@eN+A-HY8V(moo@KNVP5P2?lO?%f;n6#{jl-Qh8^X*QJG44C$eis9V|gMM3wYU0Ao
zv3<if9If75oLzQWxRD*Ly1kLf-+cjB{<f{2xYt%{Wo6}9S(^RM)(7C!%KyDXuqmYY
ziQ17w$lr7%AiDbwJQQC5ka7`>sDQWHCx9dp|0~TXJepQ`V|eTT*)s57d<FB%FA`+z
ztrUOE`~nBFB(e}}82O+KHFk@M-ED)}Q}Uq$)R+ax!6Jd6NFL0LeEF<Aa?AK*z7Dab
zpE<?-eEmoGBglO!wJ<d<hEHblrxtl+w{^FQWiQ`dP!wf%)tXB;67AI~Gt171dN{OV
zpO-4uo|N*5`QeS!xVVo-`G>EaV1PGOIX}|VX9+%9s%E;lH;$Dpi<KA(C_Pi<#lzGZ
za_cItaqAUOC)dXGLd}?)Dlx~-M+~jeFKd=Irt7SJggoB707flS4P&U+{5hIF5vY2=
zZnwUvRiWd}3rJW_jtqPNgfs*>k(56Ic(*kLVBXDoaqEO~D|l8=4Ub)B7%=jBYk2?u
zVBv&}5{#3n`@<QYH|{vBt?wLiqKbj<nY`yB&-1-9y$^%P!ishOoqz^i2(|UNr1d?0
z$A@6FZ0t)#%9V9;07Wfi{Sz>K2{^Q*r(buRtWl_17Lt;RN#ZiFeEgW4R@fO?I0+mA
z0V51OG)(&cHk*8z1eLFQgUEzNcTrwh;~xce?Y>vu&_mB%heul*qXpHW77U8=gcz=u
z7G;ntX;{xYQB>nOI7;39&5j&syW9yLrMcKzdQc0@sx$ryb1>T@T65GWwUj(k@6Rg@
zFGgaDjN!qFP*bH9>qA!63jqwEo#DrTKo|d!4$G=87j)Y4ai0nq^i5ESfcy0#mt_Qq
z&tG7=Y~t^-TY`eO?AIepFR(FyhIb8$%)gRohhM!;SzBM1Uub`|GhvM1XDbr4&bUK~
zYv#g2`I}EM7#T<JCy>_eoEC_F;HS$_#H6Zne+S9Kx)1oL{IB};=HJ`Buw%k_Xa2a_
zZT_2daLx%xRS{7w%P5`A^PLWxWOHzg=})JEDN#Jps{>uf!&ipxmi{l16hffQQjwSg
znwC@i_Mf4}Pr%)qsIiVT{p{rDN5^GQ`C(~^6<EC%tHK@Z?Jdzx0m)6kA2GpSg|}r)
z)1JOOuLuJKO)_7E>^4m_M%xAO!Q}{_qf!!Q;bz(-Q~vN@K9R))n6wo3$9*yXGRrQ2
zjzyiUmg-Ec{AY_~f?ONhMp(@78yWmq!YdijMVhV!s)l4T9xHf-`{l?e@#PL})T$^J
zCt0K0(~HJ@bh%Ff;Cl1)0&arVn#@A@8Ff?x6YvnXd^%vuD2fa&@SG($K{{6x-1XPG
zro46*%QiH}Lu;i&YM;nXlfhWdP5yLCXLWRWLnNxiomM4Nz;D8Sr{GZgKsinzaW7SC
zKUK~^HBGFIRYo`CnZGM?)lqdNprn3!oMUymsDIVbCB^~a2wmZqh2O0@v6|R6^=P2g
z4hyq)yiKb3K{`LSS~Nzlyh*5W3Pzu0FZs18XKY-}{!_X1-Y?yoA~IO09ygO3H9a^q
zqzE}tdbYAE50H`*i-(7gs%T|z6xS<Qe#0H12*c};rQWcRv~$*J@5ttP<!fWKdS!dF
zGw`w^(%nytHZjXT>W-2ITIBz#e?FM00NW&5YhSeAT6)oT3#GBtjvgEb(;R(Yy{ik2
zIeXWm5BsAW_Elt<raeOE4sZu2vvrG7_R3_sXGS8e#*ugKf4&n!cf<m(Xhgi@g<)%9
zq0f<4sH&xhp`>y5K$(ULYkw*8fzMsZC*#5sK~G^fq&+$|cqk!SLC>dbq#iz)?L{nx
zItm&OZiqO0{EYH^IG5R7yeDi>^2HvEEKsS`GXp`)Q+c+Lc`7<(TTf*#?K5w?63|%b
zwiYMo(W^g?#(z4!QeVlRUhZiUnNC-2Jqo=cjA>QIlakK(;GFio^ulkCK2uuu28>BH
z9%V!u_yZ|EVLnQVALnuC5U}KH7FL5n>Ts~RD~MN$ZKF+&+EeI4lb(iIva(NmFqA%>
zpYnP=aiK#^fUVAEwz2RC?tX91N?OTxZ^85a&IzXeOig3*vF%P<@6FHy+P{JwC->4C
zzp9kKu1A^Kr~w~4o}g*Ej1QR;P{cY#C0o-%D?sGIYG*ht0flh!+3(grkL=f=3kDd=
zzPkT;`DDU=z_6mb^uP_7?QxfujF)2b<wMV`9O%aF@OUOS5`&1WT2Rmp%sj{uc}88P
zr$*EBSXvjNw0w3$G{^YY%3I=er85|z7L&+zT5jqXl=*MrOaI&TcN>+kSOA0UPp21?
zg{8u~EG~LO>lhs4zcA0j&!{Oy2O4PsX`Kv{TmEkMbcL+=Lj4pCGos(=AS3q~AJs^i
zv1F@cWO<Tt(_!v`HLz&WWQfS-xXtA`mn&9f%2Ik2oJdL{{2PqS`P!ePWP+^7#SkhF
z{JL(y4tq026B-FRI5MDQIDP9sA*aVgtS?}$C{)8=FUCJ)(a>H0w?B21aQ<d*x7JZ-
zRh|ZOEJ*f{OA_&QJiKF~06)1Mjcgmpe5)9<D`SZ=@-QizsyB1W7;~zB-s`+)7uaCm
zCdR0@ix4{`aqgJI8kNd|)NIUJjXpBXczI9qQ0j5t;hUK`C&6j%#K;pRQtgA+Q2tdP
zfz7*!^OH=aBBO?an5ew>h5ddz97!y|w+f^(T|SH%$IrOcZ;ZM0sln~^L^O~X9=)-E
zylf`-i>esnaiUZk>_dG|^>dgq3Et>;vV*v`BG9?J5p^fn9X6zOs^I_XOQnWn7xFZK
z{P3cD56@bApkFs@xbm=x%)}OrtX!cMSl`rjN)DGlW3m4ob=bTyadS0(OH=;ib@C55
zo==l{->pC;3DzCv8dtGA`(OoSKrq%k>tQmo(<IO))riv(yW}GsZiA^)uH6U+bB_~u
zknr~JpJDRdaK?VX$oIWe%^V6_z4((%U6RFv6}dV(uG2N89~dqiZ7C^({?}*d3J5u_
zzIO6>bXiv5?uvv&LgSmwtDGVtuLP+}`>P+-sf~&zI%iDUR2_2li<Q=7b@#T~c$!)1
zZB*4&P9{tWUE4AAR5(SHtBRE+MlNQryqX$*nDqOM_3@v!;c1f58v#1mm#;W<{iv%S
zUBjuxWKr9#?q3p{HO;M|R?@w-2yAc2u>x}>Lc(v`t`~zWT-!m<L@GY+2S!-3u80VI
zdBOV#U+AwkkQ(y*+U8Y5gCFlaGc(6IZ%Qgb`rvGy_Ydy~r<&{|7TGh~A5#A4R~Ipd
z=#Xw^7YYc`Y`=7>QwZ1&!-Tnyk<d5uup%}~uT@URuw^hG)F_B0zD~Wt5OO^C&XJZz
z4nCmlea!iaXPthGuC^)lxbNsdbwIB>m8Tv%{cwi>CTaSNzskq9!85aI1$s8{y0X!=
zw6c1t+%xTH%ML*7Sex0_wK`6|Cx%02;>_UW5<V}e2B+|*H3Oi*f5HVw4L~b79RxgT
ztk{Mltwb*G?kLEIV(#qiDyxqEeZs?<9#VwD(PftWcYk|s|7!sq!Msaw(Bb|C9#MU@
zGX7o=x*P#ig;yKEPUq~w=VYI539gNX1>k4<F=;%Y5a77p?jyDsrQ$Cxly`FR6PMOw
zcKve0ARyV4Ntw7vK=Mm`#&c70Vx*C>dR1c~A??!7WaC}=)e0RE2|srCHc7K~6E4dq
ztJyA#4}3FE3A(GZye$;Ad@|o5!zwx2qJ8H?FK+5u5dCWI0^Y?ePT%YdSbdvgM5gB6
zF6cbjACfFJ$$IO#@y0%qjy8k@#Vg3#n7|neSk|zq-{Tlo=UuO#FWlKK0ycQpq0(C8
z4x=dt*{^pZrC!wbN%S}JOfOScd3_F$0hrIv`cgQ2PyarIri<p$E*Sam<YjjHMDzbz
zS}GElK1z)JT2>;q4Sl#7bLu>+(?tIt=+~D~n>b9;XMrdffew~>%ou-x;IOhfw2{FQ
zX5?9LnpkI6Y>R^QzA_wNf41R1ylN2JNhvx;y-}^Gjj|{B=a3+${8vb*OuP71=_z(z
z`F28mPe{5~GdW7d&{ZxpXeyjPeGLq(DV#s`xS*$;u~8?7?nJTd+S`uhRd=R+*gtE!
z_B(7Fe3gguG$7s;3GPJJE#7)J#eH#YMl{d)#Z0r5Jp78mYOA8JmH1iR%fmhaWY+PW
znq6Nfe0sYjnJ-BZ=x0JNmsL@xt%BtJZZNDkS=6~{$e9{NWL-ady|~JsC&huv_M#>9
znVWqa-lF=4@!h^`V$V{6tnWGJhZm!Z_5UScygqaShQU{?9;K9yII1?8Pz>|vH7H1K
zF^F0Czw|1c%Iux&*EdV@Y=J#^jc|x2IVXkEh&Sz)bo=*mO~rdDRm9S4OGV1p(6qM%
z?bFGlhpMgcnkiw`%z_Cs7XSIp$Ntg9Gw8=YpY8ppi>Z@1bxUWzGF4HL<lyQ2SVVHE
z7E#eKTPTw4^xpHlknP8xr}{s#|IK`5vA|imGr7>Z8+njD_z?3(mpN##vAK^6ArJGZ
z!$o6=0c~{(OO9@p!(MB(3R~Nx^KyymVTInQ&?`Y2+<4e^ghsRpM8DZ1pDod&F~h5F
zB(iLK!#D#jbnCM}|7JraR}y!cTlT)2>2?fS2j2O~yjNV@qFK&@$)>)&NcwdZeBxAn
zIRtY9-iqLzR(P8+ldYTDw6P@Q*qPy|oKEBh<(=<~GY!S_-##T$Ix4xlp?wOvK|ce#
z+%PW{FHm)KmlrjIt3W*FB7L+QliN@><d++pljDlM9F+OZ_XQs_1owu7wC>TzE%p`9
zY{%_nS?nb#58$hNBfIZ-p%3AJu&Qg{P`9gNdfhNFp5``BbD&%PKV&nZBE&y4R%>1=
zn-8KUJ^Uim(?27k9v?nYCDPc+Ia~IBz~7BfS5(m1-kB_#s))2xDJv;y2et|O#?Fh2
zi-!N?CX;TWqeFo)mfusQ|K|BzmUnJ4?3hu`iX^wW<uVv`jmk!5$@V(NHhLSll-}B-
z&j0ZNafO>2H5Dp;ne1irqF4a*BIsUJ7Y9?X$p5wPfE)HBTMhV}IlT__sZ#E*GN1}Q
zZnZJK{C5eoZ~+(SX;1}vlJ+6iWmc9!3-z4^LB%1s#)?}!LSZo7P=HeQ4R3m5&VbD0
zVtl1ddZj^w<q0K`m^-#}DHe&=FX8AK#t6Rqc_{^5!c;oGBDObEF<tY={z@Q5E;%7g
zEv%%pSt%Zxx_hLPXn9Zk2vxL1InXIO06af>U+S@+kU+TyFef{?D#tp3uUBU8j!!P9
zQrob}b!RgiIz>0M?N&Q(M3cPVXiHC_GoIBtlQzzda1fv^-PAwgSzwS=cG4jEwIZTl
zy)k1o#zC=SIPOQEwZb=c_-*=el)H%YBePaB{3cUOE27no;_c(~eUXzqd>*W+F^0iY
zM4B9oPD5ekD(q)0W^$VT>L<T8v?iImuWwk0Q|opsA%oAdd2Z`}<fl_bf!$Y_Am4<c
zmL5-%n`|zlhs6Sib?lp4x(E26%aDJyTQx)##VEubq~AkyyFB;3Pc$gl6UD5nV+Rzo
zyjMf)^S8KyV)`_(`ocV8z{F{T&dKIYUVn?()SBlG0_xYkkCR0+uJ169@2@7f;T4(B
z`_iW`8ByiHV{_&c04aX_=PbYcu=b7SO!Pt<2~5bpH{d@8v(n9j&c=BTQ2cEEqxeA)
z{|oX;$qwo$npz)vHkSAUGqG0eO8)|p+g8P2WS^DGiC(<8dWSQCiGQ^x-tqZt059O^
z3b9aoy^!O4Bl5~YXIvDRljT*8u%>YhxPx1h=(NIL=}-o*QrkGR9)oNP!g<!q)p=s7
z6x6-Wj{P9T34bD)i~!D$2LTQ@RbpTN<g*;%{PqX~o)1jKZiXVQt$Ainy9PM=q!U;7
zeBKza4z4Tbc1vi;!(hwi*7h)R2q!5)*&B08FRB(zsa3BZO+sAQN#3*W0wiYcoZ{&I
zySPI|s2#XP@}H&tBgh4*{T1XCUs!w;L&eOoQh!>YF?)n%DEXE7sR!XmA^aZTV|l62
z_C1?HcSKHo*;tP?SB0uvx*A8urzS?fz7?LV>`TyUz_I`ObTy#S=twN7TFc2nJ?lfI
zbWUW!Jq%dK`H(L7OispExZK$^)cR_<x7~iVEVkTPFyDM&iW3@7xA7JzD~@YIwrVg4
z&R?r(3Nt!2-X%~ux-*;AM}(t0ct^iXUHs`>Wmj5IkO$KqZiU#{iuf<lp2%O?X6Q*6
zlny)6<B`J^W2a2F9kg5y);tZaZ*JUX%&Br!$9v_@z^e_B>vHf(y?*=Y)H%y>v#s$=
zPW*qGmes_9s!Z-86%DbPV$q0#Jnn*>BPyI&_x0Pnq8iw`-#bZ@8CscQ_Z>hSe>GMA
zJ&|Pd?p(>bf<eLfgWEr{HR{Pe0B_g&^-+aFq!WCgyCLp|I3`d<s$cbQmpTY!PA5eF
zg|0<8LJ4D#P%i(>3TwaE%0k?1VL~HTmy%#p^no_2#wtO`1Cl?Tj7Tp0au6Th<FO>U
zO;dm8GGa>67lMS$PIUw8N-J^p{U^wJqW;CLaPh+XS<PHqT2(2Nhu%nOmXU?>`2wdy
zx03qarB@oSS6AZiO0L_niwY4i5OvSU>5J=_9dS-}dy>HCMl9Ly6h6k#WH{qctdcLS
zvOQP%1hhDioo;{_$yCt!{k_9B)dr0K$NT+QKVsPf(e=GDC5y;Ay|%Gp`Va<{eE(Pp
z<?cU0LyGmUT8M{t!=l9*hiPwypL#p11eOI#BXhdV>O)$rbkD{fyPT<&k>$HFok4M<
z$!M{Wd^xPb;ghM0@u64K?m)jJN%1Mv<+G!=&9uO7;%Gfe!Boty>cfx^`!SZrx_3>M
z=nq+?lEZV<Oyju8R&p%iY)+F6)0O<AYdUzjtwYkif;f8)hSadcIhVhcq1ri#8+na$
zMA}P+lS%{WG!R*Yovef0wS~?Nt!ZHBq{p)1z~SNFxbY*OevBmR4Lx#s27D5vXhy}}
z^l5Y<{gULAt-totTh39+Uj34Kq_yeMAk(Z0k3)<4<di7<yxMs4{7Id7fm8O;`k!Hg
z05@vZ;PJq=uq_+L-Td(AIp-w|_J5HTn{o1@L+|ONXbLK5Y_zvxFlZ^LwB>-Di9%w%
z@?nSb=Pir(9d7d+j~@Izewdn_Sn0ED71rhaD>T%<2ce-KsXz%-`*htX#s2nt_Lx12
zy5hZYtb)!rmRXI+r07hzeipp_lUK3O?V@KF4E%?sHWL@boJ|q$r28li&(bD$5cSq=
z8t7StMXsrU{NI!oqi?=)kyscehN~OVAqm#@>>Jbk0ijp$hJUJeP8t8yJL4sdqswYp
zd+X2@afOx0Q&c&Vrj;|5yu-O7=A13SwsYzZcxe8CHud1!+BvmSkcSOEb*|N*`v?~`
zdslt20!=@QK}mM{3(j%h3VWRC{k`YLrW6QFQh3d}J`fJ90nzE5**(%ygNpVCypUlw
zaMC}Dd+*TcSD8iwTJ{DxGpF$X03o#t=#A?ZYtE(Gz5n4rpJ$u(6N8|5tvPCQQoc4o
zUy6VIg^>SSRWiiP$WncfUl#9jNo)NdL{O~DcI~bxD_73KE$pkx&vQF7qq=OP@@?lC
z7gm&^vJTq4hB)o5b}Io=*ucG%uELj2)+`Ci@Kt0i(=(6(Z!vle_QMT%_RV1oaS8&1
z82J-s2NTos6AA!LxQyExIDtyUAP0Hu+dSl)`qAb%Ku>CWa>aSnrcS3`sO(1^X9|r2
zO5(V<?OA-6C?2rIfP#@&Ze8dD(rxTfxr1XBT!4FBh@i>=0as6BMM^I;@jf=$Fw8<$
zqx?~6%)0m1Ue>1{nH>&0?M_yW6|#4W(jAN}bYbW#mu=oF@3Yw9F>LUQ(1pN;718kn
z+oUA?wBihiyH{`$&*Q6@ilsRG0}j?4<DtX{-ylS#i!7WsCPqTLN=2SSRc@b7Bl6O)
z&u#8UT^Z0$p_0R;U?E6bjcK>rMILnVzt!kxQpM@b0xZ;^_Xwdfe~GC~dpXbm@ijlk
zj0*2+gJpAl_Q9V10+)&;$x7`z&*N-qmwriIdTf<(#rSgB2sc{3_~;V5oXvY%T+TGJ
z?uQ^W<#IkA)lh|Co@f~rFhK-HyWdW8ZHH4F!~av<U~2voH>B;Alt=+QI;9!<)0If2
zfSy<{y0|K9@L;+0b0q97KvQ9FQrwF+^jNVi`@LBvFY8rq)Gm$KDA8_g31uoUPey&2
zd+M-5_bB*^oWv9#Ujgx$qzVL@-qQcl&Md|;C1Y<hHL|p=@!qKPm(rYMF?1rS#Zm5(
zsUaLoID&iee7E@UTJOsUrd7(R7FSEk<w0wh_y?G1NKCSYy=j+l^k2W`aARntt%eJW
zPMGW=%I`}#^_bYQ=7_DzZ!`#Md7afF|LUG5aRI_AdYWiW_E8z(=J=k(Z1{@ff{3(M
zq*x$?PmG9bEKSvf2e4Mhx%F(_WhHBdoxX|PlKOc&hAqkiSUnyJd3hR++aA&AIPq0+
z6%d<_i}+^A**6;%;XM9o*+E|xquZs}N_kRHSD`;T|HVj}+vHE+`iR*L(z!vYZ}^-E
zK(E76LcpagkaXqrTaA+yQJ+-jhQ3WQqN4KZy7~&C@#?pX-8Cx4S-djBbo*c$tRBK&
zHFMF2;RPpbf$@MP7i(nTEndEvXgT`4dL`F0CQ7JyZ`XZ>LeRChp#K$IotN_sU721H
zwTw%O!5}CkICro19+wM!+^2M(9_dDSrwVKq6~+_*>&LICqCxi_@Z&7_HOZ1b$&yLN
zeG84$%Il7?<_=C0v^=rp2`fhagWvYwQ^Gl;qArX@^7Q9w)GndF_<yj)Im4_xpMBG#
zfwd+N6qE@+L((M+<XMB2P}^G?DaPY0uR;acZQP=AS5hy)tIG^_t5)5#R%tb-)8v?q
zGcm{)Zg@WLRiJtZ&&wt~BtHK`wthd1Rs=h$rC+*6IvUM*m57--JWuqk@EtO1Mmikk
zQVCSb$2JkzYrFhZY&sEm1)Y+PQbdvuq1=zbfR@wP@5xp0j7M*@jZvC=Ok_*y;L5*H
ze;;K8sGk`^n)Bwb9ljjN4j|_-L)b}>_EZ?2_1{;oCCO_o_PoMu?18yJ>qrvlRc<@t
z+S1>#%-1%TSkst#zZgbF*uMNTc6;x=?d&LDTm0vtr0V{5Lvyt%u{LI>gB?ZQN;OLF
zsyrQ($h(*)m{1T;6yqp(TG>YmeE+IL`Y(RZg5)biV;b_*8;V`_2N!Vl-;+z{gbdh<
zG`#_PDm;DpNW=g1pb9fvv6QG;9rDs}Fj?y9G-@)3YO3qJ*z*<2(F+7eM@M0Ibo#Qg
z-ufL2{6}dhi0pHX?yGNL2lfwJV0tN590kRm4X6O0+mCWihbT)_GXxVEhgJShMz2Zb
zLv*mFW(f6012zPhfB(6!aJ*{-ct;j|EW`0krG-&Oko-U8IJi0gvc%6WJZ=aHvmhR1
z$G*Ch&eh$>OP0j-Cwu_>!awXs5(Fb~3=2zU?A=mc>AJUl+e`9Me*?6?1T4zUV)Wx1
zoP$)aY+MQ<yYv9QO{#T_0d7?vqPT;ujI0IqD)k%@t>!rVto%rd53LA`nXuxhKl}`U
z?xL7|cyR~UvQZKgt(Lp;%NPj>w;RT38H6MUFDO{4q<e^I+Hd};Hd@<RrqD`B%>0?#
zO~5dSNPQ4>wx0;`$ki(Fle-fEVBfmre|dLEwHizQ2dIU-ZW`vo{vN2v%m15@mW@hA
zWSH>ElA?$IzZ~VBOot+>udckzWDd?*GKMR2TB==E`3co3DbpjdLSB;LSa6B*LsvWE
z2dAY9{p<WDH_7@~FwFxy3Y`R_iQE?2^LR!y3aNq1hnk)j{{Z|Ll;)x!gcr+WC-Z$!
z+{+^-`|VP+ow#+W1d3b}E~F?fPly2pxru>4`$5mAS8V(!BE<K-4IT1ucxlfs$J{x;
zBVg@C@(p*HZk98SAIOhBp}o0XT@=-oR4muxuK4G(Xnwu2K})?&%8gk#S$q2feziu;
zt(tuW{)$M#f{Us2{#WYu6_#)PxvBHOhECqY1oK^dinMYC2Nu@mO97<fAPpqpGUtE9
z4Aiwu7pS)y=2lgR70neT1>OejOeIT1w7+c>1PjIfe?Vp7jEL$O11=br?3c4XSIfWr
z!>{}cfEpqv12-PH+)%|U<FuGW6NKO+2I5`c^J^7vaqO-1Fi%pMI6ihHJdGD^E_Qz)
zLlrub1C;q1IP0?#{m`1j&yH1FWm6M{8$;a)W5^IW$|?e!MN%{_oy`RHVm%LBa=;9e
z#au6iFa-Ur1UQs5d9#=$BVy-F*jrDQYm`DLdWB4neycrh=<DT#nnyAQF8JgcA%j$P
z_g-D8+Dl!PCawA80G^pr!ptBrs+yfcd+G#*DgQaFtYFF{Li%5JyeWSpMKL|6l;qJB
zjy)coea3)TfUyg$pfrJK<vrZ%2`1}+te@+g$Qg6UWT(VWZ+z%cu(K9G)U{2a0!j7B
zMjo?K6n@&=dK~{@kjdmltwAMQl}x0a+s`k-B>P2MzyXpFU329pXv!+ZT3MB|DMb~~
z*sF9DyYy@kryNLV^Q1wVC9XXpOR7Uv?;4ZK@K`F$0lA4{Mdg3Iw|oIh+OJp3FgzP5
z-iX~ZXflhP`busn)QiTzm;G!x!iUb!M2wF_vhN@GsE)_?O0|jek*}Z8HjB}1vvHE>
z=;(mmQR$``D)qfmA2IQ5iF8~1sg-ZTK}R4;3&U7Gffm-tIMK#A1(+jlQQ4!)1E(<=
ztm8Ieif!ME1+CqlnlCF^_9VuRmnB)?&Nnp_Bvn{94^vOQ8#;$f^M8ChKiyrd8#nC)
z`<&B;Ow>>Yvx)u@|L;6}&!O1|oWW6DV?pu*QbYnBc>=mRIt9|pw*RCHRryO73YZC6
z)|hFNZatu22$adaBu0PZfJ6TucD?>RchWYM(=ekEEeC_7hOd<-biiLI?A~)Z4T>ab
z8kiW}mCd@XlamvKG$8~A>u-;_-CsGgjars|a<KUwc$4A)C#><pTI$|cYCk&f+7xly
z48MLDNaBd9^DstH(!SYQ53yqRXxwF2CwoV4T=H;kInejpFJQ3F)xleGU^U}9PVXJB
zq&}8kMx(#ZlL3#Urg=wfbv)h(P6t<5c_ec$a>*_$w%Yut<D$eyFWBaMF8(IXA(tg0
zLh*-BZc?R#ZuZJa9Tc-(^dnFXYvYLJe=+Bn$2ama;W8`yImQ14rPRx}e91XThKny=
zSf0sA^*b9SI2$_9*9BhR^j6j$yqp^DXH)!x=$C%XT_eM>@y%W4i(7W!F%!oVLtS63
zA!7Pf{^8&VU3|s6hs|EZRV|0c?e5z>;;7Z;7)9awpZyon#I!<d<jkcW0^R+<pv!fy
zPk1w7>z+V~9Z#litslZud&m!UEc3PD;A0tI|3U2W;T^uXygIr}4ztTcT;G~`;!Egk
zI37ka-wNba5gbANr&J41jv5O7+LH=iLm>WzDV^)j^=X0y%^<pfpHI;^;&hytwZi{e
zG=SUlkIldTcpCbLCWt!U1Me}^nq$;nP2IQFpOe34dC$oTq}?7r-U|&2TlsVb|L8Q9
zSLD*XE%femrx^x*Me!3Z{qpw?RV_9FD+5%ZM8aJiplmRDk-g$F1OBh>>!P9qj&nco
zS%+QE9lv+{`)b#}FXCUy8_bpF2`npp6Q6JQ*8a>;04<n%nM9Z9Bwe@7yXEvllprvv
zv0bim@9ocET(IOMjPqXCK+x`&SgIv_SuE+IFitw)vH_*|Ih5lMG5g(Q+$tR8+m^;9
zbMpfM^E}X79VtJDPfr9%pW8b%MVtNBp_43X00(M0QD(L5{ShJuYwSnSFIkz|T(BR{
znmYWefsN||VvyjdX+iaOGWXiJHH|>*<iz)GSm3q$MhcYOJ~h8zJ6}{8$Z^nqajuqQ
zA9Ah0I@w4!?Uz?2%L5bBZc^~fHIP99Z?t`jFqcnxRpRuU_sqq+t8Fv%EF<S+GVf@4
z04pC9B$^5n6W?F_+_EC?HG=ck{Y)Smnanj?fSY;Z@(KQ|-czMGX?WbvU^wQ}nl}Ld
zsw!@4lhhCS7<i_|-C7!Op)v6MXYg;loU_rR@<kSwI2%=9Do9(JE!`Pw|9g-u*Sdbv
z$lwqPHc&K8t;q>?k?#Ep9T%lLn_pgyxHaGTp`|~EDed>l_@}mGnCe&#WIl24+v<gQ
z5SMkkkR%~4#%+BkuW?v^pK2W}LWRKh%MYoE`j8tC^}gpgSQb~4BIl#Q>`;VMEX{*7
zBR0=$n7iC_cctIRU$U>6>HSt?#m)7WU+fAdt}m)->lZ$&YSSFwQ}Zj)&l(uac<7`)
zp0r5~tjfU4e}$&SA9G4QSpG$mu)V5VnFD!De@@5v10>Q<sf$^V-lkW-ftk3w$Vrh|
zcMjWc%`?U{Zo-#+1k68Zh5asxyJx@mku+1XvT4I7`A7$*OnW;I$tmjkzWJQpRlAra
zeSbkZ?YCDTNn7T~055psPe81zN8S6O$EAKNz*NeQy};LqJN-a|9=<s(U(bV=)(<(W
z`Wc@oY)g5=OrLh!%kbSN8yy5c2oHRUu3Jj)Q_d^0MyUckCe9G-2_n3K{Xa#M)Jg)p
zNV&O*yox(AJBJv~$aDCcz5Ma#zhkuxKe$Da%6DGTxSe5kF<{@!cJsuh?dP$Y-=l@y
z%d~20icrDWy4c^@=g}GaqsdZJ^R@N3%WOJ&hb;^iC#p@is%~lXqn@g}@s)@`p|L2J
z*8!A2<9_9x$TFKGNbl*D(N0I@=uBGup2R|Zy3&8DrJ+z3)W%BG(q`Rvw9ap_zCW4y
zg~;Irf4tnE!|nXXc;KHB%zr41L80^*PyBN-KguT#9Ps;J(J>%&G9X*mX};AT2AtSn
zcM>hA-vaw<eo0AQ_#JYxA#x_^C?GbA2oJyHo+WJtG&Yqp(ho9$0eQ^x=Xkoap5rDX
z0KzLS{p6s?1%fwtZw05(QoXm!$q(La0Sd$@W{<Y~vIdL<6^cKjOi57dG`8-cs6YVw
z*I>VXHqkAGa<9Jd*$Qtnl8RU0k7T>1!Fg6pIf~_bw5VVEZorZF!^X!S?;r53VHDku
zS!f`>7wCF7!b-ck6a|~&u`YwPlfiWk<M~ZZQ&T;%gy<M+7oVUtZe{i8lIyF@bSsZ7
z8KqaxAQ|%V3}<Ufeb`pj*bLyR8wHfQdigmzPF9*-_c-dm${lpxQ??BbJfGEjx7U8B
zXLsJ}tZVr*>4^u#xyem*?)2Mr=VH_6^DTQ=%x&t$XHxPb>9Jq(#O*6~2v1VHey6^T
z`u%-MVdl;K-{cx~7AFTd$!E^wdIr4EkIO1$Go9kQ@1W<6KwZ11kzt}PuWJv;;)6NE
z!1FL?O=I%6<l~fij}f&KopT=3caS2D-S@B63V=XCH^t^;a)5p)=V|kf*i)r|L&3eh
zpynNc-yRPN&(-G7Hq90#ucgvWH(hfnds3jgG!I+PVvocTO>03u{VnZUqlN9mD5rG+
P{HQ3X%U9ktfA)U>O+?E^


From 5a8c3afb0cd2fb41e9a13eba444f6bb0850466a7 Mon Sep 17 00:00:00 2001
From: Duduf <git@duduf.com>
Date: Thu, 14 Dec 2023 15:06:07 +0100
Subject: [PATCH 2/3] Update maya doc

---
 docs/components/addons/maya-publish/index.html  |   5 +++++
 docs/index.html                                 |   2 +-
 docs/search/search_index.json                   |   2 +-
 docs/sitemap.xml.gz                             | Bin 826 -> 826 bytes
 src-docs/docs/components/addons/maya-publish.md |   5 +++++
 5 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/docs/components/addons/maya-publish/index.html b/docs/components/addons/maya-publish/index.html
index 847855a2..429de639 100644
--- a/docs/components/addons/maya-publish/index.html
+++ b/docs/components/addons/maya-publish/index.html
@@ -1490,6 +1490,11 @@ <h2 id="all-settings">All Settings</h2>
     filter_euler_rotations: true
     renderable_only: true
     world_space: true
+    add_extra_attributes: False
+    attributes: # List of attributes to include
+      - ''
+    attributes_prefix: # List of attributes to include (by prefix)
+      - ''
 - ass # Arnold secne source options (emtpy, no options)
 freeze_transform: 
   case_sensitive: false
diff --git a/docs/index.html b/docs/index.html
index 7d6fec26..42b3bd58 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1610,5 +1610,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.2.3
-Build Date UTC : 2023-12-14 13:56:54.954735+00:00
+Build Date UTC : 2023-12-14 14:05:23.126960+00:00
 -->
diff --git a/docs/search/search_index.json b/docs/search/search_index.json
index 8d07d8a7..a4b96bf1 100644
--- a/docs/search/search_index.json
+++ b/docs/search/search_index.json
@@ -1 +1 @@
-{"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.8 (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/","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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods Register custom event handlers The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions. Fork / Modify the module 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: 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 . Events and handlers Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information. Adding your custom handlers To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods","title":"Extending the Ramses Maya Add-on"},{"location":"components/addons/maya-extend/#register-custom-event-handlers","text":"The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions.","title":"Register custom event handlers"},{"location":"components/addons/maya-extend/#fork-modify-the-module","text":"","title":"Fork / Modify the module"},{"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: 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/#events-and-handlers","text":"Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information.","title":"Events and handlers"},{"location":"components/addons/maya-extend/#adding-your-custom-handlers","text":"To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers"},{"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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything. A typical Maya prodution pipeline This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case. Configure 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything.","title":"The Maya pipeline"},{"location":"components/addons/maya-pipeline/#a-typical-maya-prodution-pipeline","text":"This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case.","title":"A typical Maya prodution pipeline"},{"location":"components/addons/maya-pipeline/#configure-the-pipeline","text":"\u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"Configure the 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix. Arnold Scene Source There are no options for this format. OBJ You can choose to export or not the materials in a sidecar *.mtl file. 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 world_space: 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix.","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/#obj","text":"You can choose to export or not the materials in a sidecar *.mtl file.","title":"OBJ"},{"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 world_space: 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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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. Known Issues There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves Features All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu. 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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True ) 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/#known-issues","text":"There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves","title":"Known Issues"},{"location":"components/addons/maya/#features","text":"All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu.","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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True )","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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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-synology/","text":"Synology NAS It is relatively easy to install the Ramses server on a Synology NAS server running DSM. Prepare the server Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin. Install ramses Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Synology NAS"},{"location":"components/server/install-synology/#synology-nas","text":"It is relatively easy to install the Ramses server on a Synology NAS server running DSM.","title":"Synology NAS"},{"location":"components/server/install-synology/#prepare-the-server","text":"Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin.","title":"Prepare the server"},{"location":"components/server/install-synology/#install-ramses","text":"Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Install ramses"},{"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) \u25b9 Synology NAS 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) \u25b9 Synology NAS 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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. Develop a DCC application Add-on using the Ramses API To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here. 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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/#develop-a-dcc-application-add-on-using-the-ramses-api","text":"To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here.","title":"Develop a DCC application Add-on using the Ramses API"},{"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. assets \u25b9 list of RamAsset The assets contained in 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. assets \u25b9 list of RamAsset The assets contained in 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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. 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 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. 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 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. setComment \u2022 string : comment Sets a new comment. 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. setComment \u2022 string : comment Sets a new comment. 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. shots \u25b9 list of RamShot The shots contained in 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. shots \u25b9 list of RamShot The shots contained in 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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 = None Sets the user who modified this status. If None , it will use the current user 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 = None Sets the user who modified this status. If None , it will use the current user 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users. Events and Handlers Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated. Examples Adding handlers with a user script file Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events Adding handlers when implementing/extending an add-on # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users.","title":"Methods"},{"location":"dev/add-ons-reference/ramses/#events-and-handlers","text":"Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated.","title":"Events and Handlers"},{"location":"dev/add-ons-reference/ramses/#examples","text":"","title":"Examples"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-with-a-user-script-file","text":"Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events","title":"Adding handlers with a user script file"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-when-implementingextending-an-add-on","text":"# Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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":"Adding handlers when implementing/extending an add-on"},{"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/getAssetGroups/","text":"getAssetGroups Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups. Reply JSON { \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#getassetgroups","text":"Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssetGroups/#json","text":"{ \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssetGroups/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getAssets/","text":"getAssets Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#getassets","text":"Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssets/#json","text":"{ \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssets/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"Details"},{"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/getPipes/","text":"getPipes Query: getPipes&projectUuid=uuid1 Gets the list of available pipes. Reply JSON { \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#getpipes","text":"Query: getPipes&projectUuid=uuid1 Gets the list of available pipes.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getPipes/#json","text":"{ \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getPipes/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"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/getSequences/","text":"getSequences Query: getSequences&projectUuid=uuid1 Gets the list of available sequences. Reply JSON { \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#getsequences","text":"Query: getSequences&projectUuid=uuid1 Gets the list of available sequences.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSequences/#json","text":"{ \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSequences/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getShots/","text":"getShots Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence. Reply JSON { \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#getshots","text":"Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getShots/#json","text":"{ \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getShots/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"Details"},{"location":"dev/daemon-reference/getStatus/","text":"getStatus Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } } Details itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#getstatus","text":"Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getStatus/#json","text":"{ \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"JSON"},{"location":"dev/daemon-reference/getStatus/#details","text":"itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"Details"},{"location":"dev/daemon-reference/getSteps/","text":"getSteps Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps. Reply JSON { \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#getsteps","text":"Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps.","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSteps/#json","text":"{ \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSteps/#details","text":"projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } push Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited. fetch Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time. pull Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table. pull (single object) Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } 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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server.","title":"sync"},{"location":"dev/server-reference/#request-body_2","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_2","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] }","title":"Reply"},{"location":"dev/server-reference/#push","text":"Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table.","title":"push"},{"location":"dev/server-reference/#request-body_3","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data.","title":"Request body"},{"location":"dev/server-reference/#reply_3","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited.","title":"Reply"},{"location":"dev/server-reference/#fetch","text":"Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull.","title":"fetch"},{"location":"dev/server-reference/#request-body_4","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_4","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time.","title":"Reply"},{"location":"dev/server-reference/#pull","text":"Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time.","title":"pull"},{"location":"dev/server-reference/#request-body_5","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_5","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table.","title":"Reply"},{"location":"dev/server-reference/#pull-single-object","text":"Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID.","title":"pull (single object)"},{"location":"dev/server-reference/#request-body_6","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_6","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] }","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_7","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_7","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_8","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.8 (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/","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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods Register custom event handlers The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions. Fork / Modify the module 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: 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 . Events and handlers Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information. Adding your custom handlers To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods","title":"Extending the Ramses Maya Add-on"},{"location":"components/addons/maya-extend/#register-custom-event-handlers","text":"The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions.","title":"Register custom event handlers"},{"location":"components/addons/maya-extend/#fork-modify-the-module","text":"","title":"Fork / Modify the module"},{"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: 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/#events-and-handlers","text":"Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information.","title":"Events and handlers"},{"location":"components/addons/maya-extend/#adding-your-custom-handlers","text":"To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers"},{"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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything. A typical Maya prodution pipeline This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case. Configure 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything.","title":"The Maya pipeline"},{"location":"components/addons/maya-pipeline/#a-typical-maya-prodution-pipeline","text":"This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case.","title":"A typical Maya prodution pipeline"},{"location":"components/addons/maya-pipeline/#configure-the-pipeline","text":"\u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"Configure the 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix. Arnold Scene Source There are no options for this format. OBJ You can choose to export or not the materials in a sidecar *.mtl file. 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 world_space: true add_extra_attributes: False attributes: # List of attributes to include - '' attributes_prefix: # List of attributes to include (by prefix) - '' - 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix.","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/#obj","text":"You can choose to export or not the materials in a sidecar *.mtl file.","title":"OBJ"},{"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 world_space: true add_extra_attributes: False attributes: # List of attributes to include - '' attributes_prefix: # List of attributes to include (by prefix) - '' - 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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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. Known Issues There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves Features All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu. 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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True ) 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/#known-issues","text":"There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves","title":"Known Issues"},{"location":"components/addons/maya/#features","text":"All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu.","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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True )","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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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-synology/","text":"Synology NAS It is relatively easy to install the Ramses server on a Synology NAS server running DSM. Prepare the server Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin. Install ramses Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Synology NAS"},{"location":"components/server/install-synology/#synology-nas","text":"It is relatively easy to install the Ramses server on a Synology NAS server running DSM.","title":"Synology NAS"},{"location":"components/server/install-synology/#prepare-the-server","text":"Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin.","title":"Prepare the server"},{"location":"components/server/install-synology/#install-ramses","text":"Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Install ramses"},{"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) \u25b9 Synology NAS 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) \u25b9 Synology NAS 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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. Develop a DCC application Add-on using the Ramses API To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here. 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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/#develop-a-dcc-application-add-on-using-the-ramses-api","text":"To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here.","title":"Develop a DCC application Add-on using the Ramses API"},{"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. assets \u25b9 list of RamAsset The assets contained in 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. assets \u25b9 list of RamAsset The assets contained in 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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. 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 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. 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 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. setComment \u2022 string : comment Sets a new comment. 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. setComment \u2022 string : comment Sets a new comment. 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. shots \u25b9 list of RamShot The shots contained in 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. shots \u25b9 list of RamShot The shots contained in 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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 = None Sets the user who modified this status. If None , it will use the current user 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 = None Sets the user who modified this status. If None , it will use the current user 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users. Events and Handlers Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated. Examples Adding handlers with a user script file Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events Adding handlers when implementing/extending an add-on # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users.","title":"Methods"},{"location":"dev/add-ons-reference/ramses/#events-and-handlers","text":"Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated.","title":"Events and Handlers"},{"location":"dev/add-ons-reference/ramses/#examples","text":"","title":"Examples"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-with-a-user-script-file","text":"Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events","title":"Adding handlers with a user script file"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-when-implementingextending-an-add-on","text":"# Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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":"Adding handlers when implementing/extending an add-on"},{"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/getAssetGroups/","text":"getAssetGroups Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups. Reply JSON { \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#getassetgroups","text":"Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssetGroups/#json","text":"{ \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssetGroups/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getAssets/","text":"getAssets Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#getassets","text":"Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssets/#json","text":"{ \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssets/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"Details"},{"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/getPipes/","text":"getPipes Query: getPipes&projectUuid=uuid1 Gets the list of available pipes. Reply JSON { \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#getpipes","text":"Query: getPipes&projectUuid=uuid1 Gets the list of available pipes.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getPipes/#json","text":"{ \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getPipes/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"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/getSequences/","text":"getSequences Query: getSequences&projectUuid=uuid1 Gets the list of available sequences. Reply JSON { \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#getsequences","text":"Query: getSequences&projectUuid=uuid1 Gets the list of available sequences.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSequences/#json","text":"{ \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSequences/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getShots/","text":"getShots Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence. Reply JSON { \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#getshots","text":"Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getShots/#json","text":"{ \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getShots/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"Details"},{"location":"dev/daemon-reference/getStatus/","text":"getStatus Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } } Details itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#getstatus","text":"Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getStatus/#json","text":"{ \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"JSON"},{"location":"dev/daemon-reference/getStatus/#details","text":"itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"Details"},{"location":"dev/daemon-reference/getSteps/","text":"getSteps Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps. Reply JSON { \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#getsteps","text":"Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps.","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSteps/#json","text":"{ \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSteps/#details","text":"projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } push Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited. fetch Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time. pull Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table. pull (single object) Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } 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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server.","title":"sync"},{"location":"dev/server-reference/#request-body_2","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_2","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] }","title":"Reply"},{"location":"dev/server-reference/#push","text":"Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table.","title":"push"},{"location":"dev/server-reference/#request-body_3","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data.","title":"Request body"},{"location":"dev/server-reference/#reply_3","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited.","title":"Reply"},{"location":"dev/server-reference/#fetch","text":"Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull.","title":"fetch"},{"location":"dev/server-reference/#request-body_4","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_4","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time.","title":"Reply"},{"location":"dev/server-reference/#pull","text":"Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time.","title":"pull"},{"location":"dev/server-reference/#request-body_5","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_5","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table.","title":"Reply"},{"location":"dev/server-reference/#pull-single-object","text":"Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID.","title":"pull (single object)"},{"location":"dev/server-reference/#request-body_6","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_6","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] }","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_7","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_7","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_8","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/sitemap.xml.gz b/docs/sitemap.xml.gz
index a35e229a5735c32d282361bafd037738ecbae938..9ad984a4ea4b8afd3c0067bc616d61c457f85097 100644
GIT binary patch
delta 15
WcmdnRwu_BTzMF$%G51C`6J`J-AOqb1

delta 15
WcmdnRwu_BTzMF$%8Rtee6J`J-C<ERA

diff --git a/src-docs/docs/components/addons/maya-publish.md b/src-docs/docs/components/addons/maya-publish.md
index 2f707e62..dfbc7336 100644
--- a/src-docs/docs/components/addons/maya-publish.md
+++ b/src-docs/docs/components/addons/maya-publish.md
@@ -103,6 +103,11 @@ formats: # Format specific options
     filter_euler_rotations: true
     renderable_only: true
     world_space: true
+    add_extra_attributes: False
+    attributes: # List of attributes to include
+      - ''
+    attributes_prefix: # List of attributes to include (by prefix)
+      - ''
 - ass # Arnold secne source options (emtpy, no options)
 freeze_transform: 
   case_sensitive: false

From 3f729165c0e5a38d2afce1cd9415e9532cf96084 Mon Sep 17 00:00:00 2001
From: Duduf <git@duduf.com>
Date: Tue, 19 Dec 2023 17:29:22 +0100
Subject: [PATCH 3/3] Update Maya import

---
 docs/components/addons/maya-import/index.html |  34 +--
 docs/img/maya/importsettings_format.png       | Bin 17888 -> 16997 bytes
 docs/index.html                               |   2 +-
 docs/search/search_index.json                 |   2 +-
 docs/sitemap.xml                              | 198 +++++++++---------
 docs/sitemap.xml.gz                           | Bin 826 -> 826 bytes
 .../docs/components/addons/maya-import.md     |  14 +-
 .../docs/img/maya/importsettings_format.png   | Bin 17888 -> 16997 bytes
 8 files changed, 126 insertions(+), 124 deletions(-)

diff --git a/docs/components/addons/maya-import/index.html b/docs/components/addons/maya-import/index.html
index 88cc5e95..d704c12c 100644
--- a/docs/components/addons/maya-import/index.html
+++ b/docs/components/addons/maya-import/index.html
@@ -1403,28 +1403,31 @@
 
 <p><img alt="META" src="authors:Nicolas &quot;Duduf&quot; Dufresne;license:GNU-FDL;copyright:2021-2022;updated:2022/10/11" /></p>
 <h1 id="importing-assets">Importing assets</h1>
-<p>When importing or replacing assets, there are a few options. The same way publish settings can use presets or be set directly in the <em>Ramses Client Application</em>, <em>Ramses</em> will look for presets and default settings when importing the assets.</p>
-<p><img alt="" src="../../../img/maya/importsettings_preset.png" /></p>
-<p>In the first tab, you can optionally select an existing preset.</p>
-<p>Presets are stored in a folder inside the Maya module folder. You can save or load a preset with <code>Edit ► Save preset...</code> and <code>Edit ► Load preset...</code>. When a preset is saved in the default folder, it is listed in the box in this tab.</p>
-<p><em>Ramses</em> provides a few presets by default, they&rsquo;re good examples of what you can do.</p>
-<ul>
-<li><code>Alembic - Reference and shaders</code> imports an alembic file as a reference, along with <em>Maya</em> shader libraries.</li>
-<li><code>Alembic and shaders</code> imports an alembic file, and <em>Maya</em> shader libraries as a reference.</li>
-<li><code>Maya - Lock transform</code> imports a Maya file, and locks the transformations of the imported asset.</li>
-<li><code>Maya - Reference</code> references a Maya file.</li>
-<li><code>Maya</code> simply imports a Maya file.</li>
-</ul>
-<p>You can safely delete these presets from the preset folder if you don&rsquo;t need them.</p>
+<!--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.
+
+Presets are stored in a folder inside the Maya module folder. You can save or load a preset with `Edit ► Save preset...` and `Edit ► 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're 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't need them.-->
+
 <h2 id="format-settings">Format settings</h2>
-<p>For each format to import, you can set some settings.</p>
+<!--For each format to import, you can set some settings.-->
+
 <p><img alt="" src="../../../img/maya/importsettings_format.png" /></p>
 <p>The text on the right can be copied to any <a href="../../client/pipetypes/">pipe type</a> in the <em>Ramses Client Application</em>. When importing an asset, <em>Ramses</em> will first look for these settings, and if they&rsquo;re found, it won&rsquo;t show the settings dialog unless the user checked the box <code>Edit import options</code> when importing the asset.</p>
 <ul>
 <li>Files can be imported as <strong>references</strong>.</li>
+<li>When files are imported as reference, you can force a reload of the reference after it&rsquo;s been imported with the <strong>Auto-reload reference</strong> option. This will fix some import issues encountered in complex files in rare cases, where some connexions may break when programmatically referencing a maya file. But it makes the import process a bit longer (the time it takes to reload the reference).</li>
 <li><strong>All transformations</strong> of all nodes can be <em>locked</em>.</li>
 <li>By default, a <strong>namespace</strong> is created to store the imported objects. This can be deactivated. Use with caution as name conflicts can generate errors on import/update!</li>
-<li>Imported objects are grouped in a transform node. By default, a <strong>shape</strong> (a square around the objects as a <em>nurbsCurve</em>) is created to easily manipulate them in the viewport.</li>
+<li>Imported objects are grouped in a transform node. By default, a <strong>shape</strong> (a square around the objects as a <em>nurbsCurve</em>) is created to easily manipulate them in the viewport. Note that in some rare cases, some connexions between the imported nodes may break if this shape is added to this group node. This seems to be a bug in Maya, and in this case preventing the addition of this shape by checking this option is an easy workaround.</li>
 <li>When importing a shader library, <strong>shaders can automatically be applied</strong> on the selected nodes.
   <em>Ramses</em> will use the node names to apply the shaders: the selected nodes must have the <em>exact same name</em> as the nodes in the scene used to publish the shaders.</li>
 </ul>
@@ -1437,6 +1440,7 @@ <h2 id="all-settings">All Settings</h2>
 <pre><code class="language-yaml">format: '*' # The file format these settings apply to. Either a wildcard '*' or the file extension (without the leading &quot;.&quot;)
 apply_shaders: true
 as_reference: false
+autoreload_reference: False
 lock_transformations: true
 create_namespace: true
 no_root_shape: false
diff --git a/docs/img/maya/importsettings_format.png b/docs/img/maya/importsettings_format.png
index 3302c64acfd3fa909edb031a5f63af3a3a737a02..efa2b717bbad713d34baab80df39012605e0e573 100644
GIT binary patch
literal 16997
zcmch<cT`i)zcxxox`2R4Q+h|~9Z?XGCS5v6?@E;ts(?tZ5m37H-dh5Kg7h9hO6V;>
zXbF%|-r)Cl&-uOgp7Wk{*In!WvDs^eJ!Q|Hna?xN=lLZ1wWbOg@dIKkEG#nBmr6QV
zSlCyXOZyH1CMSr>iwSeX_S8{%hE+AfxPwXH*(+)&Vqw)LkX%~fW70(LUK)8~VUhRT
zUf6x^B{rB$D@VOIUb=3M?=)<^tZb~jtT1_4SOKioE{^YByF0phd9q5I1h9T!m43|6
z>WBFY;QyNvdo1-|rbR>~{`JH^&)=ra0OGbbQCL`tajHs+dLPX97b)J|oB76dSj`^m
z${6*AD)}9$q#h9ghj{nE9G}sTQjd4)l0@l=pMA~Vzk107*Z(2i>XOkWM)afBQ`rqJ
zF7IKe!fMo9^{Pzgk!0lYs^ohQ&XC;>0z4!!{i0iJY#d(l8<%iw1~2#w9HH*3<*St-
zN+q%j?-R2_!2=cxGAuf0f`gQO7rke=8H+TsB4O2?ODJE|=?=G`pt$aYzJWoe@5)HF
zob!?+ouFyWHRzxXRuSyVa&z7{EW^smIsn<;=B_ereG8IDZL>Mg_S2lYx2zB>cui_J
zxViOKHZOhF0_^HS9#c|MZYVg~<Ve2n_6MC#s2Q-Kdngn{b(s`zsB_NouJ=Z-NiEQS
zW>}k-qd$G(Rv;rITWQ_O?!j~@d(WyFb?`mH!onh<^CGL$s*8)2H4|rGaB%$3pU+ys
zs7VM<fHuE-A<4}TLY9UXcPS~yr)r(1d11z&{Cw7XgA7tp7W(?OoYa_q=sgm+4uFGZ
zoc2uwuKZ3mGgOt7ltiZ&JO%|IiyxHB(iGafVFsz`>6xn6OCT@$PCvBVWi=bF0i7b}
zO!~bw!eFE-zhIVC?`<p74-FCSOC3fy!S8$LkFPgCYTMfkiqLkt;V(mi=HM`DxP|a@
zO#NPsLtmwIb0#Hv@*)Mzd!q~&B+jAcLAcCs-h?WDZ{tt^75;u;{-l!>`L&u^CO%mH
zI-VXgxcTKgI%8*^XI%EHS>B$9bVPs{=&BJ*ePpM3O54MCqe&9)p5h1Heua_MKOD0s
zeF~X*Uc!|={Y;KpizFhOxkB<Cf%v|9OLwGtZs5EM@q9-2_-TdAV->D;wCuP$f3t-K
zUkqAgKEgEB-{=hs?)%f|48ZM-O$j*6@!wTRs;aM#<J-Q0&5^XY89&)v`XC^0;>{Kx
z_f<ldxF=3x$zkbxz}cejQCfB2FaJ(|gp-%Iw-Frk{WyCjMginn3Rhmn%fK_?DiDb2
zjNi<u_k~DRZm?0~9t9aVYIL-fsNVfcy!8z-G~*d&l-4%LE`7Ry@8<{tpH$@vT{|wz
zU2f#RVw6V6*X=F(UYsc0c)CEri%x(+HDd@A1!+$1K}yB2Ty3jBV90rQEzN+FVTnq|
z?$%gODWhifl#N3E49;~6dbn+lf1<&)dobE$!50dE)IA&UOt%6G!IC`Ir$S<ZlejvD
z@W5{7Eha4`rS)~vzrC=2vYC5>L<8S>t;@D)W-I47t=t@((=!I2;avNjf6ZVENKm+z
zTnd28dHMJlD<Tit;Z2d9M{(}UrN!C8p4iZf5#I`S9N~R5^d?ByK`kT=i+61w@$#?<
zH&{g_s&S!yRNh&G?idcexq_O&ul8nZaR<`{dSZmYpV(C5->kW{?>E`dSA&q5u-v@w
z-+#5S=xhQ{1az8)xDXA^ikrZ;Iap$BBxc~KU56Bdw>n8zIxlq<mi*zY5ReyXXE2O3
zXi4VNu$j9t9Ww4$lk0p%umXB+)YuU)Q(<IHCLt=ie15dnzbt^QR}|wObdq(x2oJIc
z1z&6ckG2aEjNuXdLUfX|0**x8Yh*RZRzQ22AR(5|#j~*1R34((k5gI;-ZN(X{=a|3
zGBO@YV`Jvw&$;jLy<L`=_rCBgTr}3hmsKVc7U$h`$(3H{G%~6CNwz`fJuGzrIiEh^
zNa2FLc4XR77EASgLo{ZmxxpL6*Iw(7-`TLdpn%7ncK;4Bl5DmK-#6&=N>gLSem^RA
z_9k?Sb8BX6G{-%1qW{OU)DS*GGWX7_CWN{1;Y8i2GM|~INJC@e%Cw<{nDwVmpG4ie
zn&(0-R#lop6?Dd`+p6%+fHZ3s7BV;;zML2SCD)TBIl7U(CiW{!yK}RLaCq-2g<kng
z_Et}{A89q7ANp-8(A=NLPt&|@g5&AD8Qdc-<ZB8=Ta-40ZSiEp^EhbzG;Hq!`kB0x
zh0qM+?1qi;lG<i7FfE)MElNO1nUom0Z*hZQbHs*nuB}UpW%Rk>sc1JiO_z<^XZvxk
z4PW(Xky-CUy)z$K8mm6JK2W&ih`&@*a6?ZqUasC;T2z>U@7<sy6yDw_oMp6zR138;
zPzX$JHG3)wLa33g9+;I|`ZCN<oMNeeeI9y^oE_aUObfyp-Iw_!0{_;-(w49~kj8hO
zGYb01U~g)_`4Cf}cEGl)S(zLq0dOIB<=*jw6q`#kVVNSz|8Q>!ceeHBq5000q1R34
z+WD{o$nI~EK&sZ;Z}y3Jrlsu+v%X7e9&clI(_eVu@|2X?>i>P>&Dl=p%{AIC5mUH`
zRrP6K`u|X1{o%GyZ#Xm<M@u%zU#?|V-6QFO`9~cu`YL?)X6b0{I|T93*GwA%Z)UvR
z=93H3uN^xs*WzYdv^#@*W@E{{?kk{2MyGBty>zHke|H9M$km|e3eUk#=0Wd6n$>TJ
zX=#SL<zU%eY$+2{>2>?k7v8F03~uTOMNUmIn>tN8BR+ts!8@^`eP91P@Q{x?_@b|k
zaM}BzRc~<#?M<)6>UPNi&xhS+T)WE;k}y^wsglPjslO<yu$$BpekL4wTx{XColZ;h
zn$IAvH?-No$$vO8qy9_`dlBu^eDyZaZrt&-!w%<SWoBHa464b0RvH-xQH;o7_kMNH
zYTR($(vs;QLyUwb%`Q2{xKC|!JzO8|p?4UlfazQd(ZSNF%A9%dQ;gLTQ@0#r`B^$y
z|JpOlkyYrLRF4hKtLy#1V~XdsQ+AncPG5c=^DGlBW{Ze$!Wr3_r&}jmZtna*?-a&-
zL!WCny7&Hm^;x>sL_}b=v{aSCJDIq=&(+2!743u{F6cV-)u=EnirdYpu^GaHnTvxi
z?|FEbJ;Ho&X3KOr%q!iuQo~FNZi3kfj6wcPNdUm)eX$(7O%VP6l!(sPFE@w-|D9sJ
zt9x_x5Wcbu5qo1HOjr7agRcXdPCXTIt{WUDSv%{bo?@o|01d&F>gnmER+cYjTvCKa
z!-L2S+}~7QE6f!xi1SxI4wp*Q@2Y<Dxrq@7*Q@u(6?d5pX^Q3z`Sj_S$^?~?TTsx`
z5mUrki^T?Ddz1L(Q?6;a65?^2baO6Xlt(1~_#0zMWm7`XMsAHO&#LF|O}RT1GTfcU
zWD(pRX6{BWSi0t`*P$<$?#yqRX2c2?#V0GV9)Z+=f*C&oMMz>E3_fXqb8DKg?7iYI
z>%biz9;_)Tq@de{Sh;$#J>VO)gpN--1<8$8B%2&{;SM{vxF~I80BSgmY*5Cc<wtRG
zF|Q|l@Ai$(tqr%qv!kR2A3SCed2Fv*pg;110sM(9hfmnHFvauq*RSh7Evmzq&z~#K
zoM);UuR$IguYN}a(v+BplUymlevu7szCB-l|3*KRM{U05Ak?<(AWhPGpPFk+JdhLs
z@rd7VM2_=|EqrvUcP$01eG_UF>X`v%j<$|g0*ZVqG7g$!eHkO9%=Dr+KVCCbl$b<D
z^q>#>*5$Kz*L^L?M||g@hVYt6M@9{_+j@-YjLD5WGi>2=PG<`RdZeT?sYqGAlgv<e
zR(xx~CiRKfEuxILce()(c$IL4V-oC(?JFv_5_whD*w%>`bMP&OB;JqKVm3iwzf%)U
zHC16AgWo4zi`Wt>bL4#quu3Pgi}zLtz^aDJgugnm^>0$Sq8T>+*n6DUwal()ffHbF
z&y^i;AQc-QZ@l(h4N874ARqwgd{#tAaP?W5KWjPx%DAsMUP-YWpRZ?my^1Sgd6VvQ
z`R7b+e<6|?_EfQ{*%UcmjehNMM)w&0)BUhJrqnfHMFV7m3OwG3t^-d6jsU>w0Ok>Z
zxk8<qmI!(@SPsHY?9p~7ZJ6xKv@gyE8Of6lc!E=o6nS<a`CEH@av490uFo|Mu1w5t
zIALDQT^ZhZ%nNhfgGhyU2*{6%8G%V1!m_p@`dxR;tKSxf<!Y(NE_UY77h&1y7r7F<
z;;j@dlV{)Rmv#`x(3#^!Pdu3m2GwhGgO5S+D{;kp^2N&l{u8uoy|r9br%Cg|o}ou_
zu7%|yx<?WcKrAWtkrEN)@G`D$379WC*C-NO1(HL#Y6+o|C%u}R8aomlZAlV$6@ArD
zcIQF`WQL?gYH&d!%ku)4+)fW*PbSI-cX#%mdv_mHGjxx=6U%&thJT%ZI8UM{q1tRg
zvO75N+T4w^_2V#|H(&)VD>Y2jXub{!2bp!@Agr4$Z4}mr)Q5LDQ+>SOVo=d+oiiR{
zc+U4?P`V5~rI=CCgJMvKklWt{k-E=CB%xj)qUQ!)TP!&bz@BF~8{ZRis9^aa=)5R1
zMVnDuM($MjU?#e1f<Q~cmBOdQ|Fj?a1(vFp+I9}y+BDblPN|Opk$!(JGmQ;nZZr(r
zrT5MXYhrteM7O<l#4U@OhJO^hcP(W+KV5pAyK9oTt$$K-)-z2cq9vZAJ1dWb+8JqW
zcFsrtss8DSqV8fi+)od-8wn{f*ATW0rbGZ+JWCWcV*C%Zf+<hwf=R*>Og!W)I9rXi
zI==486<srz4J+o!=Mu|*itC2ws+Ss7-dtDE>ZRiDmRypX_W9qv|6OpLJT-iVdLvf?
zIKO_++oC)?oR-HP*LdK2vj$7<n`iPW&h0o1T5~SCserx0n@!=HMa`+8?>zTU2b1Z#
zcG#fSW5E`3+xu!7&o#QA2;g2EE1egl3kKSUj0!IE>2S4A+nTqd%9336_==HxN;B`q
zC_+*K9U12txMxnJE(Ao<5sAMp*yOa=-9c7&zCoZl4Y?jX+g<wjEksgx7zaZ=?sxiY
zBE|jYHeL=k^LRgkw#fInH1W)!XMGyaU{hlF;n$B}3}j8Se3m}0By963iVqC%c`0ES
zBj);Cx70Z^Oa5sh+qR3lb3HBqf^AW%9aRe`a)zewt^z%cHt)=M!6S7oGQYK<HCgrv
z0gpW8a#8}{Gocqy$`1zpxy@!3E97flHHFz^`oU=5VTlVD%5!kMYkizC=)=;Yd8uf5
z9_mr%;>-4fuOmAJq_J~)RyO75|JF3e+GqYA=t;8K8f+InQ)>TNF47Rk8aGmUo(=EU
z!VVm+qN*BAKd^VaG5AHsw~C(i^8orxpl8CHuMmIzyd9XH{gs&t0N5@UBs({kgggSN
z%Pimb5!^EL>GBn*ad9`=#4>bK)Kl5Eg*;{P`TmU|UEeLF!lR{}dOu*``R*zJu4|s0
zZJ7CEdRnK=lSO)lt>?459PYrKS<W*bN#C!{ON#UM!!Cshz!<18E#q^0^xX#{LGf1b
z0yo{R4)UG(y*IsR->g&(rptkc3di@&39c9u%g^fl8U%AdTB#IOBXIojX<>W}O4HUO
zMcor3MPY2-lOOy6x3}(G%yH))H6{;VaYR8yLt2;Hqme8F8AnPtP?<N5j5e(lZ0?Ac
z(=Dq1>R@ZP*$m~n@w|Tn?zi!1vd+g~zVUlp2~HZFWHs-0ivRRKcOr%%8~V=~Ijy1h
zkWgx&bv9nCV@pneMLj^MuGJ8PS;C0Tc>5W-fr$r1ox#!oW}ZGjv3B+5C`14(8>xeq
zf45a5yFE~?ULW7!|LST#pz#V`-E<&T4V0<-c6NZCo@>npKG6wIum_ExQQ^BOU}$7}
z+f*AZ`&m>lz$JP41v6QB)K?g(g{EY4KUzKFaDRWEL+d*U@4Soi?=7jRR+bHckt@UB
zIpGDGpO++#N2KJhj7Xit;ybNO{I3>ZBunvAf!*3Z$1;=~?r+~>%%NYlZNjIY+U}bw
zIkCx0dyyH!^hNehPi<U1$zaDiMs%PaMO%VtPYPtAYf4J6LI0`nLIzvTz7%Cm^};-5
z6Le4gE7zt#56Clw8sd>rXPVt}6ppTO&*>Ohh7cY+O%k&x+E}nX;4}WX88MS3EaF~0
zl1i`F<k@a34-ZN_Tl(ACLN4S1!{{~HP*vGYr0xU^I57JF%(OIAwF8YF3Z|z1j#a-$
zsr}ih@to5(I{C{_ukb&EDy!;G+49*7DHRc<Yzd~{N<Q*gp#>T>FzXxmB6r1*g~E?2
z58>eGI48xz#L)D$UEPeugmxZg;v;x(d24yKKDfZnFz(Wqp@}I7%`@-%Ti|wX6(98%
zd?*0d`T4Vq&z7*{t7@qy4+?X*KbPk)B`Qmx{Ibm1<3X=HyVO<Znb##B)v?x`Q*|Kz
zczY`Z@5phoNIB@q_T<mxbfu!7>_I2n@B0l*45E$mQ!_yQ8ZE0v!M!$$%#VoN!hj@v
zA~E|20TUsGrqRjDTzNv^dmBS#r`AIob;XkiIM<o@@79}sDJ%@y<h?Uz6Qm~)9h*V=
zy>TT4`+acEPP|_ANAEaYCGCMz;(5*s%2Y&yWZf%*v=uWgar8iceb5XNJ>93+=3Smu
zXCc@y^a(9m<I)&dIO<6ZAeYa#H$)JR%<j^PT8sq^1TlC-8^X6jyynzM<jWG|QQWeF
z*=edy*zp|I!oy0}pZ3aChfBT=deg62u!uO1E7euiGzmkL$*4prt46l&BF-Fzg91FG
z5>|$FX`=D(?=TSU(X!?VjU}DflAfpXQCWJG^XtOmIjIz)qI=SV$k&^`3!N>9zbygL
zMK^iuX)rJPCvfkt<f2_{+n}IQbAP#sVA`D^XTysi7zNm3u2J1G{)`)O)NW|B<hP|Z
zEpv=iZgHOlVel8FcF<cjg{T)QDr}w4^x11H3+d!M<XsAx<LI?w2PX5@Kb!fMH`{qr
zztSJ8t9r2b9mnWIhbBHeHP6d|tLY0asSz!2qTAfWt?`8Rc@k9Lq<Y(yfsOS?zKfNO
zm9(bs=qt{~Y5_~-4_uq9UEhHU+$`vK2LrsXd=Pm<x@S&Ad&0x_?sqV==3oBI&9VOn
z8HB&ma%U-{rY`^|sGk-2OTqQY+M1_$dQbp3J<{k!=Sh+)KxsBmd#0G2_1OV~re?iT
zB^{;qwdGk5`OCAQ|Jai;2demkRd)1~xFWPvWq?IwPmy2bBRV2Txp?JUZ`CL{fBi^T
z%0WJfGg7YhaW;PHH}TLKSK+M_6HW&?>a9Oo0zbrTAJK(Sji(;3yi*Xo-bti?pdcS9
zp|TD}udZ%?<DB@V;JK+Tvi|x+N|Y|EPs%u9Y9UG_ZTRKA{hskj<u8pT*c&~^OG8<K
zro|_<iFNst+-0Vbf9L^{4swIK!zS0XL1%qylD-F$<eA=R1%G{DeeQ4mto5%#Hdpnu
zc}I~!9o#UV>G68=8ByJjw)}{s71PlzM&#cP_K=^$!DvB2^N!zi7J<K(#ny_5@0rQq
z0&iTqE~#P@WFvtBSB$^))hyf;)lU7h-8jrPqRj!!MoWWoPTii5Oi}yJ6I6`>WMAq2
z_+2!-sWc(baDVEc6%Iu)t%2xZQZrdA&%k@If^{$XPOE_SA>{xtEaN^4dhZqAG6ne3
zQzY_JQQO7YHU2BRp`Yk#dHdejgoac4Q_qLKi)f|m`=`;X_N-y@LhFOrJ7vJ9%!rNo
zMvO@j{c-=)^J!R1!$JWV^USAhr~l?m=;6?Xis!1eTaW;*zm-Eue;#^Qwc%tEO-%R?
zt#Bxh*>bp!`}ufV{c{Wtb;ZNrlQ}VBT7h(f_Atm{*TL{?3y7t_fX@eC^MJYQc%u>0
za1d|cvM2<<ENU!uOeP&rpYI_1@PXP+!9CsaO+q{kSM5dZ{&sWvyR7z2A{S$M6A<i$
z3d~^djE7CX`BYk=sMop9l&^xLt$p0g<oj+N<vdzr@z1oVQAInhYuQ_*PuW{-6Yt+;
zED+h!T^$aQyaJ8s??G~ZVC2gTkV|nDsn1nC0teo%frNa)WlbyZRW2Z4KXtM}osl-5
zTz$A{{?`=%%I_5pxDXPD8rZ}N<u+Ala(8*|>|E~eZMl4%R-%QBG%W4%f2sxBe&Gu9
zrzvvrH_pmvYVl@zU<%s4`miyE<pevW@^r82?#eR^#0BGZrkzogSqgb4hPZnIEm{|<
zO#Hv?`-@e$E2j~6K^ky*&ohtmt*(rh9gW;Xd<?6)fGLaD`X$n>WR(!?=(54%P(3r8
z6yt+F1AQL}f|>x&^0nOO)#VxxnwAPqZ+-k7lwResBM$E!3{r^DZ0w$wksf<gIg-!2
zAlpYC$(t)@|LpJ@m$$3bvA>IbvdwGIP(wy`*HjZ0ym6PH%*|l`xV6QT=-oEWO(MnD
zuKv(p4rV#hg<}gF?E{C9xiUlCT_-}FjW^y+rH(N%Q=w|@#&#*vUrM_7OorI?HOt&|
zfX2RNNOv(1j`p^<ZMNZV8TqTJ&~W`6UVFf&W4iDl^CWg5U&|#jyLamO6>M}HN+QnM
zY!4V1-uKzuOJ84<r#COWR=`(1G<{E%(7a>d>D%y|R^x_G@*_t}{fZ{y=J}o2i=qwi
z#X2z!);AClcCV?uW7@nNp2wdb?uz=rK4V?)_bh$uUk*54PWQ!f4p@_-L__WJI`(9j
zq#Jy7gvaq^;tB#1%5Jo@apB7X(ZOWiuj8zuc==m(CHA+fj6(ll+b^d(dOoZlH9O(p
zXV#mnNRw2hQ+V9&)+Bl|{kr9Pf4(N5%dOFV*~H%Qd+{#+q|PE*xKh|?OFh{;DH~tv
z_iKS0?!nd_;S_=M29)IPE4_#JPf5ZW^t@wQpHxO1d};bUpFTagP++_8EY*r&lfTwv
zS@?jQ-`I=r0sKo8!&LCeLCv6N(*z>$WK-ZcgJ9vYmVkR4(4evXs~(frx6{BSNJ~9=
zyp?YJqI2RO%})QeL2tL5cK(3YQ)#7nu<WD7%@`AJLqDc>v#}6@$B)rg)2sVkMH^iQ
zt|Kvrr=mt~lgF$bHT#C(tr|3x{;8|0{>vF~BFUb*#97zLCTsKEP;Z0EQ`h#;jjRgk
z!3MoEa3(T^?y>(3r>F755*i`8neV&D<zv(*==ZtpuV`jMxd2+f%Y|=_9@Cl>-wWJb
zt8h+bCeN4cDnG+)KSoIQ?V%qR&wVs~HNqCZo<w;$8y!!NN+moeOn7dW<VbQvfHZDB
ziU7q+ghY^pN-V%8IyQbEJ~O>Z=jl-{O0)j$!~?q+h}7`Yq2pnd8qOZw6i}fh`a|o^
z#MtwEqs6+PG4Qb0oKa3e3zQSuJYjq=atzvNixQcBghFa$@73@5Rg3!870(%dC(PnA
z>=qg~{AK@nLn+my!(SoYi|*nukp>hp`TTyicBDr+wo}_Eda~#BTsOy;qjZZdidF9C
zFT3iE8z-E=%p%ET<|=+V!1aa`$zU)k$)rES*X}0e54)BWIWh?p6^L?eNPr3e2S(5C
z$<zx5==Pgd_)W||w`|VW6>@xJ4|Ua4G9(GVP8EF)8d*aPQI6#-q88if0?xpBI2QM|
z-d!%6GfFGiAGdY(>5bO55zk8qdZ=Yu@L9}Gb{k)y!deVwq-|QKBAkztO%}V+#Gklx
zFnA3#dH+FnsBk-vbUCB#R#YBC*#yc<T}?+|PJ(>3l3vYptFZp~hac=TR6kpcHPf>X
z+GVm8ZoFVMFZ{x2#xv0S4pbgv^m}u2d{6Nm41kS0ujB!zWPy+EqnVoz{W}nm@;TKe
zIq{C!Ra=uP6jm+j8fvg)NT`r^UKZwS0tKdE{3<_b8@`^T`wRW}O0h&NTY0xb!20f+
z(ZhWP6Q+Du7D{dTwTM8e#CDR4PnWjAk1P(vD&S9@1sD@1hwaCO4A=(@I}(Mo`aMrM
z5>)_4t!TXur<2EfDiGmVDjLqF(`e$SNFv{%eIK7y`Wca<Z+bB;fC%sU4ozXU(XT**
zI*}w&ogN6ciU+d_4&%3XFPdvMB7J1A<7FwJtzescM*V|+x&<P?OKP|zP&Lgy&KYB1
z+HkXNB;svpKw54;q_=$Jk>mzN9HU31#T;jkGEH4}sFPHJpLR28t<pO$Jv?9+*@?DU
z=y%-fgZfi17iPP!sfVl?<#1`oi|lAkAE%W;GWm7+2&sgJ@fMap%9xL!nxy<W8Rs3z
z2xH7?wXLi$=+|p$UCcm-A?K$^D0}~q3FqS%8tl|!*zxv&?2E6e!8$~tL#22!MhP6b
z9akpxFCAeEBaf}-U+B$ZOf#{O<?#bR4q%;KQm{?g9U8;JsOzmJ{U>k)VN2eA-LVnp
zEvKz+XQY%8rI=GPhR?a6ou`n+E}32uZIjR0rCKTEPuOa~gfo!hiAwSp>F}cOr@fR+
zM&G5OA^_w+qy5tHLQq}AY*#yZnO#|fy<qc%v+IfOf)0#CD|L+>bdTwN4b0N^_X&@X
zmz<CAH)MzkemO!8GoxinX1?53!)y-9!L=XFZZy~K7YOKZO{hzvINPBfUmrkBqa_x-
zs7+9<53z&)G&m+%%rQQ^yAio~tOfeQAH^MX|CDQdQcJ;giBdzHbMVn;nWj@NZ3FC1
zJ24EQn;6(AQ2Cg;w}7BrqTvx&Ifg9``<bgiRLCbLOmwc%RV83j^Q+^}*;ip|j31%5
ziaqINAbjGxnq6Y=vypK+Iy8%dYL^i2guUiWm6`KZz{WsY2+0L+jhC%}=H;sW2Qh(|
ztcEGWx7r&_4q&wPwhVX1ip_$ts2Z|)KxEeUv>{WgvfwYVN5Ar*7DMn7CXDKyh~@pU
zIh<T8#OmDm=9N+Z%Iy~}g{TaKYY>%YT|GHf@0THV{cKUX!WEgmV&U^^LcAitGQ-%O
zV`NX}^Q63YiEKTEKQdSPPA38lG`dp+{o3^_hVK2rxwGBShu;@ho!tuu3b|bNK;SIw
z5)co`Xh&c`Lf;v)d31Y`?;1tx{4x=BC7Ak%UI*Ojc<ss!-jp`=-y##S3!DYzJTE9H
z=obw16B4rTa(8r8ji=B{>cU}s?rzxwz9r9UzXK?2(le(GfLKi~J4%L*;X7@&6rGRI
z55d?eiL%!-;Y_;#mdNqxj9sZii=}c>#0JP8(2ja-SE+TLW-Wr)+r#-!b}f2c_S$wP
zw>IeKsmI>y#->)->%|6XYbKkkX+ZmF1CzhTcoVRQ)~{_T7m@p|yCpJjY*#HJQc<Cg
z{ZK8p`G&@aB=|D&J-?sQ>u@D8J*?D|Yk?9WzUO|ea{XY=r^aXBxzEVl9u2ma;6{Kr
zFOjEZxP*NuoWUmu+5cod=TGp`<UZ!DIEhwjGRZs4K@=hIH@#He0VHwk3rT&y{HuQh
z)0b1?w^rtRj;q-Vj+T0=dYk7Bk;OvIL02i;A3WlChhyuv8V~Z$*aj~ug-XEPwL>Ur
z5y4MWKZ?!!H#SPKg%g5AYh7Td^<m`F#oqgPgi-y#ap^@eTD8f3*k8^ZWW%6?lm0$-
zvfz@Lm;J;KR*sxWv72kC)7h-@>)y)1(J|C&z2|H{^3`fA=gv|H%bzyi<gPbOSkX3z
zLrTpH-fF%i6$F)dKO!G_WkTF@vY&*E9&6j`$Fp?Sc@Kgx+$6qTyBG^AOgh#&;KTs4
zJAHe2-S5EuLw%YgOXD~Tn?HD#ys$g#DVL}41Jy6OjREylK#;t1(=w_pT?(s@`Z(+(
zJF=D<zp=j{8qw57h2Oea|AH?bQEC+4tjk3_F~6yCuYtBPO6D}^RPEk6@91DP*eO_!
z(>o0)Tf?ny@Cw&pNulI(qF+;Y(A#&Y>#;Q+FlN44`_O>}%0t|Dewgo2x|@I2Td4k_
z0}XO;qybumLMgj{Cr)1_WPWtIA|Nu7FMGLhP9%h$%Ko<fzz4}#xLNt;PspxSAJ1K=
z^m(NM;e1wgAoYRGb6*~=l<}9xS!EnA<?v@xo^n|WKM>QZw5AUL_<#aou=>~_I#%{t
ztzIR?pcCaqO`6nwo2N@kiW6e)T$FVmAl5*jM*hPcnwm4iI({xcm&3OWRi4N;rA3x|
zTrN9WSTbYwEQgJ{0e{B*T(FIY_Wc>e*&nY5Aiz#E@TsjKL|~CE{~~l+!`~Dq9^y{n
zj~<xXLkfgo5310-(Y&W<I~d_3yby*;x_aq~yd_L4{Y-X4tG=N!BbTLLCWL-nlYljA
z(#3iPoTTBshJKWxc4X{#;A{Zv2$^x235iH+h@Zs0moe*rJt-(i45>!W*f|^R<Q)|R
zV5sU#s-WH7rG&O`_vkQPO{^sd%)$$5Cz1A6%rcFgIk@w2pj6J`?AvJUd~Hvo`Y5@a
zydOy}{8)2I_*;+S#)qw=fNGnH_IB~-0sDZ}H&M<(XHBRozBME*H>M+2M7ABswJs}_
zF!~JN<-5so=0NU#hf_~@3X$g?!YEDe*)GiZMQ6<K`oM?n*V<cyoICMQ;nMelR6_;X
z_J-&|6u0nR%Jsg&4-&3&#?rKcJ&Ml^w~W&~T+jl{c=2oNKz9TWV}B|;yFLo<^gAHk
z0S|C}!ZIMddrL*5DaE?5xWrhy8v~VY#sC1-cF!(M{dBF&{a*IQcXPYXSyjPP7j<fF
z1?h9!vk8!hz*59VAl*|<mZ_#)Timl~K;AMZKT9BUXPuAN)Rp4<o{ut0_#s5TpH{hM
zh<rCkb4D?K>kW~<eYedG@NmMX{A7{~jMtMF3uDoLQJCDas-kxPB3Ci2D)aHV!B&AM
z&x6+Mr$~ls$=u7IQ70JR@~@AwU!&-bDQQ9uNiGT_coG`)-P>ixnrPn4fV<m>z)ib%
z#Z5+wfRJ|CUj5Mm7HqzLcW}%`z4xG(<(Zw!LJ$dL?j+;=abVCQN=pD*lrE9*=P2>Q
zV0rxjo8O{pCfPX3!tZ!57!<qk(cHwuHZC{_$=NWlT2<FEU)qN`e6WiPR3|5GC)$sq
zr}El+g3<y0OkRs0q2g_W4ah9nH^m1bTTj|<@r$dIMVow-Z;j4w<HeJ0Rt>ptJ@WG^
zN53#wi#yID893DMV8iV9CHCsW8<~qZkw;q2!VlZhDPGp4P^BjJR?9kvz1?j$Qg~f-
z5R$0^VkxQgWM4m03z-Z_8zj`5w)sYN=-Ngu9r{{=wz*1#V&-V-M;gBhzUeJrw5Q^p
z@uOIFC`hE=V^8S?(x)+F^ik{$l5&GKTwYu8MD3WBm9rqpe#PXhQ;lRY=wmt1-Ve$y
zqse=C!C9z{Gbn=C4^{y&boEm^r6QKH`%+psjR^e~Tm+0KnH|evmiyFx#LFcG{Ensb
z-Y+2<P2<|`YELuf*avHy2HAy)X&L}Ztv#M7DG%hH(dpTlN>Kl$Qi>X8D<zp>w@AWb
zl)8xXy%@6M*D%<)NRpnd^lB$B+qiziC!S-P7iRlWWjIs%BUjD)<8;RtT6a44*#?+6
z7y2oQRws)zVlLl~6)!|5-{)k%`0RenP|e8c9<7(1bGW|;1(UVwGwC|odjo8jTAjfk
ze}x}>R4`!q#1|R|6(>mLk;B(c*=X4o)&cP^9g6_smDc)lwe-f;85<?~V}O}`LKm+r
zj~QehB?PTk!jG+^)k8Ow^LCfBuv7#iQ&u$I$RBpJKGY<&v_$qmI<nH~Rw7(GJvc6F
zn|ji^UigzTs)ot-dnDUtwqEVHM2slCaB~8LswRdtC2%);d_dfK$sL|G(o+H2o4QgS
ziK*3%5RiIH>lSVPIUh_E3~>CRf*4m}u{tpAG|)xK>&ZM37<Pg1rsr3_zq1eV_o&tC
zfg}y1Jhg!zmaRY3uYh>7OCHm7O{06ZcSSD-d=YtVj*Tdz;yp>^O1h?3nz&Vu(}D7U
zghxPzV{InzfaYO-VES4*xPF?mhv?L84tr5E&8nS-FLZdW?IdfHvAEaAJAZMSQFOyQ
zE*HGSzmv)J*6*)x1~E0CZD%|uR$lvPoMCo##8nMCe~gGH`6DP|v3z}Z#P+Jl(9+Qa
z<C8pny?jl&XusshL!&l7_O`NvqP?Osrbe1@ngc-Zn~+>DD7DSePkp=SwW>@|)c%hw
zeoYYQQBYX@CY`Bpdsd2Cfq<}f3ETZjQAQM5kZ>jwpVGrz6Y#;Z4c~J>D{*g;eO?7v
z`)b`eX%MC?e1|xrh&4HrvvQAszmaah(#uQqm`}!ug&dgIVM-C<YB+m6CcHnXJ3A>j
zFIa7MpXg7HJeuFZ_!Zd$n95XDn)f_m7;DMM5AP$vwLR?zuq_pglu_g9n4v<i07H#c
z4?#mJye}Oow_9v7^-x<b)*8h5`}8!w+69{mLg6vnpssiL$GJO-KT0Rn-n4jB^hz_y
zk=H@2U;HKCB;I^Bli$SKp@!-(qzY}J;d4L`Lj}a+_w^J!wZ>7?<4`BAs6m(JkvFn3
z<_>xRAg{p6TBklH1po-PJ=Rj5pU<^0l!F+u*W^}EfKs$6i0a6mZ;Mts-z>`+v~4U&
zP37Wvd~}xUH3iC|FF6%^{QYuc<csC~=mH0&uI}{PZdUzBshXePd^?O1+r5d*y#D#c
zEtoCeMPs?gZ;Ik_L@<@J-7H{i-Y^p1C#8Wiba%yiEUu@<(VC`7bJ6S|vk1zQ?I=$4
z)NtcY5ka}hZeC_%kxU>fGOh1-;=wnfd7-4@?=p?{Ty2qT$fxHJ<-&o<;v^jT`8SDN
ztz^a&-l}paF|Gda_YkNf2;>PMgq&oH=BsinqB)|KRs(>7X2J!%*0i)@BR?(<!X<+=
z$+BhQsX2Vt$_M2m!Qp*Jo8uxah|uc%)>_Iq5`9MWulntzi`2=`NzH;15BdX8GiA&x
z)Vnd`+F{*nd&v*qFb8!dq5}t~Zs80A*)VV&Y}g~)F)mHA9-{^sy;Uka+LQ4&Hb{KI
z+@x#Dcy+Ei0vr7*HAyPfFFy75h>FL=oa9NJGf5EA$*DcOnJ+N7@Z;X(q;iRi+XRgK
z_H8o|#_KrkjZTYdkGJ-LhbM-%7LijI!?|t0WjD^3yPt_l2=ydOvET(aA-A|vh!;+?
zs9Qc9<)e&2cD;9G6bJiWUtQP@G5m=zT&n8}rl6=cjZWi(cb^_W3;O(-Qx^u1hAqxZ
zASYv<wwpsD*(tY3mY}=78t~qTfEzyWS&gyV(p?{8K3#zmt{VpMRc?jzcd=0xfBAjh
znFnXlQDe1EnMS=UE)+rT2>~#gy{|q(*K0ueD9_O>JjszArFD<V%lX%V!`>~YBMf#!
z=Z^=?<9|=1IXF1%xa$XjLWHIut&EKFGr$4)mw~YAB_LKO4i^jb(>`R<zEE)yL;bSM
z^n0xDyg!~bQYiwJ+1N<|#$F@3?OXykGy`wi2cMib5chI{W4R=TdrzwH#Gj>C_k@az
z1x@KzrKY6&ji?DPRQ{BKN`<uLlpzA2L##O|wIA5c4eCxf{pG%)16%|6i;F_4=KRTr
zMNULIT0n2kRZ7lB>Nhg?_26dFZhN-uxh7|;S$JYWs(!2-c{_c`II8V4>vHd9%NNw+
zg;ryu*hH%n9to(oV=NS{`;W~lFUtoGcs_m2jr?>>A1*(hnxAtc7;VCzJY~Cl*EA08
za=}@0lo*a{9-);w^TinGK>VjupKH0cZQZ22CLrtUC<~jE+-n#xms8h+o^?Q?BQc@m
z>EV+Or6b+f2`e0!WAEjUzg}Rr{{%1patUi>$I?AIimP@>Ps4cqI_%!zh*bayv3KyE
zrS!D}>f9mL!jrg4YF|bDa&R>?NKsM`N0)#qM=t;vW4T_8?cInw3u>K~<vn-G*efQW
zeZ9)g>(F5<M97|~l_fq*YKz1e3yf}p?K3Z`{>=7G^2%>fqU?myqhs@zeA>+4%e{P`
z{t~TF6EtxbAoN2985er;7nANS#m3FM*QWon%Du%(?ih8md@a#nxy}iD4jh^{Fe?|b
zF^G6@dMsTtY<7YNZVzm7n)4|rKw#}MZg`cSq58o~t{yJs#?7*_U1dGiaLey<rY5#&
zCzpHhe0|!6Cf`n8-RzqiGya^)`H8mdW;{2G&8y5|WNG*vC?o!ex0?Qj$d@%;t-fo~
zjdn<m?92BRTCTpEeQdhm)%r7%g?}*)v5^SpN<3-T<JkprnorE;DMMz^8gqOcA{^mi
z;t+8f%j{IFExN-9CxmgrvPNSU!t^g6@0vVh-@r1@lA?mx?L(0BTa-RasC<QAja#I-
zSfV$%TloeOa!dBFks7_g=hu?*sW^6<yrKxEFBPF`Bd;`g_Nec0bFu4KqeSMA40hH3
z%ezS3?>acEI9qWZ_;%)p@kqVJ{{G}-cazYkQ{IwemG6OQk;C$0p#4?RgpQ%q2WQvC
z*hPK554<6!$86hbU=$g{P&t`erPp?{#&D2=LF*e8HyfHmzVv(nd&Gzxi+b<%184da
zkf~lu?P&fhj``Z48?$~N_2vuDojm*go~*}czjoy;vXqKG(o%<loCW*F%yJ!~0QN6s
z9{bWv%=(iRg>qc)JS?9W&qT<9B>-9EhGnj=IIoV>9u`Jc7AltFJqy=i3CQU3Cs3XK
zv6}LeyVU}>X|&3<;ipn$nSFqR901}z-FT<5(gP53+M#EK6tJWEWgaAp5ptO7@?cbX
zmV>l@7#SAtF>XrS=bt#Sr*W2wtU|0r8jcez3L#}#Taq|^_g_97mVT1pHtZ&U!GT~h
zs_vd<PkbuvNc2%>{%q2vd35UJeK`$_p4KQTg(dgk$ruQ)l$knT)?ae;PGlGkfOVQ=
zEZs#@-_kK_QDm7>sBpu!s8aLGd-1J?2YoH#73PbPWUgw{nH!Qypyo}J%Ax`OGV=b5
zdN%CNl9#~@e>o(EDx7G1w(Z67m?V6na`{Y0Z9$Fw1iiHGqPbIfHP@!h8JB8Kn8P!%
zf!EO0h2nSs?L@xDyghAST_{?}fqCoPHUmc6QgP<q#d*?lX0!~|{^Ju>3GLLpMsv;R
z^!rqFN*dNNIno%EIxcPIJJGw(JA6Y2v7VM4-N|R)JR0x3;+n18-Gr`cLW_QdJ7p~m
zG#Pe3g89b_MJKsHNw|iQ{Xev)ekzq^L+tEI>^-jfm+)20qGhXs#uOR}W!hhj7Y5y(
zT*Dk*h2Yb2SQuW%0O}C*Sj$SQeNm)_gsuN*m&+I9Xl|EAG?<q>O=6v_QA_{J6Rkyc
z{EI+JF!ub5Y+Qt)<fmVxgz1@>G<;SD1N@|LgVfa2JOWET<I%>RmU#q>$>=1!n2~=E
zPuS(O$0Ew&)XY1ZeOyNE@1pF-6PbW0s})x@Y9|5QZ}K<$qv0Fl9DMLV5m0~f^v7oB
zXxN$Wt1($&aGN_&(6`SW7e?FQG6oGX8G{1tnX>oEO*(_W^&%z2XnpFK%1vg|TvQr~
zSyDWEI4Ki|Wk;|u%K9})J+xT^Aptwhd0Tl+pl+9d?Zn1@))%f=(|4SUGg&o(%YL3#
zrqXb65XL9+8>RkHqYX+&$bOf24qVIe#KQ$@d5F9aMl>`@y$f!ex#4pzE*ZVx60)4C
zg4rN)U;p@BP=5A3qA+MXs(s8c48BW7c7L~_9WB>0q2pQ??8b5b_j!%&5UTQ`Q690@
zQP9^O+wjTcwL(75NW6o>s0RY$Bqx%Vk*TzD93P|`nd|l?K;PO(bC3l_(Mko<5pu?2
zpyK7;2_>DUwR(U7>GZR6OEDjVtT&q@D*N1LH=9RomekQQ1G08u?q>P?ux3F@ap;Gl
zi)kKoCyx;4!lTbQJV6L>gQ!02&Jv`Of+!LL?;4CXCvak4HQ%eG&Gf&xx!yJZIFc9n
z#P`>$7zOU-sB*<;%CWnglXCooV$;!2rhm+onltv`usc!h-t>*Zh{M(>8%Fc@;M^y8
z^rLmuzp6FYZn83EJ=DH5+|{k_2fQSw)F_lCMj1VzpD>%`4f$?t@cjM*K{YchI&pz;
z-2k6_=azdL!T}f=-Yt359#Z`hurKI(@@LwxGOQsZUhj%8T|C!+mcFH@Xs$4Zg<C5X
zx2o#uAx0T@vZn<_I8^~?9fJvnQ+jO8f^oGYTzzLzJ+S>Hg^O2i7L#-#b3%Y%NlFd;
z|3HA@hM}gQPR!Zc*+t2EjcUj*fDXeM8&KO>X|FMUh0A|h+p>AlcbIjH!k*Rh>;8l5
z0{<_lHvuEbg1m_qLC3Fp8B0wlw;NQN>>g7EU6+*&Rwz60vvh+CbgI3MKY~`@0xnM%
zJV&iCL^CA8_H`HVNW^|b^f`}Mj`NH6@ah%*O)qVZOlsvamlFT<wQv%W@r4djwavhg
zDht_|>~%0vR{9^Xr^LeNO_UDf^&-nKQu^Bq?G53D0CzUpw9}Q`%$3uB0P8LQbT=L$
zeX%E^GzV2YDLEo!+Azr0o`<fL&X+FR;@%K=xr)KJ4w%W84r&mDt_jfV{*iyMBI^iK
z@Nn#-{L+J>i{`xZOxU}fZxTaaj*`mHE|kEGHKRK!G(MUNUrrWk>C^6s4{KDhx*NS4
zGL=w_2;0Jl38J*t{{v0U4CH)3rGwJ_r=1r2L$s(>t4Qvv>3pdb1j>xqC^-6ZvzuM{
zQ^nDQV<aJWf$0HLGqYh})9w3H$rM?3_3oZS3k*;1X>FE9U?;3{@Om99$@{>mX+mO&
ze9aHF&ht&aAKy28ggu-Q(x+C<m!Z_>pADEj7VgZn6N}z=9J%l|3lqdsS9@WdMw8mX
zDW@IJoC8+p)lPUfHLlslM)CVd&3~=L*GJVo`zI&g<m-164Bz&mxMf-~>ihz(W6JSa
ze2xa~JbM6NnO;p@)lV(8dux5)x_W&t*4wU<(S=;qM|7#Nz27>Dcv}TfN%fEqs!u(G
zoftraQ%yz8FV|kl>$c)pXxi=`9de?R?tU}3LxsCd`S7#6CKRxfQMXAj7aU*5cz-gf
z^m6^H)SB7Nh%CH(y@eme$%>7parY*OglcphBinFO&`K*n{ujTSzC6b=Dkk0@QIhJ%
z6IG5s3L1QaIAqVsa7`YK72AnR&1eGDF*Q1P%k@9bHO07DF{scml*=fVp5b>^2&acd
zYs12~etTA-`?czR9q-Hk#MAJ0MR9=o^G)-Ke&%Y4+U{)ibEWLrWN>r7^W!5?=Ov1x
z*{U;d-hA~UC7KO8&grF0;jX0bFtLi9PQSfrJ?4=2gdOxAxC7|~WNAKFSM{f^yECqj
zL8GD(`_SE&b<|SY>Yw4qMdJ^?F7$ot=*=<R=3LyQOc~$v<;s<EdEtzE|I1a4exJtR
zil(ql^60jpzrC7l*qE@Zhjz|feCTPRgf%bF0q1BJkdM<9b%OWaLRCvN?Qlg_DHYcT
zCW;^qzCZlo*145Rgdy<oLj(Z%=YInlKJ_YP|He=&7;z+Spd`g@fJ@Eyzfwue!5>57
z-T9w_Uj98ChV-_<Tg~M^1mHhqNo#JSX}CFOLATZZKd|@h<A0mK)n@)j0=Gl!Z=nx4
zw;?pK|K7;I0&uV}lFQrJ3-jM9|Ho=^JN*Bt3Gv_6^k2mFkRHnajqg|n{O!|!ibpXW
z?DG7#JY38n1M_k(Zlyn;-i9guZR&qYglPTKb@{JR|M#*4A2k2z?cdw~yK4W7)(Ot{
z{&|o3+d!tbVFLd|t^AE-`Ttxw=fA%v!555n6!Vq;x&7~Te>SKz7DHX5;aQ5T11d8?
zPDE8aSuulKqnS@I6i(XEmuQM8^!p>ND9rYmp%5&OAwKhJa1|(jJr~3U|4U9qgpw`(
zJ1zfxmi%v1=D$zi4*gT~U$=iIHr`(%``>iI|1tOeRnb3@YiH14C~2F%zWz!Ztg0uC
z&v58IE3eJ3U%y)3t>6$45L8$N^+gwv!_VfOuP-lF6mK9V?!Pde$l<#f+c{aR)pxYk
zS9x|BPpu&^0&fQ5U5y<8n6Icc<S-t_O{UH@CEd6a^nMh^BK#lcPlyq+C|0`Rx`f7C
z+3wxM%huo+njFz^CDGbl<D)5EEe?xd86FFHgk11v=t(K&X-xQ91m0y-h&{6(Uc#3d
zitONdb@tDkrz^6aTO+@sSb`iPxr0?>+G!V|yIrB$emBa?V#~;Rz9;9a6h~QQDo11c
zPEBm1%SrLL{@2CePoZ>#@1X!;MNR-U6X70O#uoK_Oqbwjl_D7HYCa#>L)myRpvYL>
z!9-HwH)UGJc#TC9>0H%HaCLPB2?**V`NdVc>fT9y8GdEvr89XwS<q7bisCysW(Vqd
zcBU7^H+5#}e`nggM*?$|oV3HQKrgS!U(0(2b%KO3>x5XJgO~6cJK^$Bc^RytJzr^z
zzk9X3-?$5NF4t3_T0AdmxSuT*HqUIFB`f!O26dNrIw5>I^TUfP%RoQ`%BVKO`z9Cn
zW-ZD7osAwj@$Blu%-1;;zuq#wXok=1xys(;>_cuu?wk5_uIc4mXT#vflzL0WMHxKa
zl@>kw)uom~lNBM=eJk`vqZCJPH|XZRE8sub)=~|Z<nJVRrzr6auVL<S0aYvMAFEY_
zAxKa$@wkg0T=g{CjR<yM2eccRmpH2M(iK2zO+6k^ZbY>iT>h3G6%z18xAUK#EwDm2
z*4;x;*-#%|1cPPLd*zm^M@FNVG13`!_NQ=gT8;?Bgta{-|6@i7C8s*<lnl9fYm8Fq
z&gsq!J!q}3rmyioa~!}tRcjFaYm;t0h3}wezj&{z2X|XOIWw}&ctQUDROL&hlr=2#
z#Cq>4U03fnR%e|Q<jYJKh5!qFYq>CNQc`K~7H#Ky(dozAeUOI)<zTl(<jFQb`NI)Q
zb`;YLg_msj4>a?1GrpYOPUdD2`Caq!E<l1Nr1H7a5dwLl&_zKZ)LXFW11iog`_-jT
z=3ewQyM6!BBFMtotcM}gl<?u!&G1=ABe}Bh0X={z(LC7s_)<ZG=~hMbLCo#zt???2
zF@$5xPEv%TLOOZw8fDXQ^rzLxf8SPFMYrkbPQHXVl)VqCzF^|YG!_OF$7E(@sR)_2
zgzy<webMH@EY}v~ALl31(pANBceS$<Sw2$8pJRoGheICUF1e^P^uDO;AJL%<5kh6m
z3hzXL6IL;C4|bRsKuQe`5xb$T3Zwehml)P2udwiE>}^P6>5B(v69pFhX4sfjz11p*
z$>Mp*Jj+&myq+g#pmww93vI-~L@iQk2-w=%LQ*6!N{-6vB?aGuuilzBn9ajF2D7s}
z5Z9QTd(>8m9x4lWt7R{qY>k?5p}$WHZC&_bVZt2sB-eQX(QC;s&eBcXY9ocrI~<B|
zZhx`>2s3BOSV6(6o3DqxsygfHCOSxbF)o`E%@h;7h*N$^z~vf?1RN8M9xv+g@$#`b
xna{<l(@ZG(X%??{jnHfgu;E~_c@5`=rHoLwa;Yk+?DhvARFyTAs-9Vf{V#&53~2xW

literal 17888
zcmb`vcQ~Bi*DoxQ5D}yy(Gx=SL?1PRh#n<+OY|OP$Y2N(g6NE1qW9iwMAXsSXhVWA
z7>pPtW0d!n@Ao<9d9LgCp7YQ7!`yS1J@?*wt-aS;pS3<hU#TlnT&KHEL_|cP^ip1n
zi0Cqmi0G2$H4@;;@X>ZEaJb~IrTCnve3)SaIJsgYt0qfCR24;j^5!aVPWJAlfjbcq
zW!J^urCygpOCll#u#&v2&U@2sr2jhxG~_3qR4z=1B}S+$MwNnR2A1>PmKXGpR;)tm
z)mGfYjJz$k$Dlgc`^bjJY(?EBmY{?PgJywZH(7fVRS{I*oVX)bK#~j}EN%ei@{W3*
zzDMgW@u3q@NElo12NWAk(>=}cQ33z(+e!-rj}EDciS?b0WV;)r-;OMzMv*Q@gmxq`
zWd>wv=V%*0(<@!iHoY-XV71Z{;f4ewKr#mj{g$iWKaqP<Wx2y(#T_X`T5hKYi21zt
z1?uV5DtuV%x3!_v^vn!iqxzXg=G$Zbr1SMoH4YCsG%`H=jvIvKqBJCAP>h+ne%SZD
z5^0$-_<oJF%*EzrUwpN3vqwLk{`7F(MekhqXn(&^M!0fcWOKx;9hbgG-my!*mvPkE
z3vpU%M=B8$5q&$(??hKw^rj(xb%mf7n%vbtY;54y6=gQ%6O0<16VfHT2KdjG`3E8y
zCDP=9$!8hFRCMr}oo?!(@aW7$9C}1zUf?)0^SCH8mI}Hqw@2UcoBm1y@TBcamoj{U
z8J@Zc=nbm4q};9EO2l#I=YG1(pPxa)7t&@aB4v92%-hE&oxmfgX9lf1IT<-`ZN->i
ztNVf5&jjY&AR|&ojZ{#K{~}@WXpRlIng#Oa&XZPH#C;>C;yFFTp8ItbbZE4JmCoju
z?eP2~%oWmFOg6aSFDJeJQyenxCKbrbL_{CzUS`sqpP*$bx^%4RND|K9AM+;rZuIVr
z7p<-sm^OMCob@I*Y|#NPnC4=Xm}u%9FYhfjZe(*YD`ze}4w`jX?F^t_o%U+xjZGEV
z7sJT-<G{<?prfEfln;O6_TPrp@&Q&!&zD5-TOF-ROam=crze942yx8$j@e`|_i-wk
zcD04Q@d_|9FZ|Dug$Mq)GMCvpl+d=#&Ws&`ZenK_Myzshm<O-MnCy6%%3<fY5>wLx
zu|doySto!{svVFD1)Kz&%(;6DFn^WxC+PE&kCG?5U0*x%oF{5IGXBIO$CErm8mRTp
zCi+EDn-TXnmZ}YcJso41PyVE-889xdHBLb$!1gNO^V1_ZpcRZZ_lbzidH>8xVB<M5
zeccS+ZCp)A$tMWqlzrP9ACF~#9MqnSh&m-QA{=9xPky8ilLB*u<iBTJe@Cad{<4a&
z&q?i8%Ylj8YMtP?rN(<kC+f*^8z+Uy#QK|Oa}}qCU}TOQ>xN3pSeuZ)SM&M3bJvuH
z{0&z_SYo~m*e4pHRzWzMGCNJ!T5Ox2&G%^OxKZId)ay^#TneVxDQI=-+y-8lzDmV6
zPsWv~$};0--t>Nr7k?Ht((h#o;^aSFZ9SQSyY#^e7UQw$Vh%^Pi!P_rE+CW95K2b3
z%T3R}{wzHo=Rb|TlLhJN>9Mr8A5fxaX09L!ZjK_cYevF*$w{V|Psf-+y&E4lQp)$y
zv>ksGY(QUj2<|dR?t6*;_{3p0j57Mi{=oZRpJ+EPPn;5tB<8{XCc4e#2fio2d(**4
zGt3&Qljz`LE^R@TX~(@`Cp%l3AkX8#lTA^777b<}xpv9(;*-oJe2fs2wA2FgNhh<I
z3@Iro3X1hHJ77|zcw*+)bm-AUVrTl~aCXFR+D=nvM4C|QyW^he4omQAMLaCLWZxp2
z=2el0m@Aac*J~gDpb7oc#q8;4e>xc=z5mr-YTs9AeYIVUi0EA&zNO<7xm;%3!re-5
zdy|f1n?}~DbKj7@O;1qh=ahvX+RHDb{2lOQ_Z4i>jYap_($xSI3cfcoa^BX56Rh4p
zng})BTUj~$>9IlPQ)`6ZX~BBJWRAz8#5+?Iv97-7ge4aQY~q8E(yM}ijpgO+no{1F
zx#!6*9CAEs9Jn_Z7Sb-3-spWzs?FLv#_ZR5yo}pqrTt7^oNatUE2wv9LZQc9%+XX!
z9_cqaj=Y-)FnZLt4!*v8T!90jwM{@<+@56vtl*DJT`FB<EkX{{UGcW_9?2(h(G+6d
z9ynZLz2AdrKHNb}5;zW+UR9*M=q24aTdbm+@isZUP?{{NImx{~8`#wZCjQ2gDKqE~
zXQlk!E5a&^&;VCczinXcWZDy)7NTR8=#d=$=TVBN!y_b{|1sj+gsJ_=1{Kxun-_n0
zWLoVLdeY)^eQ(2Ofj}|wQ|iYGvgI1EtE}0*E5i8{pe8cUJTOQ4JMYmFtLMph3CPO6
z0c5QS3rE2dQRiGx?fQLFrz4<C&l;2k3w6|nT5C?{Od)8P!&XY)`TNt}y}=m&=n8dz
zz5Mo5ue}D`IortTt`**;hJQv1XjYlQwsZYr;bqrOQBwlP_bHoy&zEoN15?aGeFd<g
zL@yOy^gaPjiRKi-9{~p~S#vU=lREpp%Xc#M#UXpSCKm=Y<!HyNBb7!4_?jE^?KW^I
zVyV2?mAJ0)Tms}J0<{kLd)Z0Fu6%cXwR7pr3GcLo>6~}eVnkvE-4GOudqHa*o!i^j
z;oM4RcGEyBbEtAr_nt81SS2%Y#D5VAMJcp^#>4j#M*O=^Xn}V)bYJ)S<e-w})L-h*
zvu}9qprGD(k;MzT)_@XZv=jJJ9M?O&T~110`wbYuH~zeD;}kcL&jvBeA`j+*s0JuB
z{QI5yeKqCkSt?NDPQOpaCn{#Qw|5bF?b6B^%j?46<5)>(m&q;U5_=TAsR!mXfi~UZ
zGcVA!<+5jbjfie&>VoII!`^bZh`#UdZb~o|;RQ!*=G3aw8QXs=;>{QRjQ775*E@0e
zxL{F}0JQs7^WEeZvT&9l3!Fs%xK0AA=y#|<vNRyAQ;(fn%E+7Jh{0hx^XTA~o!EI(
zAI;WaJz$_8jRJgl+Ctu$#uaqz)h1o>Y6<1)q9;`wJ$zfhv`99|`R?2*g6x^gJLX0F
zpvf|WoG~Dzn-%CgnSXx7M#fV{NmKhJwjSp3D{+n72HspsjP*NeL99q!h*+Pj_CnxU
zPJa(9!vDzqYQTRJcRepJ@2$UD!T2BU>IgBgKyd`mf!BzGdEqRuOQskX?HT^F3E&Ml
zD4Cg=`I-X;;KCCz`Y`Q;Y)<%jo9KgZ@f&l<w)q$tml^aB?nyq{oQm~(DYEYzC+PmD
z1<<KdYC3(lsQ=ap9U)qM%E*D$)m&%<JR=RsWdG^~{mvcs4cF#Oy+pPHJH-+-Fpf$;
zHYy%>A4^{$j=ZW{_wSD(l2j9%=BTyHr);u$x_@ilxePq@Q`xqfyOjquYCewe7Net{
zQ`lZvI#a4C?R+zQB{WW;T<znWGF@`P$U^BLh};>oyuRM38i{=hg3QAb)8{P?UF!+N
z<3HP*nF{X!a|lyn(uWmTX2-h+mYb)EiivXx{HlKobL$@ETPcKk5PmLvbON7f*T6rL
z-9*Crs@PNH-F?CY^i72n#T{aegdmY>Aj~f-D&;DDkyLOCY{Re}YYYbi9o5$mP*G9w
ztg70ZOuF+idA+(^_+8(Xl%QrOH{-CTw0&N3o}9z6ZFX~R$QzSu6yhA&<49e3Cldw)
z%NR-QT(!6a`sxQwt3<0R$;UYX(-S=xbM)Z}uOxLj?|Tca*zCI{Pm{5xin!}h#Bo~_
zJpLJVy1l6H1AOrK`e%GJYBx8q*Udt`fkvfJ-YYQKxxK`=ubqwgZH3U=45|A}@Rz@>
z;tSYwEyvx}-D2G@iED5?74zP=UDjI=DgzqDuVq|6VzM7|Ufz>0L%C$LY2EO-*>k5Z
zs-8~$<?Q^<m1uVXiNv)a0Zl6(s*Uxg_^mrTnuL54jw}$}W9Nm&r@zC2jpN;;eaYQ#
z#44KZ0fKp~<3Hjf%O-SRQrwGce*Zgr|LAC5n21Q1Nn8AKY~pf2Hr}Pcu8CEvZ*EE*
zPGf0#6+S{s)fYfaYPlMg&H{)Y*qWxlZap*Q!cq5AmCFB2ObqZ<$mgIMSXJ$ImTQ>c
zCsx4H!~A~V<Lo=e8{Rz0rakJ$Dnsw9J>2%jJl#o@$G$#g+@Nzsr@_?Yt2`YW52lU$
zaToq~-D1A6snGTooPUP*8K!>8x5cu&*>I5yI7PB><A0T=B^lhjW8K8uI%`txg>|l}
zXF+>OJ!JI>u@dunZcQWf((R~Uxnpa-K`%HY<dM(Y7inxEgiEyuM`k9G%x~n1t1}>%
zmLZ=;vtv&xIPW<3X-jarTcojj6vN~F83EXY54&LU>Jl-(Sv${P4`0?`wn>7!H^VS`
z5h>aq%G&#*C_De|i`5utiyE@cVHqtGV(M=1ord*IcZdfcRiSlTL^@CH5dzX3bAD$I
zJH~=X-{<x#Edu9n7L3Owv=Q%M%{>e7rxk;Jst0rx;A7AzKRWXLxoHr_kJ>>0&?Uzx
z*Tm%r=jyjd2HC8{L&e_sDXLmFoz(nN4wFFFdSrj8dxM!Sy8_euB7Nha>5{>FYgzSq
zweqyB`{!vlcqCcL56DVPk4Rz7tt!<xjs80!BmL!VK6zd*jF75H)h%Yjgu_{|^9xFK
z7z{eP7S0-*nHkTKA?`S?%Hp9hO`_V~s-n2+Bgnz#AXBMAz81%o8b$FzsB&v#qsk#-
z<4<i&fR$&#)-Y3C7ddWxqC>;;a5AvN=kQ=)uv3Zi)7h`x%&x#YUpDd92Xx8c`|XOy
zQH-#z5C^p9pF*G2z0-YSaV5XH(-VYm14IV+Y}9g_*g7B|=~a3juN-B0M8nqdZm`uK
zQZzW2<gi9QD%bwliWPAhDBJ$>&FZaLn|9+Vf2B%@ykEfXk3_~Z)MI_pbC(96)+4Jv
z-WtToaPqTdV||m@cytvZ*zZ;yO625i!hYIj$0Tou=b1Nuh2EdKX@8&g56b?E#o)f4
z_Nd=xqp3cb*%ej14znP_UJ;?KEO8k8DU$@I=JAP;FJ4<QEd8Ji6%{hPsqF%hilfw9
zrTnru48ddWnJsm`)f{-_^33awYNR*uaH3VQ4(zQ{^eYb?g|&mOQn&9s$>$p!5jANE
zm|`Rgb#g|s7cH9BvOQ(Z^O8g_x0>K3i?W8<L>eKN%Q>+_?w?TPU0P3N^HM}*aKxrd
zu#5`)tB7sPUS<&Rt-@U<k8G#f;ORNltp>C4ljRDC@K8*xX`v{;;KW)p^>t^5Jc!ZW
znmd<-6elSalTb${^?g2(C8=`A>cP=`zuZzm*q~~Pm5Gdg>_8>w2y&_~<;dY{vr9c6
zZ)oe?U~a8yh))N#A!*H+V`}_{<Ac#WkV~w`($8&rrOn%>rftW*X_z<KLcADX&XlKl
zic^9cAcb_r__Ye~G#)vs@q+qXx*2Wd_cd72(!6ua0>+KM)S@AX)m{*$l(88q_>J9G
zHqjG;L|L8w{DqWg``VEqE^HB7^<<mpnYit7SY~2mYLSI?io%juI^9e&E8oz7@$lA)
z<JIw1s^&qJpuWwJHbThTYON=BXEJ`S3sgo&QE*w;<=|I#Sj0<1d@27hZKUs_-|u%p
zhwJ>xN*}MDy=Y%QI|FstD7Du<qCP|wPVv(zZN_fF^*yAO+V%4w>V8TUb!5*JYtx7Y
zVy8@rMX!1OXpI_%DEP^`tfj>oTgV)FmH*T4-2L6ij)c)AWpw>qL}cVVCkqr)Z#C-h
zsPwAe9Q76oRmZgHDxRO~!qfkQxS++tYM9~}{p4s0(VrvjFFIf8{rHGs6L-B{HF&Zi
zQk~iWR!ssEw?a8)-c>t2wuTCxt_FW}oojhre>@sapzvGtbV|;|)d_K!m*fj)F^`7I
zh|On#_Y9+oWfKW+Hj4)1Et_v2DE4T`Btg;ioZF`--y`iFF^io9d{Z7<I(V+Yp1#y!
zPOj6E-OiBAVz1C{Tf1k)qpmL{0aceZ1<eKOl}fcvOcQ1XL3z*!DZS(7auYQYm~+<Z
zRU=d53;Wv?JIpHmkoArgr)~@QwYpn4`}^YImF=<?;uxxAbLB*M5PP)SxbRINdI9h5
zXU~>TyxfeBD64<mEV%g|=jQ-b3$7Q|CLTUMIn|b)Mz9u<98693?PV*0buBeCOLE*R
zeTb{)r&T>TaUlrbZ{kZoLlp8=>RfhlkG5~qxsFrbtpVE|EU@SpT^0wiMS1!-95tAg
zNi6vKco{Meih}2<=|+5?BrcSf8<r>})gIv{WGK%Z$`xy4sbJxR>{Sx%)O4DCiPtOn
zXzZ2B7ptzWbcrVCsK?oqoMGnzy4)>i;kK`QFXjW@bY5P)=JMviyWv1u#7n)uW4GsY
zk<SZNftj25(Io-8&vn?pHDiPFI=58L&(F6UCi5dvW0~c^S*PMELuaRtidrn;Y0|#S
zOxkKS5HSpjca2;llSe)IG!6COPSh-^ZmqDJuTGeCYEK}_-V_2l{emoz<j{7$digQ|
zRNwc_#H)Y$YFW)R;!2g=TB_b}zJ8b4hc;>34|*RJDVjhu;mw&NuuDyFkO}l1x|T;W
z=Yg%kTK;}PO;Aw<*1Pl;62BXHuB2pg=)4zcD8ek>b*jaw)~unV+u-A2hGbI3p??+g
zG!j6ffqFE>qQxP0hef-EAzrnER^2-A!zrm+KKO|2Fk>9+6po@LQn#4!schb&)jMP@
zsAplx1^Xsq;5*sI(or;lB`B03Ka(p|+QFKyl0l+^s=SHH??x)OWac&n#D03q>qlaU
z^o_4n<=ec?7;x`YB4eqFn(^#0>LqjQ%%f99D!8`de!3`u`40L`E3)~#n)I2Df_HU`
z)sZvy*A2q1x~<6x{0$1f(QW{;Ih-Ih@I1)GnRNZcD@@fSyI;=;IsdMZF85?;cJ{iX
z=y`c$GWXf&j;Vo|uc|kFdz2=8C`~)Zq4gv!$KU02yt#aLBE%~t38L8I6<#eSVqGA!
zf2Dzdh|9;r4*dF-v%i3N(_A46WV0HX-<Ys*u@hnU5;V+PND@LfZza$yjA%>*TTT~g
zBsE&-Rn$GjMf%;N&J_S9XDRSY(dml_s^yR*jCE05TK~e0gIqG^<Q!^U8P1VfMcynl
znL`=Or_5$o*Du|l+WCDm6k8=EJJ%?UdR;A>HqUEX=8`t*J?T}_JN+~^Rgtg$`XQ65
z$9?GYN}NBN(920qy14dhT$hOSo^w%Q2i4Z4KJO5N;&MQoYVVJ<>z`$Qp3c(5jW3$F
z%#xdTF$a_FEs<|7Y8bSPRPkuv**Q%&^|m#?XF$bBX*>L*PUO5<sH5@NesrB&JxEA@
zYHyp1$XvKtz)U`XyC}5$U9NHqI^61hi8RU1SizX^JyRp(PkSeiPsD(i%L)FJ^9WTG
zou#!gvF^ZM2t=d~X4wVbmrQ0@qZWO&2F~{q|MZW*{H2ekDNO$8h!G`9+b*l&Y3tkR
z^1zf4<q_qyxi+&CYskm5!eg@E!E`;-nSqCiaixPj-^+c_OCg69YOLv?sD$W0MZ4#x
zjQj(c#yFQP-7I03j$;j=6DIIe3tgW;P~+bpbl8|<EApX3qeocFFw}z_WxlDdj|PmT
zYPlsf!%->-XrJ>XLtID3slQ#-mFA?#jl@LLjU`mwkC`flkpp-;bSEk1fLG|4RJZpM
zgJ*BS4Mu`cqsDZpVx3qM9KXd^<6ptU(DY)b$Vi4A{TyBkd0Clp>g)$b>nt_L^M2`L
zC3q5gxOIMk%TYMkKDI?Py21!{E(t@};K38J-2^rK;=#3wC=TvVF^ZN;&WvVN(j$LX
z;?L9Mxxf~YJ((_tA0wgkuj{1{qem0;4STIy-j-#pRL&U(h@N?8Ofj(yNx9-Fw$cW2
zx`_*yj+*lu(DOW4l8;>qP58<S3%v}Fp_thFp6|1YIFBN%$}B)ye8=0RANH=&D|SVx
znRRe>u!s(Iuq~CGr>hnsSH>b~MJW1EH7)=oVPY>!$|vgoag8H0I#w{HmV~6m5&=qQ
zZe|nYsIK<$@;`{uX%~Aqn;axyAaI@$f{i(|SY)1{L)ri?T9nrr0O0peO9c|!Vq>>X
zwD&&t<I;FL>X}|!>qvp$o%{shQK$@Pn}GW}E#-EZRybUYCxnWC<5V;*ImUf%amM47
zAj?HvZl(SWNo*i{QVOaPjUf=o^9TLD87a|{U5he3qn_ECs)p&|nvYX*#K_UE=Fo#;
z$8!kAuM?96@5D5uERm*vdGOxpGUDhX84<RBj%B<o=-jK(8ghC_gRA%Zjn<s!-x3!V
z4@s!Ag2ODSu#?T58UvYUzqI#4&)3_f31zFqA{NjI0B0#tQ^>d3x|@X~7jQZI*`&SH
zgo9(+tcUMr87$omf888~{UgtnfA2g~_T1YzS@Yma&cqQa&-Uykf(=x`wp?zsoyNuf
zs>CF{^7zX7$-<PK^6A9Q9$*CdM$8&_(Da6$bh^I?uQ*nZt%vIEp{E^PvP%9gE5ocn
z|9mJnl<(?`P+qSU-hF_t7{*BB8xZqD!-s@b1hzxt48y;~E{aDCwRiZVMeu#6hmC|G
z#MNFAd_xD|XzZ-iiTM4<g^uTf=AC)}ME)k1Smbbttg-9xD?zU9rpwv3+marw*DKl}
zL4V^&!J2)dvZwxA>{J7tK|3Wn1bA!UIFB|uS>|zELLdc9Qg69cM+eG7v2~p~*<<r{
zG5N>0Q4Wtg@h@QM!LJXcJ<=;N9#$h?`)O1}E6GW$nVSG5gJK+<Ro3)01~`uFZ*I)8
zi@vsAz2pBUo1w(WUv_nvu-b)NyI148HJz&Zvrv5?^R<zJ&FV~gL-MvF>S%DU!71F%
zSH*7TH<R}H)>EUA9QC#~Asaj)-&BNRBfGm=>VL<s+$u)$)v*=A@Q>H#dy%?M&;cr;
z--`T7$wMW87c{qO<Z!Ce@g?Qi*#oqhS>}fUvbdnJNmo}Z5!d#wRxP~^hknyWud#CJ
z5Q8MD)z?qwv*|c7laX+m>rZ<XwrTy-H%A^|7qJ_;rKRjfJeZd6{#ZhDnVGaNMhSn|
zdMbB#YO%MC0c2Q`$3OH2VJ2gBc__|Jl|QnkRc&#bF{dm>eRs27OSgewck>=K(F-P*
zO&O=CF>l?81^2@I2jE(L&z?99X}iP^)=mB_A&QiJFCUyxy;f7OR-Sn42{Syhjjm6L
z&t2YL@qi~g3F7K8!>uH>lew|+_wRbCABX7T?#KKZ_yYYdTKvUaddQf&<JlP)&8*AJ
zynXqgIVTmwS3md>Ayn<??wft&PSHm7U`^$030JC`Xst@7l=STh#uO3rCKSYH-%*H}
zJOSl$j=ht^uKQ#fOq4Irug)<0shw?sMUm7CJ7yXwYevH<S?~Vj`cB*Z`U2+;1Z-iX
z%LA8M)sD22-^o-@7G8zd`WP8KTzM~x>Y|e2q2)LASi51SF7s}Vk&9J{$u2(b%bDgx
zQl5YmXB;Ep3Pna{IaS~DP2@*?_<lb!=A>0sot;9y@^<+kA$ni1+C4MRt`FsAw_pL$
zX~&&9?ZvdVC2F?Rnu*TOk&SZA1={Jf^vcOETG+`mnU$c`<`hiJ&`O}gW-LRrxFL_;
z^s!Tshf5m5=ZiS4PVgA$D;d{V63J6%j8={=S1H?KNW#PqF&O)9GmZpw-~|uCfJFS2
zrFV;3kY7JLQ{yN2NBX?dpn<)A5Uen>otRXn$BhuX2K<5EJXBp-!}FCN-oL7gA-zRb
zI$7$Gzb<0PStmOZAyD66<bJxx%ych4sskNZkwLra<BygIsq`JAId%Ik1}poEBkW=W
z&a$+OxTgTb*=oMNl3&?i=?RTzoLmQWNJLk@uidbiowbTEl_+nAqp|RItbug9v6Ey2
zu3FI9Sdxs{r`*r6o{96%fSsQzXh|&8$4dg0wsi1WFz1DnWMk!T!uKA<{isYtBW3?^
zMNQYoEWu$$iMJu!V~OWW_r*5`I;g}wG-KW3b`XpnjSs9BWqY6C)G@W(zFol-ZtJ5D
zW;^^lkX*yfy&b3Hc`9n)PYzygU*ERGwsAajYKWeg;&}wphw@CoyIP~VvtM$ShO_HO
zQWQRKDG?sRyzo4NkIe7Y@)^nt^Ufd{coeBZ#S_gLeKF+30s;a&3FESyudiE!xCP;c
zET<?^c$t}tPRJ^nl&C~;x%?dkSKH1zzrC9DOxsLa)fZP2hQjGXhCGFREDG_B#JJ$A
z37VHzn(SVoJQVCOndciSW)QGN{l=YW_CH~ask}SJI`33LEjyCGi}4tClfx;F>I_Xf
z#Mc8H@rNB)VfWsYO^0IxQCSOqC&aeOF{Yzi;4x33V|lkg<4^}voxf%^-KU|%=Y}k=
zjWe3*9J|B0_#1aTX`^oF`Ih;*5;%q=-Wp{7aBR*f%ir+cJrT!5h%QFEqt{cfPKPfp
zn$EUETTC3xmH{(@d~i>`9-+128nShbIYiB9?0b(=NmA1I6*+@DSA>NJLo^1Hd|j7&
z6T>AEX@pHi4mYEHPg*@7vM6DMaaTBP1$b}VA9w5`qZZ1v2%rz-7eMZ|=+bbP1n-_q
zt2S4HC3dl`N)|Oft~J;t0a$Flqc?Z44-y6fhtCPogv!v+j0=ZcBClfj)|LvnWUKpX
zU*P@@Qw;QUv5PMwY~RugzJpxs;%qyhqIm7i*3z)PRwQd*j}YZAKmYacyt#g7gZODn
z?)mx~$mVAl?ZT2JBZSWtqR7J>QEYR9uhR{w#9`8y&;RreGpAhSmb+g6Uha0-?kMj#
z^9Hiqeh-19bY13^ZKadl$a!k%$2oC1YaPO<@uV+m3EOkZ6MGlFH~ThivbE{Uu=3q$
zh{-P{1+P!Uzi4P_O9CE!ICzjcG~iIt#twx-Jym=R*RS)d*g49-c(I^|4pcUWPE0FO
z(8RTWH{!lTq;H^Bum7TM4{szW{Ad5rH7W*F6Q7z;RaJer?VvMlV%cDmK2cNZo%8b-
z?5csQmLq=}@49=pBDhj;D3^wWZ~>5zL)33v!hM5asl?bKjj<uH^ILhC)hC^?w`3mt
zhCBfW1>}Z2?ph3)@%>6is4EUVKi3OaRf*8Gmg-67P99OS6LE11*<|ZI`Ko;zW{9V|
zJyy2U3>GkWklfTakK#El@dv24V~&||WHpjDMym7;@giJu$?hA10Y%zq5Sqc>4nVtY
zb&X7ZIg>AC-JpP3c@C5KxYr0I3SKf6uHMfBZFx62!Un1fm4>UyNZKq&6rFa9J2PBb
z%<2xFss;)S8WvebA;c9EfaJgj`DT~K2NYc4;R4o1JR9ji0$QI@>lzQ*(vy!v&h$>6
zr)Z*0UU^KlfjTBz69Hz-x>SguU5YhK2f*`f#C@XZ4~r|(d_HqK50qImYd3FO<>5%1
zHMn?T?svTTR~zS{QYmrcAH8I($ZL(}FxQ#KE2maSD!rr7@43#E)pqC5Fu`*7gL-Wn
zU{Fu;Sj9sMz8e(~=VG`y8J#~r2pRpdUhuu^#pY<mFV`FgwwLs&H}5khw#OoOkR-36
zqcx_^BaL4q5_Xx^j7?vZIctJ-z0;uj?#}9KB<}5F>L+#wIiGF0LnNB}<C6w4m~60_
zh;k@De^*&h<hyF$-1y_YAWY{m(Z)t#!S_qXWOO=z@$Qmjmb;&6MYKXVoIN65u)4%s
zIoI<9$?fQ#2I*u>Rmpt6k@B<3F|hGx+tGp5YB4yx+#UIty(YyyB0u@L>ReL1n}Qi_
zz3BL7k~U2+Ss2~Wk4(MR^<yF=0Ho{7W%%wXwOq;VYmu^>eaQ$6ONa@Q<5-_K^x|~s
zXY`d9H-ArzNs(B2%t8;IT78@bS>C<l)jujEr5ZIhJ)E|WAI{Tlh;9~|O1a0t`AFFq
z`e8@GoUHVg+SLSnHiOu^tYbP(OQ+`&3r*$P{nwFQm~7{n=ZL_)w84Ss8<Z(513U`7
zM$Y7`GjGR8!YFEuZ5qI1P8(lRgmU_uYab~AKldE?xl3xK3CG{&I)mIs+u3cnL~dQX
z1=3PnSf^8Zu{gT(E~fpfv{ShU{Ih08O0*UP0=Fp~6?bs3Fu&;QwOrv>dbAXlMs#^U
zcx&cv&%S_uaIX3_ZRBz~L{7^$Gv%G?1{tfZ;qNd9w%B<;+;(i!rah#j)x3d)v&}{z
zj_jOior;Uu@6Q`F8nAq<OpE=>UmH~-r4Qm6KsKVU?ZPcI_b%Z3Mm?HHhB)_nYB%g|
z<qaE+zQI6}EcU3sp;OI};|M&E0W^(e;%*!7fY0Y&{m6(#!;%yHW*b~8_+_L-N*VYy
zj7Hj8(zpLf0R&lnOiceLNK2KhaeHem%OxV?&sfc2{R1ggOv%M_zAK;?G*O@d&sR%b
zUG5I|47bXzX&=+P&r6dxV{y52fd+IsC|Lb&?ut~mGze<_@`a+zBQKPO%7)ij_+a{U
z5M3V1i79`97ZT^Co^ck(X(N>;{X@X{utjB${Ji00N03fn8m-;nEdBO7#&=Gs1)d8n
z)=Vk#hbRXj%|Q>q{S-=76+GJThc<2RGh;QN#gF9#I7WCJ$yTifB#}1dV}+djcF+&|
z`-g`Evo$tW0L~BWi1m)M-?e|OGh|$ML5}4pTKz}!J-!4a{(Y;j-XEJD=)ZsG)zw)d
z2k+{+z+`@==zvc_S}6!3IOx?Tz34&GB?B@2Scpv%OG5vgbbq9%?6R*CC2Z}0Xg;MF
zkG~49IxxN$9TW4WC|>nGwYxK`L2^}ZaN_nz?}Rer!b$kss4BWlmm_;Wz>HU(Xgncw
z=S{h195T6O*0bAQ77quOqE1kMVOF&ib@EZ&ABt6^`Np?^TlYnnpRJvX^tUK#8*$dS
znXE$-p7tV&`u4w246o6uj;_J^s~L<&2FPkG&kA09!rGwO1Jh8o5Bfr(;FPkUHLOHW
z%)alh@dp8cE7u&J6;qW=nr?hCx{;-QjVIuBAu3BNsG^kY!);PY_V+2J$nXuJVY{r?
zg?+g-yfekLcinuo)DrHnmu`g(COKV%J$LDCn<<^ru*ErD8}fB8d-5Qy4+2gI8?JRB
zulHZm=aYW3e+I0ihn+0dc-R0WIhp1@A5AWe(OTZk<Hrs4J64aFX+DXU1-<ZNVHXPr
zNf*hZK8EtQ2x!OJ#hE%>D%(!wy~}2n+;F5%_Z55%F7pX@^~38(U<a{kHLsr9!43@O
zst%*AeozW~{QUMI?ONNd%7=oFBAzR5`PF~YXbEfE`E`lnwG{ik)R7cq+pqA4ks4gp
zX>7ox5ZJ&_`Cx9rb^^27t0XX-?mkU2->lCoR!kOe=A)wbcnK4XQwBd#=_Se5pvYgp
z(x)L*ST<_>F6DFEN`v#!G4IKfE{Tna&Trt!jAPDwEqc|*?EcYY>q1P6m!>%x#a{+>
z=kl+S^=_^VhiS{4z7aKYI=CtxM5E$ygBSMfD9pKPvY-L1EbBG2B#yp8y~_3;_cp}U
zXiLcT37UdCcYdo>c-Z5!mXVhTq-OBS(L{vOUdeWYK9@?>`kL`l^*ykvc`Bu!w2;Gu
zRQu_ThIUOv|8!Tqey~|hWit_X6yR1p3xR03U>u$gbZ1i(lBj*tt=DiBO%Zv@(WG$a
z$!rxDsiI;xgKZ>zoL2c`A2-uzR6UWm>(t)q!gd7C{b>9&49fm^QanY~eX6;o_lEsV
zn~7GZU-&DZrbIWz@t@3UR#BIcQ9xSsrUnqlyFRLWJ(Q}YS-`*$KPInzA7)iA&K=?T
zzyX$$S-*?V7b?ATk#AA`saO4Lexa0XwY7QP*^z(fR*Z%q@8_?Ge*UeLM{P{sHlqy;
z4XeX}>PXv49pm^aE8aL~a^%HEtu^${=y+ke&5#@jb%10AJzn0FqodFPrh6Lj&v;wi
zW<N^z{2Z+&s+JUfkmsh4F}~|m2k##>&mkUP9O2(e`s^!Yt~$x(@WYs+<Je(Z`843d
za1edYH|aB_#YQihtdEhZJ03YTP5yW#Zk3$!IP`8WQj*n3Vq$Sb!-(=g`lZj8J7V>*
zQ5vh@J@OW7Cm6X$as~n0;lHuJG2vOqr16PWO_G|@qr&-K@9k$czX32WO9fKqT89ve
z5+%k^^1{~d0S?j*P{&evHv0CWilzL*bX~rvfdl~W<MGo=MC(GARm`bJpSc31m7!)=
zVC&A_GHYUjgF+FQ;2p((N?&$&DaG?oL%jC1Bwq=gmnHKv#*ep}*oCecL=UXy4(e>>
zPu7_Qd%8HNSZV?BW&GKhU&~s<30+F~W77GS&ktt<zuZ;t%Z<~ZLkRIjS?_7&@L}Wt
zjh@r8?$z_i7rR?y>OtbbFgP@jBxvLHj+wFlDThxFIORF=u@+xM|BOy~y%{)_a{ZpC
z?>%J2<M6!dyW!4!b&}r)aC`L!jDw(g73j+H4Ko8h-S>=cK0Q_o{gbJzz7WPW_SXCE
z*_&D4_o!y`SKd$#k(39x$aD?qRpgyRpB#*NM?}m%6>yTmOvf2pl+sGJ62JVL74HmM
zvkFY|eR`Aa!KEc(Nioie*=&Z#Zq&D&-c4R%rTe@dA2emo2IzLp5E&N|syb<P_*B-Y
z+_uF5%;M%!{G2hm)i#ihU(CJW>3(4O?n=&T?u^Z4exuB^xQgrCBP&w~#xK6M(?H4%
z-frOb9rMICu(x`4Yt4YXdlU21nAOI|gYkR0#U75b!@2Y5fx0{5o-IYdBi#!8)gl+0
ziRmI@w{MV$mk%67CBBb)q>|(t+-Cx@upW@!OL0ErP5K6BGV0Lyz86O9ncACaP27Bv
zaD9hMK+qr-@7t+&UWf~8VoJDQRHxfxGEsVW@X)GPBG$CV+)%Cl$y*$y@2`8;e5i6Z
zt4|~`OLYDw({j(GAIk-?CvjdiY8ViZKz|YdYX0~<b(4+Nk6W|4QzLrpIKxwppRWCR
z)qcGGMfA*<6<%`y&NrE~y9<uvgAnAWWRDo*$E+sAMT|l!G50jBwaY@!fN|CQJFYUv
zuPk`w?vF3{oZ1G}HRh%V!*0-$vwM72NlhG=y`wWr)7n4Uu62jSinf?HclM2TzM7Kp
zVqow?;S}rZB6f3z>s0H@K*i1@KjB{EE@j>7dL~yiwU?A}M0pWOwfD|3m(rt6?_lGa
z!rGLJ#A&{-D0VI}vQS(R@#y^*7`DQO8@n`zuFq}a1=kzt6PE(1hS}+sKd(4f|5yvZ
zHchG&Z{&@(2v?wgEHdiBs3nH|A#Ol3&3##=RKQs!Y2tf)dQ4E9AiLx%$o)P&OTSJM
zfw`1q;rTR~V^_O~BqF<>;K%CZcDm&bNj5K2S}bi-@GhDoZ+=|i7s*mtk?z&`k)9aV
z%%nCtZBWoX;xzlEHDf3CR^nR0B{$PBxZy2}O$I|+>Z5kdn}8!1wF#P*v>OyX!Y<ug
zE4A0@+WF9^*!Y-N*?ZrAAie^d(W5w1r-b;q_9iKX`#dAcb-$j}Qog|}#us&NRMU*J
zEu7ewbw>=4jw_mnzV2}%!|hNQr%S~wf*LEhnKZ0P*)r1;KdDd35jO!zNhj_%%?i!D
z(f=CYCO(tHvobNKstKQ~y+BYf`k{AA@YiCCKIXDWZTJj^hH1Rziqu7Yi(re-g!BuB
zrP98=*w4j5(!1H16)m2`Ex9KHSE8WK1}k%)rQTp&zm&?&fE^E8gAlxZt9s)EDdCFf
zy@|%2XE(N=t`xoVP!-qsM9A2k;)qeK7O)7q?4-b@Gf0}x?kyYSH1<WEeAR#>Nw<S3
zy<o9L^dTN%X86=0@Rk%`^x7Ddgyx|U??KTn1--~jT@Rm0^Ie?I``xq!XX^^-{)*S{
zkay~kyO}l%V5Kx`Tv-kQW9F?ERa7Hgd)JT_S>UO*-#!#`;`_&^CHP66g<znD5pjw3
zoW`f6_bU;#`fsUA24C8Vb9di5V)}-UUF5J~UL0llx=ND3C9Y<)xv+D9qDuJ@K3wxq
zFwgF3a<d(=VHig=EZ2$`TsKcv>)U2F%FNbn(rfv)yvUQ=;U;3enN1xx@!{2ooqX^R
z_C;4Ce>Gq6Luv|1wYk1Z`Hlv?)l(z>R@nDB?$!j#XQE%bZ!=E#g`<uWOv4}1h1<EB
zblFy2nPvv|d$2uF2cuq@w4X;HCK|P?)z7v7ZZ*^L!oD5L0VR!DE3E}zBz&TB7A-)F
zJzGz<nW(ZZN*_Pm^X$3D$d;y<bxG)%o|t%W`MWHiPe8e0iJ4PtR}+~_J<Yi%g?QT=
zFAtxw`;x9tM7b?2tT??fK_Je=p4>@MzTumZQ+DL;)i%Zj_a;}=oUJpfii}N~hU?ul
z*+Z=5^2KjRm~yX7TUA+ZzVdJ{o-)G^e=Xv?8&DSnl+ZpS9qRum$oqBv?MAn0P)<&)
z;H5M{;h!JL7G4}B?GFD9;wO8yKKz;jd%fHFYT*9GfKSin(^x=Pn;i+5=y&$4shRU%
zggPVbE<yFl=A<?$WyRH!;cAk25sGKx7iF1h?^=3n+VJGy{NyyU+a)o70pfH!O0c0U
zGFPR2<5pX;eHxAYd2Oh)Ygt%KZ|b*N%fHC5<57De$=^c358R4D-!HZYn%;c5HqR*1
zXs*kE`*UXjUmViPuDm_YH==C9YE_d)qna}(#q^xGZxk{R(YNAoFu2WmyjjFs(C$tY
zO?S~odyReHw8yo9009d3$gq9`G`6&Lhy<zJHzmCk=HV+8!Jsfn)8r2|BWm=BS(TE5
zNrJ#B`sV%N%eJ>QKIK@v=V}FCm~vC4jX{aQ_8{vg&%`Uwc6G!m)$Lw20S5g?g>~R7
zBBJq&0P}%{G(OklGEo-p8c&t<YPj3aZ<h#kG0&%GA9ruMm5leXG6E4TV5xI;vDW3X
z9OZf?RvyQVx#F%vL@YoJq&`9DGnciM_g)r*WMPF;a?wn!aP};0;J=E>ZUUum<2C;T
zoehiL@bc;TcsTqMIqm9yDh*>CpXYD!4CP@kjXr)a0F;UOfxODi4!7sIySln!6R(2Y
zw$kEs??L1bx0xs%^_<DaO>3YtKdcfQE7By~<QFXc=g5)`MsI_SE&@|)A0P<`VsHC&
z3j*Zu;=FX#2a~+*!tKBI?sTLr3MTh|^rzY<O`wuFsl?&-Q1GWzSW7GPPAP+ry{xy_
z5*vpqbV1M^lbkSj(3g>Pt3lb-?od3%_n6sR-ZQ;n{vb{DSp^z1BEx?X*ZQkL5sqRm
zi;uB}({PfC<eDij#{+MlgHRuhz<E&>PppZxiYoG96vY|kdymXx2O7Lj?N;l`9#w_*
zp93Xz=H-Q2yEx<4_hZh#8?~9&)-qx~?V=?ugxnn^P(n8EJhXZg!v)yf_Xd?|b*Uv~
zO!&i8H%^|Xk2Yb#r*aw^^oBE}xGw-aqq!O@IE^7s6{U`Ku28zL{}-y4V<)HOiNgMA
zv<tAo@m9+a^0krr;y%^7Pc>`_o1QqEHrv2Y8%m->Kl;vigw>RtOV&N=e`4APmFu-)
zFYFik!Z=!siee!ximX5pruxkynYKik!i5fhf3Q#K)`wMY^85wJ9U@AVuRAG|W>iv{
zhHl0w#eIPj*EgMqOcN6ZT4lZ^i=s=>My`fY98NW^$OE3&mW}#P9$f{z_;rj4PzR}f
z4#8!Jp`;lN8VW6P{75$yPW`U#T}$&aKKli>-}bVHR@dwZrE$6CK_+xBJCFxFn*KEK
z<t%2pDGVrTyygG%?d8z>1e=*FvTGV0N$>k!xAAKeKX&mkCE25{DWOPAvye>54{17b
zrL<9dV!+$y^~IoEXHRQiv5D?y(l^#nxe&^!Qyn@T_5}VLDpsAm4vQ!Imu2+^4?e58
z+qEZbf!QBnjKk+Zieyb01~t6VF6+YKZHpO&&;_>=^c}9Vncby;tU?ExSj7WCu2IF>
zGY1Bob9;Fc9Gectn<2o)%S%r`u13x*Fz%!_v2o8~MR&8_^*$qGV!vy8xFm;<YKl?0
zzoUv*hm_BjJ`8Lp{-l|)WW2wlJ<ZT$p}C2GAK}y|U25i4G?GbQDNg=0Rnu;Kj-N_I
zF*dXUse_Sgj4!2|PkuJ>a*LMw{c?H8Vl$lfpz?=zHm`M@0B@&m^G$VxhXQ-5^Cf`*
z`MNw@*2ms3XNPsmJoCUH^Aa<GGLnRYfKZ4XODwZ(5#`r3*ehN++$4==OPiA>f@k)?
zxm6?HGtz|f4cPwNi>s(}OtU|s$5OuFRoY_}SDm0(!?~>CjqP0g{Ibvt*TC}3=Z_jk
z+jWaqjc%)nHQDabPXr8sU%98(kEJ(P8S|vP>b1C>-#%;K)MP)GMOF`IcR5OGdImBz
zSspHGr#u6nW{dO5)d0yy<MQF-JGvu<xDq>^5KA=eqyB@4f&;<iB)6X2c<$rN>RC(y
zk8b9<eLrau*}Tl}bbnx)$vafVA?qTBuj!ZwL@h+kh%sCvi5a?@5Il{*oRyKVJ6CQL
zPstcPe%ZcEMY%FAImhTc4(`CS9pRHD*N72<LS}kMVHJ<IoI|DGGtEl@xy!>6eCL0>
z5oVbQKRsDTym6wNrJ|rauRyZF+i&@Jsa%3z^yZCRQ5!mvBn)UR-jJw2;MJpW_C?vJ
z7u$)0SF*nJ)K_+=$6cT7H1f)inLGh}VEpDCgOSG(nCL$zLX}iei*i>+c*CYOG*m|H
zjKlJG+k?>`55m6Pb}-WonXcmXn1kwb3Ohr_cN8nQeV=s^X<XzUA9k@uOguD--2X*h
z!6&FD^L6KH9Do`I|5IoM^=c$DuHJz}-3V7r+|PKWVQi>|l2_Qnm-dVDOi>gDE2=Ub
z26qFlN|${_vUD4Bipz|!iW@NOF&b(Are<ONh9nDCf6~}+X>8+3&gSGIc5-0++K-PW
z5jiFA=}M_-txDfu(lY10#p?BIWlc$Ibw+f-dnXIi>J5)Xic$A(ZZu)r39#&p>o&@Y
zxuKklMqc~tnzNN}f=nE?fOOSgyeoG6XD)zZRsKp^9^c%U=x4=4a3Oq>yYgOP8RMGR
zvI%F$hHg!xvaoOqXRl&fd5}rb9J0)$ON95GW7E0>pAHlRpROzYYS198o(PU~<0$KN
zr7TPJL<MhG%qpa78!z61H%)KO8ZvsA;D<-d{L)|G8?k0){Ui}!FqMx>6-};GUQQ&B
zED#c3UmumF<6(!IBtyP~Kj;6MRxR}dQ1qoNsJT3G6dCqR(n$(eFx8Mbl$>Sb*_W%}
zsWQ^Pm3ICsmT3F(w7DXVX}m3N^k={45=^E2S*hthsE(yN<2M>%$QYZRS<-nhbyOjQ
zzS0QCIFGY0_$a5>s@I*peVq+>Zh#v$+Lmp^bE)+81qDGDRFP12c-=*oxRUN*!T<bJ
zMSSHs5W2^(|A+AXf{Sv&SJA!SrZFLdG}kI)N@T(oVg3-5D}1E_bT3#7qqjUgvp?H0
z2Go7Hz)ZU8Gq$TN1o<4Ca55-lVZzXmgNKJPdv9A)<w_)#%7oL7PUx70K(m|A!yc3U
zo@Aklx!>Z~8ueiQEk-uycm!4VMoCWM&l`M93>#JLi_UI3$p_y@SaXfD$S-<A_oVaH
zQmI7x(vP&&ux|Sgf)~Yz<4J1VDz1~{_i|R*8pIy34wnl2?hPrp@bO;1&4G2ua?-%9
z&D<T4lVO_ZW%a0aM^Qo|6n#(f1qLPKul-r+0xG(9M<0QhPrt`euB!0|!p2X#&U4{7
z5wqXpnvH&80~`A}N@lrGj+_P2FW4D6za+5;Vpuw>>TQT^Ff*V5({)>wK{U~Cb&Ld%
zu<p72HCJ>+$i~wZEg^b>2O*6t4cS*!)h8hJ27ODDZ}jSghv*PJPxn{Bjfm-fZk#Lx
zz&d*tXkIo<jX8v>KGsauM322_`gZ*xK=rBZOZWHgb9lkP5Zk#|szc94A12X`Y&Ag@
zk#Qz;8D5r)hqD_C*7Dc{73fASWMo$`&84iD<Zu8Cf@?8W(<L%dpWOoZ0LYTac6Q<8
zBE2m$-~AyayYFpY0!580ITH(6f@i-NvA<xhoG_K~-3N}_%ZJT*A+=Xz?wlMn*{vx2
zp2`8L#~wYUc8yXQ7ucjV%IDaUoa3R@msQ>P9Qj6BG0W#^p2b~?tuP>;H!UW1Rrh|r
z#}%T|%ck5$+ti{wuY7<Y_QMO?D*0Xj9r`Dk7V?+T<WV*Vuog{#;xQsa#lI}5xq1lB
z8kqb4%yx>t{?DyIK->No5o+GU(c?c{{)Zp+A6xvtxb+YR(01n)fNo@glZTk;>H&C<
z=ox1Hg6Q=xH!C`9@YA`p6D>ds`Y`SKFX852uGjxK#9T0st^axM>B3FmhyIHUcA@tF
zi!k;-h(kJ-XU7%ib9}&kqB6KKc<Qz1E#RvyqscGe@bZ5?`=5R$2IRGq_RrMkJblFb
zmy-5>Xr*9{h91rSJ6`&cR?C07Yc)IrFp7w>7#A!qa6cW(@;Y+h{F#J6#lJU_c?+80
z7vkE6x9;C|x_FPR*%~$71$!;}a>jq3um2?7e`OUm7%{kULE^h>S>A@Cx#05=)$+N+
zBSh!^?NbGG+hyw^aCuZ5K&vl=AmFugV)yTpxH49m+W#P;|HCW)xmCMu<9|r=SHEhp
zc@v__YdsEs3B;q>dZykA0*FPo@V`VoLyxsb{R?g@5uOwmLo``)FeA|a^Y+LPFW?fO
z4(Ss9|0OYBOdr+uKizHqelZpQ*Pi7553T1CkifPf{uTe081COylnAo8;O~9#-2W1F
z?xF%vQi)p(v2&f-Y2sjI)BnT=d)5E|4Wg?6o!qU9LUe|gXu26;>Z1k_y{!m`+d!5{
zAo<I_@7NWXzpQyEB|z|LPNg-ztj|1tgDc^VKGTx`louJ#*rf~hTB!-0zIC}&m&w0E
z&P$B^uNAT)^jDLw4z^xor~ew3{~x{nS68J-+y8XuVb8kFF7k>?4cg_+<z{^85_Ujp
zal*iBQQB39?*w=2A3hre`nsO!JF?pFEP(%32Pfm{RWrvss$QVVL_*7h)Xs^(41cKq
z-^$s$eX(vvBM0kjhG+g&phVN`p}%^HnQikq8V3@T+xBgY5}tiidS<+u8$^|`jXRMp
z?f85KnH|4NXu(_GylGBUZ@2~1hmrFv0gU$nAPNOY>7_EMB2KZ1W`45<YZnip&sA^O
zi!Iz-8n{&Ib-_3b9g!#6^=A)$!|->X`=4UHFb)^0Lb(QPp+wKF0}8e`;d$%jJY)6w
z@6)x8^n8>wJM+>Ty-QiC3sq)J{wKdTF;$Vi`oEh#5BDupue`X>Io)`Y1cCyk)N!Gt
zy_wk`62YHuwm&nnv~_ftE&36hT1bRcIv!x-S)-U@(P=23Zk|3yudV16v-3dT)1F?-
z4iOt^ua`_xmbbU0D|}BI7knz_hw%$v6}y$(Y?~36y^Y(?KJkAhK(^pMz1#vF76q&6
z&_UCD2I<<d$ddAA<wz!}O&(nG=fkb&D4BfCyrWrEfn8L8TfIWn;cVTBd)1ly&{32A
zkpW%((5m+7!WF}nzq9mAJi45*dW9PI;OJ9D_yQqmOY&`dSt@G9Ys*81h*4s7kv^(%
zX>};%7bC&JWTUyY%QvgpZcWbfymx4ki61KiBjbpk`W6Q$powKK<J)$7xcgUTm0lG6
znjqY%Tav98+a|i_?i#{Bg#R-6b1WY+|HGHle_s=K)vveB!#^hn*fds|R6GV;LD`vw
zy-}%oD|=ynjpA_j$EAL|$scwx^`Uzp+$Cc*LFPWMnU#e6?I)Ltu#NVB++R%j@E?$a
z_eQ$yQ{)=#bW@`0KkP))m*9!G`TuMGG4Ecd-Du|jAx)>VNC@-otk*x5>t1V;5^=^9
zoO?brM~zWO^3`<t&U?y$y?jqhn^qbTPWx#Lka8IN9Mn{e_`?)XP}{snrsG9F!no&J
zQ8BmC`E=8nDlA7zrhP;~aYiJ|{Tk1h)gUP*!r5!o;wa4bbX0VK%5bGg&U<Oh!dY+Z
zjPWmjVt=t$T=)wq5u5u7y;(Fr!z^di?AKr>f8T;xYw7;l@OjMjrJ~HYO6$<%vk?Uf
z#i4q+9q5+xSsh_AK>a6xncm7Ult21a^p2?T;)96D<4VAz=010~bxp&Iikz~4RQcb1
z?V(8JWa^Vk=2AF+%Dv=k=4}r9pc!1a57t!NPvimv@YEgx{%?gPZf)qR9Z}`<2I)E;
zheiQw4<He#Ua8EuDs$)5+uM8f!o|m7sZI!a%+R9{w=s6$%|t`vS%NjVwWI#}At}!b
z+UO{QQ`MxapO5rz02L3)4b<#;aq%_<4;)o(Db(x>Y<YvhUVr~b1<QR3E@9YYl7Qeb
zIdj5LfqH+ci*x+Z(xKn%i8f*e2{iohE>*Nq7M1GK&RL+5=?U{8At8aaI`5VNi3$Kr
zO1DDhON=U9P`y#z!N=NmDySmuf;5y>K;B%VYmTw|kZ`r#1iOuX1b`8H=)Hps4eeD(
z`_>p^O4DNWGSAOfKOxc*UI#p5+-^K0mfH(hL|AzqD!NTO%egNK{?UX~Y$riZnKKgn
z-y=<45F^gX@#_Z_@EYSv@J8_b83(!s?Q(vYsfV<Qq9ytY_2%U_ZGG(0b^ybP`y7_m
g>}+go#GEt#!iY<A+@@RudP$_Dpe|qj+&u9A0}-rKhX4Qo

diff --git a/docs/index.html b/docs/index.html
index 42b3bd58..96e7d356 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1610,5 +1610,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.2.3
-Build Date UTC : 2023-12-14 14:05:23.126960+00:00
+Build Date UTC : 2023-12-19 16:28:59.385501+00:00
 -->
diff --git a/docs/search/search_index.json b/docs/search/search_index.json
index a4b96bf1..2cafd7f4 100644
--- a/docs/search/search_index.json
+++ b/docs/search/search_index.json
@@ -1 +1 @@
-{"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.8 (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/","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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods Register custom event handlers The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions. Fork / Modify the module 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: 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 . Events and handlers Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information. Adding your custom handlers To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods","title":"Extending the Ramses Maya Add-on"},{"location":"components/addons/maya-extend/#register-custom-event-handlers","text":"The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions.","title":"Register custom event handlers"},{"location":"components/addons/maya-extend/#fork-modify-the-module","text":"","title":"Fork / Modify the module"},{"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: 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/#events-and-handlers","text":"Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information.","title":"Events and handlers"},{"location":"components/addons/maya-extend/#adding-your-custom-handlers","text":"To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers"},{"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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything. A typical Maya prodution pipeline This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case. Configure 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything.","title":"The Maya pipeline"},{"location":"components/addons/maya-pipeline/#a-typical-maya-prodution-pipeline","text":"This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case.","title":"A typical Maya prodution pipeline"},{"location":"components/addons/maya-pipeline/#configure-the-pipeline","text":"\u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"Configure the 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix. Arnold Scene Source There are no options for this format. OBJ You can choose to export or not the materials in a sidecar *.mtl file. 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 world_space: true add_extra_attributes: False attributes: # List of attributes to include - '' attributes_prefix: # List of attributes to include (by prefix) - '' - 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix.","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/#obj","text":"You can choose to export or not the materials in a sidecar *.mtl file.","title":"OBJ"},{"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 world_space: true add_extra_attributes: False attributes: # List of attributes to include - '' attributes_prefix: # List of attributes to include (by prefix) - '' - 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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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. Known Issues There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves Features All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu. 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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True ) 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/#known-issues","text":"There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves","title":"Known Issues"},{"location":"components/addons/maya/#features","text":"All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu.","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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True )","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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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-synology/","text":"Synology NAS It is relatively easy to install the Ramses server on a Synology NAS server running DSM. Prepare the server Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin. Install ramses Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Synology NAS"},{"location":"components/server/install-synology/#synology-nas","text":"It is relatively easy to install the Ramses server on a Synology NAS server running DSM.","title":"Synology NAS"},{"location":"components/server/install-synology/#prepare-the-server","text":"Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin.","title":"Prepare the server"},{"location":"components/server/install-synology/#install-ramses","text":"Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Install ramses"},{"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) \u25b9 Synology NAS 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) \u25b9 Synology NAS 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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. Develop a DCC application Add-on using the Ramses API To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here. 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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/#develop-a-dcc-application-add-on-using-the-ramses-api","text":"To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here.","title":"Develop a DCC application Add-on using the Ramses API"},{"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. assets \u25b9 list of RamAsset The assets contained in 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. assets \u25b9 list of RamAsset The assets contained in 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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. 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 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. 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 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. setComment \u2022 string : comment Sets a new comment. 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. setComment \u2022 string : comment Sets a new comment. 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. shots \u25b9 list of RamShot The shots contained in 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. shots \u25b9 list of RamShot The shots contained in 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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 = None Sets the user who modified this status. If None , it will use the current user 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 = None Sets the user who modified this status. If None , it will use the current user 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users. Events and Handlers Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated. Examples Adding handlers with a user script file Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events Adding handlers when implementing/extending an add-on # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users.","title":"Methods"},{"location":"dev/add-ons-reference/ramses/#events-and-handlers","text":"Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated.","title":"Events and Handlers"},{"location":"dev/add-ons-reference/ramses/#examples","text":"","title":"Examples"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-with-a-user-script-file","text":"Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events","title":"Adding handlers with a user script file"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-when-implementingextending-an-add-on","text":"# Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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":"Adding handlers when implementing/extending an add-on"},{"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/getAssetGroups/","text":"getAssetGroups Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups. Reply JSON { \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#getassetgroups","text":"Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssetGroups/#json","text":"{ \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssetGroups/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getAssets/","text":"getAssets Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#getassets","text":"Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssets/#json","text":"{ \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssets/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"Details"},{"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/getPipes/","text":"getPipes Query: getPipes&projectUuid=uuid1 Gets the list of available pipes. Reply JSON { \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#getpipes","text":"Query: getPipes&projectUuid=uuid1 Gets the list of available pipes.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getPipes/#json","text":"{ \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getPipes/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"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/getSequences/","text":"getSequences Query: getSequences&projectUuid=uuid1 Gets the list of available sequences. Reply JSON { \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#getsequences","text":"Query: getSequences&projectUuid=uuid1 Gets the list of available sequences.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSequences/#json","text":"{ \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSequences/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getShots/","text":"getShots Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence. Reply JSON { \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#getshots","text":"Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getShots/#json","text":"{ \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getShots/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"Details"},{"location":"dev/daemon-reference/getStatus/","text":"getStatus Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } } Details itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#getstatus","text":"Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getStatus/#json","text":"{ \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"JSON"},{"location":"dev/daemon-reference/getStatus/#details","text":"itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"Details"},{"location":"dev/daemon-reference/getSteps/","text":"getSteps Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps. Reply JSON { \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#getsteps","text":"Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps.","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSteps/#json","text":"{ \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSteps/#details","text":"projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } push Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited. fetch Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time. pull Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table. pull (single object) Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } 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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server.","title":"sync"},{"location":"dev/server-reference/#request-body_2","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_2","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] }","title":"Reply"},{"location":"dev/server-reference/#push","text":"Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table.","title":"push"},{"location":"dev/server-reference/#request-body_3","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data.","title":"Request body"},{"location":"dev/server-reference/#reply_3","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited.","title":"Reply"},{"location":"dev/server-reference/#fetch","text":"Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull.","title":"fetch"},{"location":"dev/server-reference/#request-body_4","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_4","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time.","title":"Reply"},{"location":"dev/server-reference/#pull","text":"Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time.","title":"pull"},{"location":"dev/server-reference/#request-body_5","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_5","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table.","title":"Reply"},{"location":"dev/server-reference/#pull-single-object","text":"Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID.","title":"pull (single object)"},{"location":"dev/server-reference/#request-body_6","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_6","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] }","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_7","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_7","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_8","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.8 (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/","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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods Register custom event handlers The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions. Fork / Modify the module 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: 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 . Events and handlers Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information. Adding your custom handlers To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 for example. You can also easily use the included Ramses Scripting API as a Python module to develop your own functions. Technically, there are two ways to extend the maya module: Easy: Register your handler functions to be triggered on specific events Advanced: Fork the module to add your own methods or replace existing methods","title":"Extending the Ramses Maya Add-on"},{"location":"components/addons/maya-extend/#register-custom-event-handlers","text":"The Ramses API exposes several events to which you can hook your own handler functions. This can easily be done by implementing these functions in a simple Python script and registering them with the settings of the Maya Add-on. This way, the Add-on will automatically run your functions during these specific events, like when opening a file, publishing an asset, importing an asset, etc. The list of available events is documented in the Ramses API Reference For example, to run a function when a file is opened with Ramses, write this simple script in a Python file: # modelling_scripts.py from maya import cmds # The Maya commands def on_open( ram_item, file_path, ram_step ): \"\"\"Ramses will hook this function to the on_open event\"\"\" if not ram_step: # it seems the step is unknown return # Check if this is the modelling step if ram_step.shortName() != \"Mod\": # Do nothing, this script is only for modelling! return if not ram_item: # The file being opened doesn't belong to a valid RamItem return # Show the name of the item being opened message = \"Congrats, you are ready to model \" + ram_item.name() cmds.inViewMessage(amg=message, pos='midCenterBot', fade=True) To register this function, you just need to add the file in the script list in the settings of the Maya Add-on: Because the function is named on_open , it is run each time an asset is opened by Ramses. The Python script can contain as many of these functions as there are events available. This list of available events is available in the Ramses API Reference , along with the details about the arguments which can be passed to these functions.","title":"Register custom event handlers"},{"location":"components/addons/maya-extend/#fork-modify-the-module","text":"","title":"Fork / Modify the module"},{"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: 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/#events-and-handlers","text":"Ramses stores a list of handlers for each event you can extend, like Ramses.publishScripts or Ramses.importScripts . The complete list of events and their corresponding handler lists are available in the Ramses API Reference . Each handler function you add to these lists must take a few arguments. Read the Scripting API Reference for more information. Once the handlers have been added, they are automatically called when the user interacts with the add-on and wants to update/import/publish\u2026 an item. Read the Scripting API Reference for more information.","title":"Events and handlers"},{"location":"components/addons/maya-extend/#adding-your-custom-handlers","text":"To register your handlers, 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, you may (or may not) remove callbacks provided by the Ramses addon, # to replace them with your 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 handlers"},{"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 handlers 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 RamShot 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 handlers 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 handlers 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 : 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 Format 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 . When files are imported as reference, you can force a reload of the reference after it\u2019s been imported with the Auto-reload reference option. This will fix some import issues encountered in complex files in rare cases, where some connexions may break when programmatically referencing a maya file. But it makes the import process a bit longer (the time it takes to reload the reference). 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. Note that in some rare cases, some connexions between the imported nodes may break if this shape is added to this group node. This seems to be a bug in Maya, and in this case preventing the addition of this shape by checking this option is an easy workaround. 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 autoreload_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":"","title":"Importing assets"},{"location":"components/addons/maya-import/#format-settings","text":"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 . When files are imported as reference, you can force a reload of the reference after it\u2019s been imported with the Auto-reload reference option. This will fix some import issues encountered in complex files in rare cases, where some connexions may break when programmatically referencing a maya file. But it makes the import process a bit longer (the time it takes to reload the reference). 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. Note that in some rare cases, some connexions between the imported nodes may break if this shape is added to this group node. This seems to be a bug in Maya, and in this case preventing the addition of this shape by checking this option is an easy workaround. 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 autoreload_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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything. A typical Maya prodution pipeline This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case. Configure 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 . The Maya Add-on can export (publish), import and update the assets across all your Maya projects, using different file formats ( maya , alembic , etc.); but note that sometimes it\u2019s easier and quicker to just save a project from a step as a new project for the next step, instead of publishing and importing almost everything.","title":"The Maya pipeline"},{"location":"components/addons/maya-pipeline/#a-typical-maya-prodution-pipeline","text":"This is a typical Maya production pipeline, using Ramses (or not). Sculpting and texturing steps are not covered here as they\u2019re not done using Maya. Step Import Publish Notes Modeling .obj , .fbx , etc. from a sculpting application like ZBrush \u2022 .obj , .fbx , .abc \u2026 for a texturing application. \u2022 .mb , .ma or .abc for the rigging and the shading step. \u2022 .mb with just the shaders if the mesh is published as an alembic for the rigging step. Basic shaders may be useful for the next steps (like the pupil in the eye), but alembic files don\u2019t contain shaders. Shaders need to be published in a sidecar Maya file, if and only if the mesh is published as an alembic file (which may be lighter and an easy way keep the data clean). Rigging \u2022 .mb , .ma or .abc from the modeling step, optionally as a reference . \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step, optionally as a reference . \u2022 .ma for the layout step. If the mesh is imported as a reference, it\u2019s easier to update as there\u2019s no need to transfer the skinning data. In order to avoid nested dependencies, the reference then needs to be imported before the rig is published; Ramses does it by default. Shading \u2022 .mb , .ma or .abc from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .mb with just the shaders. When shaders are published with Ramses , their association to the geometry is stored using the node names, in order to re-apply the shaders to the corresponding nodes at the lighting step. The name of the nodes containing the meshes must not change after the modeling step. Layout \u2022 .mb , .ma or .abc of the assets from the modeling step. \u2022 .mb with just the shaders if the mesh was published as an alembic from the modelling step. \u2022 .ma from the rigging step as a reference . Nothing to publish, the project can be saved as a new animation project, and a new lighting project, which will contain everything and keep the reference to the rigged characters and props for an easy update of the rigs. Animation Open the layout project and save it as the animation project. Import the rigged characters if they\u2019re not in the layout project: \u2022 .ma from the rigging step as a reference . \u2022 .abc for the lighting step. Export all animated meshes and the camera. Exporting the animated objects as Alembic files helps make the lighting project lighter, by removing all rigs. Lighting Open the layout project or the animation project, and save it as the lighting project. Remove all rigs. Import the shaders, the animated meshes, and the camera: \u2022 .mb from the shading step as a reference . \u2022 .abc from the animation step. \u2022 .exr to be used in the compositing application. The lighting project is the same as the layout project, where all rigs are replaced by their corresponding Alembic animation, and shaders are imported on all these meshes. There may also be a Set Dressing step, where small assets are assembled and grouped in a bigger scene. This group of assets can then be imported in the layout project. In this case, from the layout project, either the whole group or single assets can be updated when needed. But the group of assets from the Set Dressing step must not contain any rigged prop or character, as that would lead to nested references and should be avoided in any case.","title":"A typical Maya prodution pipeline"},{"location":"components/addons/maya-pipeline/#configure-the-pipeline","text":"\u25b9 Configure the pipeline in the Ramses Client Application . Scene setup Publish settings Import settings","title":"Configure the 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix. Arnold Scene Source There are no options for this format. OBJ You can choose to export or not the materials in a sidecar *.mtl file. 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 world_space: true add_extra_attributes: False attributes: # List of attributes to include - '' attributes_prefix: # List of attributes to include (by prefix) - '' - 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. You can choose to export the geometry in world space or local space. 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 . You can automatically add all custom attributes. You can set a list of attributes to include, using their exact names, or a prefix.","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/#obj","text":"You can choose to export or not the materials in a sidecar *.mtl file.","title":"OBJ"},{"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 world_space: true add_extra_attributes: False attributes: # List of attributes to include - '' attributes_prefix: # List of attributes to include (by prefix) - '' - 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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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) color_management: ocio_path: \"C:\\Path\\To\\config.ocio\" rendering_space: \"ACEScg\" display_space: \"sRGB\" view_transform: \"ACES 1.0 SDR-video\" All parameters are optional and can be omitted to let the scene use its own/default settings. You can use the ocio_path parameter to set a specific OCIO file for a specific step, although it\u2019s not recommended to use multiple OCIO configs, and one should just set a single OCIO config and never change it.","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. Known Issues There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves Features All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu. 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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True ) 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/#known-issues","text":"There\u2019s an issue with the Maya Batch Render method where any module adding its own shelf prevents the Batch Render to be processed (as explained here ). There are several workarounds: Use a command line for batch rendering: \"C:\\Program Files\\Autodesk\\Maya2023\\bin\\Render.exe\" -proj \"S:\\path\\to\\file.mb\" Or use a plugin like this one . Or move the Ramses shelves folder (and all other shelves from other module) from the folder where the module is installed to this folder: C:\\Users\\UserName\\Documents\\maya\\2023\\prefs\\shelves","title":"Known Issues"},{"location":"components/addons/maya/#features","text":"All features of the Ramses add-on are available through the new shelf and a marking menu tied to [Ctrl] + [Alt] + [Middle Click] . 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) When importing or replacing items, you can change how the different versions are sorted using the Edit menu.","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 . It can take two parameters: updateAll or -a : boolean. When True , the dialog isn\u2019t shown, and all items are automatically updated. updateSelection or -s : boolean. When True , the dialog isn\u2019t shown, and the selected items are automatically updated. # Python import maya.cmds as cmds # Shows the update dialog cmds.ramUpdate() # Updates all the items in the current scene cmds.ramUpdate( a=True ) # Updates the selected items in the current scene cmds.ramUpdate( s=True )","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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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) 2020-2023 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', 'mariadb' or 'sqlite' // Note: with 'mysql', the minimum version of MySQL is 8.0.19 $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; // Compression may cause issues on some servers, // Set this to true to deactivate it. $disableCompression = false; // 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 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' or 'mariadb' 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). $disableCompression allows to disable the compression of the data when it is sent to the client (not recommended). Change this only if there are issues with the connexion to the client or if you know your server can\u2019t send compressed data (using gzip). $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-synology/","text":"Synology NAS It is relatively easy to install the Ramses server on a Synology NAS server running DSM. Prepare the server Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin. Install ramses Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Synology NAS"},{"location":"components/server/install-synology/#synology-nas","text":"It is relatively easy to install the Ramses server on a Synology NAS server running DSM.","title":"Synology NAS"},{"location":"components/server/install-synology/#prepare-the-server","text":"Install the needed packages using DSM and the package center on your NAS: PHP 8.2 (or more recent) MariaDB 10 Web Station phpMyAdmin , to make it easier to manage the SQL databases. You may create a specific web portal and web service for your Ramses server. The web service must use a PHP 8.x version, and should use Apache if available. Create a new SQL base, along with its user and password, using phpMyAdmin.","title":"Prepare the server"},{"location":"components/server/install-synology/#install-ramses","text":"Unzip the Ramses server zip archive you\u2019ve downloaded \u2026","title":"Install ramses"},{"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) \u25b9 Synology NAS 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) \u25b9 Synology NAS 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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. Develop a DCC application Add-on using the Ramses API To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here. 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. Python API: source , download ExtendScript API: source (available soon) , download (available soon) 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/#develop-a-dcc-application-add-on-using-the-ramses-api","text":"To use Ramses right from any Digital Content Creation application, you can develop an add-on for this application which, by using the Ramses API, communicates with Ramses. Such add-ons should implement methods to create, open, save, publish, import, and replace items (shots or assets), and also to update their production status. To get started, you should first implement these methods and register them in Ramses. # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # The method to open a file def opener( file_path, ram_item, ram_step ): \"\"\"This method should open the file available at file_path, which is the working file for the given *RamItem* and *RamStep*\"\"\" # The method to publish an item def publisher( file_path, ram_item, ram_step, publish_options=None, show_publish_options=False ): \"\"\"This method should publish the given *RamItem* at the given *RamStep*, from the working file available at file_path Options can optionally be passed to this method to specify a publishing file format for example \"\"\" # The method to import an item def importer( file_paths, ram_item, ram_step, import_options=None, show_import_options=False ): \"\"\"This method should import the files available in the file_paths list, which are files published from the given *RamItem* for the given *RamStep*\"\"\" # Register the methods RAMSES.openScripts.append( openener ) RAMSES.publishScripts.append( publisher ) RAMSES.importScripts.append( importer ) Now that you have a few methods to open working files, publish and import items, you can implement the UI and options of the add-on, depending on the host DCC application, and use the Ramses API to call them. By doing this, you also enable the user to add his own methods to the on_open , on_publish , on_import events. All these events which can be implemented are included in the Ramses class . # Python # import ramses import ramses as ram # Get the instance RAMSES = ram.Ramses.instance() # A method which opens the working file of an item def open_file(): # First, show a UI to let the user select an item and a step open_ui = Open_UI() result = open_ui.exec() if result: item = open_ui.get_item() step = open_ui.get_step() # Get the working file. # stepFilePath() is a method from RamItem to retrieve the file for the given step of the item file_path = item.stepFilePath(\"\", \"\", step) # Trigger the open event in ramses RAMSES.openFile(file_path) # Ramses will run the opener() method defined sooner, and all other custom handlers which may be hooked to the open event. The Ramses API provides classes to handle all kind of objets (shots, assets, files, status, projects\u2026) managed by the Ramses Framework. All these classes are documented here.","title":"Develop a DCC application Add-on using the Ramses API"},{"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. assets \u25b9 list of RamAsset The assets contained in 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. assets \u25b9 list of RamAsset The assets contained in 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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 to use this low-level 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 getAssetGroups \u25b9 list of RamAssetGroup \u2022 string : projectUuid Gets the asset groups from the project getAssets \u25b9 list of RamAsset \u2022 string : projectUuid \u2022 string : groupUuid = \"\" Gets the assets from the project (or asset group) 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. getPipes \u25b9 list of RamPipe \u2022 string : projectUuid Gets the pipes from the project 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 getSequences \u25b9 list of RamSequence \u2022 string : projectUuid Gets the sequences from the project getShots \u25b9 list of RamShot \u2022 string : projectUuid \u2022 string : sequenceUuid = \"\" Gets the shots from the project (or sequence) getStatus \u25b9 RamStatus \u2022 string : itemUuid \u2022 string : stepUuid Gets the status of the item (asset or shot) for the given step. getSteps \u25b9 list of RamStep \u2022 string : projectUuid \u2022 StepType : stepType = StepType.ALL Gets the steps from the project 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 . setStatusModifiedBy \u2022 string : uuid \u2022 string : userUuid Sets the user who\u2019s modified the status. 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. 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 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. 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 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. setComment \u2022 string : comment Sets a new comment. 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. setComment \u2022 string : comment Sets a new comment. 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. shots \u25b9 list of RamShot The shots contained in 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. shots \u25b9 list of RamShot The shots contained in 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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) recentFiles list of string [] The files recently opened in the DCC application. userScripts list [] A list of script file paths containing handlers for Ramses events . 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 = None Sets the user who modified this status. If None , it will use the current user 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 = None Sets the user who modified this status. If None , it will use the current user 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users. Events and Handlers Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated. Examples Adding handlers with a user script file Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events Adding handlers when implementing/extending an add-on # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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 Events and Handlers 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 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 handlers 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. openScripts list [] A list of functions to be triggered when Ramses.instance().openFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user opens an item in 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. publishScripts list [] A list of 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 handlers 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 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 handlers 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. saveAsScripts list [] A list of functions to be triggered when Ramses.instance().saveFileAs() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveScripts list [] A list of functions to be triggered when Ramses.instance().saveFile() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file in 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 saveTemplateScripts list [] A list of functions to be triggered when Ramses.instance().savTemplate() is called. If you\u2019re using one of the provided Add-ons, you can add your own handlers to this list so they\u2019re run when the user saves the current file as a new template in 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. statusScripts list [] A list of 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 handlers 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 addToRecentFiles \u2022 string : filePath Adds the file to the list of recently opened files, to be used in the DCC app to list these files to the user. The list of recent files is available as RamSettings.instance().recentFiles . 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 string : currentFilePath \u2022 list of string : importFilePaths \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().importScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. openFile \u2022 string : filePath Runs the scripts in Ramses.instance().openScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 string : filePath , \u2022 dict : publishOptions = None , \u2022 bool : showPublishOptions = false Runs the scripts in Ramses.instance().publishScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. replaceItem \u2022 string : currentFilePath \u2022 string : importFilePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step = None \u2022 dict : importOptions = None \u2022 bool : showImportOptions = false Runs the scripts in Ramses.instance().replaceScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. saveFile \u25b9 int \u2022 string : filePath \u2022 bool : incrementVersion = false \u2022 string : comment = None \u2022 string : newStateShortName : None Runs the scripts in Ramses.instance().saveScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Malformed file name, can\u2019t get the item from the file. The file was not saved. \u2022 2 : The file was a restored version, it\u2019s been incremented then saved as a working file. \u2022 3 : The file was misplaced (in a reserved folder), and was incremented and saved in the right place. \u2022 4 : The file was too old (according to RamSettings.autoIncrementTimeout) and was incremented and saved. saveFileAs \u25b9 int \u2022 string : currentFilePath \u2022 string : fileExtension \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resource = \"\" Runs the scripts in Ramses.instance().saveAsScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. \u2022 1 : Saved as a new version because the file already exists. saveTemplate \u25b9 int \u2022 string : fileExtension \u2022 RamStep : step \u2022 string : templateName = \"Template\" Runs the scripts in Ramses.instance().saveTemplateScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. 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 = None Runs the scripts in Ramses.instance().statusScripts . Read the section entitled Events and Handlers below for more details. This method returns an error code: \u2022 -1 : One of the event handlers interrupted the process. \u2022 0 : OK. usersPath \u25b9 string The path to the folder containing users.","title":"Methods"},{"location":"dev/add-ons-reference/ramses/#events-and-handlers","text":"Some events are triggered by Ramses on specific actions, like opening a file in the host application or importing an asset. Handlers are functions to be run when these events are triggered. For each of these events, you can add your own handlers if you\u2019re developping an add-on, and the end-user can also register script files containing handlers for these events. When developping the add-on : add the handler function to the corresponding list, like Ramses.openScripts or Ramses.importScripts for example. Adding a user script : add script files to the settings (with the UI of the add-on if available, or programmatically with RamSettings.userScripts ). These script files must define a function for the desired event(s) named after the event. There are two types of handler functions per event: before_event handlers are run before the default methods of the add-on (before all methods stored in Ramses.eventScripts ). on_event handlers are run after the default methods of the add-on. Warning If you\u2019re forking/modifying an official add-on, the events are automatically triggered, but if you\u2019re developing an add-on from scratch, you need to call the corresponding trigger methods in the Ramses class to process all registered handlers. Ramses will pass a few arguments depending on the context to these handler functions. Handlers must return true or nothing to let the process continue, and can return false to stop the process (the event propagation) and the next registered handlers. Event Arguments Description before_import_item | on_import_item Trigger function: Ramses.importItem() Handler function list: Ramses.importScripts \u2022 list of string : filePaths , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 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. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 showImportOptions tells the script to show a UI or not to edit the import options before importing. before_open | on_open Trigger function: Ramses.openFile() Handler function list: Ramses.openScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None \u2022 filePath is the absolute path of the file being opened. \u2022 item is the item the user has opened. \u2022 step is the step being opened. before_publish | on_publish Trigger function: Ramses.publish() Handler function list: Ramses.publishScripts \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 dict : publishOptions = None \u2022 bool : showPublishOptions = false \u2022 filePath is the path of the file currently being published. \u2022 item is the item from which the user wants to publish a file. \u2022 step is the step from which the user is publishing. \u2022 publishOptions is a dictionnary (associative array) containing custom options you can use to publish the item. \u2022 showPublishOptions tells the script to show a UI or not to edit the publish options before publishing. before_replace_item | on_replace_item Trigger function: Ramses.replaceItem() Handler function list: Ramses.replaceScripts \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step = None , \u2022 dict : importOptions = None , \u2022 bool : showImportOptions = false \u2022 filePath is the absolute path to the file the user wants to import. \u2022 item is the item from which the user wants to import a file. \u2022 step is the step from which the user wants to import. \u2022 importOptions is a dictionnary (associative array) containing custom options you can use to import the item, automatically built from the pipeline configuration, if these options have been set. \u2022 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. before_save | on_save Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath , \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStep : step , \u2022 int : version , \u2022 string : comment , \u2022 bool : incremented \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 version is the version number for the file being saved. \u2022 comment is the comment associated to this version of the file. \u2022 incremented is true if this is a new version. before_save_as | on_save_as Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem or RamAsset or RamShot : item \u2022 RamStep : step \u2022 string : resourceName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 resourceName is the name of the resource, this can be an empty string for the main working file. before_save_template | on_save_template Trigger function: Ramses.saveFile() Handler function list: Ramses.saveScripts \u25b9 bool \u2022 string : filePath \u2022 RamItem : item \u2022 RamStep : step \u2022 string : templateName \u2022 filePath is the absolute path of the file being saved. \u2022 item is the item the user has saved. \u2022 step is the step being saved. \u2022 templateName is the name of the template. before_update_status | on_update_status Trigger function: Ramses.updateStatus() Handler function list: Ramses.statusScripts \u2022 RamItem or RamAsset or RamShot : item , \u2022 RamStatus : status , \u2022 RamStep : step \u2022 item is the item which is being updated. \u2022 status is the new status. \u2022 step is the step being updated.","title":"Events and Handlers"},{"location":"dev/add-ons-reference/ramses/#examples","text":"","title":"Examples"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-with-a-user-script-file","text":"Users can add their own handlers for specific events by just storing them in script file(s) and implementing a function named after the event(s). This is a simple example of a file like this containing a few handlers. # handlers.py def on_open( file_path, item, step): \"\"\"Triggered when an item is opened by the user\"\"\" if step.shortName() == \"LIGHT\": # Do Something here if it's a lighting step being opened doSomething(item) print(\"We've opened the Lighting step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") def on_publish( file_path, item, step,import_options, show_import_options): \"\"\"Triggered when an item is published\"\"\" if step.shortName() == \"MOD\": # Show options to the user if show_import_options: options_dialog = show_options_ui() import_options = options_dialog.getResult() # Do Something here if it's a modeling step being published doSomething(item, import_options) print(\"We've published the Modeling step for\" + item.name()) else: print(\"Nothing to do for unknown steps...\") // handlers.jsx // Triggered when an item is opened by the user function on_open( file_path, item, step) { if (step.shortName() == \"LIGHT\") { // Do Something here if it's a lighting step being opened doSomething(item); $.writeln(\"We've opened the Lighting step for\" + item.name()); } else { $.writeln(\"Nothing to do for unknown steps...\"); } } // Triggered when an item is published function on_publish( file_path, item, step, import_options, show_import_options): if (step.shortName() == \"MOD\") { // Show options to the user if (show_import_options) { var options_dialog = show_options_ui(); import_options = options_dialog.getResult(); } // Do Something here if it's a modeling step being published doSomething(item, import_options); $.writeln(\"We've published the Modeling step for\" + item.name()); } else{ $.writeln(\"Nothing to do for unknown steps...\"); } These script files can be registered using the UI of the add-on or by adding them in the settings programmatically like this: # Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # The script containing the handlers script_file = \"/path/to/my/handlers.py\" # Register settings = ramses.settings() settings.userScripts.append( script_file ) settings.save() # All handlers in the script file are now registered and will be run automatically with corresponding events // ExtendScript // include the Ramses lib #include ramses.jsxinc // Get the instance var ramses = Ramses.instance(); // The script containing the handlers var scriptFile = \"/path/to/my/handlers.py\"; // Register var settings = ramses.settings(); settings.userScripts.push( scriptFile ); settings.save(); // All handlers in the script file are now registered and will be run automatically with corresponding events","title":"Adding handlers with a user script file"},{"location":"dev/add-ons-reference/ramses/#adding-handlers-when-implementingextending-an-add-on","text":"# Python # import ramses import ramses as ram # Get the instance ramses = ram.Ramses.instance() # A simple method def published(filePath, item, 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(filePath, item, 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":"Adding handlers when implementing/extending an add-on"},{"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/getAssetGroups/","text":"getAssetGroups Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups. Reply JSON { \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#getassetgroups","text":"Query: getAssetGroups&projectUuid=uuid1 Gets the list of available asset groups.","title":"getAssetGroups"},{"location":"dev/daemon-reference/getAssetGroups/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssetGroups/#json","text":"{ \"accepted\": true, \"query\": \"getAssetGroups\", \"success\": true, \"message\": \"I've got the asset group list.\", \"content\": { \"assetGroups\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssetGroups/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getAssets/","text":"getAssets Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#getassets","text":"Query: getAssets&projectUuid=uuid1&groupUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getAssets"},{"location":"dev/daemon-reference/getAssets/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getAssets/#json","text":"{ \"accepted\": true, \"query\": \"getAssets\", \"success\": true, \"message\": \"I've got the asset list.\", \"content\": { \"assets\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getAssets/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the asset group is provided. groupUuid : (optionnal) string . The UUID of the asset group.","title":"Details"},{"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/getPipes/","text":"getPipes Query: getPipes&projectUuid=uuid1 Gets the list of available pipes. Reply JSON { \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#getpipes","text":"Query: getPipes&projectUuid=uuid1 Gets the list of available pipes.","title":"getPipes"},{"location":"dev/daemon-reference/getPipes/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getPipes/#json","text":"{ \"accepted\": true, \"query\": \"getPipes\", \"success\": true, \"message\": \"I've got the pipeline.\", \"content\": { \"pipes\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getPipes/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"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/getSequences/","text":"getSequences Query: getSequences&projectUuid=uuid1 Gets the list of available sequences. Reply JSON { \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#getsequences","text":"Query: getSequences&projectUuid=uuid1 Gets the list of available sequences.","title":"getSequences"},{"location":"dev/daemon-reference/getSequences/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSequences/#json","text":"{ \"accepted\": true, \"query\": \"getSequences\", \"success\": true, \"message\": \"I've got the sequence list.\", \"content\": { \"sequences\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSequences/#details","text":"projectUuid : string . The UUID of the project.","title":"Details"},{"location":"dev/daemon-reference/getShots/","text":"getShots Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence. Reply JSON { \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#getshots","text":"Query: getShots&projectUuid=uuid1&sequenceUuid=uuid2 Gets the list of available shots for the project or sequence.","title":"getShots"},{"location":"dev/daemon-reference/getShots/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getShots/#json","text":"{ \"accepted\": true, \"query\": \"getShots\", \"success\": true, \"message\": \"I've got the shot list.\", \"content\": { \"shots\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getShots/#details","text":"projectUuid : (optionnal) string . The UUID of the project. May be omitted if and only if the sequence is provided. sequenceUuid : (optionnal) string . The UUID of the sequence.","title":"Details"},{"location":"dev/daemon-reference/getStatus/","text":"getStatus Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group. Reply JSON { \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } } Details itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#getstatus","text":"Query: getStatus&itemUuid=uuid1&stepUuid=uuid2 Gets the list of available assets for the project or asset group.","title":"getStatus"},{"location":"dev/daemon-reference/getStatus/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getStatus/#json","text":"{ \"accepted\": true, \"query\": \"getStatus\", \"success\": true, \"message\": \"I've found a status.\", \"content\": { \"uuid\": \"unique-uid\", \"data\": {\"Some JSON Data\"} } }","title":"JSON"},{"location":"dev/daemon-reference/getStatus/#details","text":"itemUuid : string . The UUID of the item. stepUuid : string . The UUID of the step.","title":"Details"},{"location":"dev/daemon-reference/getSteps/","text":"getSteps Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps. Reply JSON { \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } } Details projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#getsteps","text":"Query: getSteps&projectUuid=uuid1&type=ALL Gets the list of available steps.","title":"getSteps"},{"location":"dev/daemon-reference/getSteps/#reply","text":"","title":"Reply"},{"location":"dev/daemon-reference/getSteps/#json","text":"{ \"accepted\": true, \"query\": \"getSteps\", \"success\": true, \"message\": \"I've got the step list.\", \"content\": { \"steps\": [ \"unique-uid1\", \"unique-uid2\", \"unique-uid3\" ] } }","title":"JSON"},{"location":"dev/daemon-reference/getSteps/#details","text":"projectUuid : string . The UUID of the project. type : string . The type of the steps. One of PRE_PRODUCTION , PRODUCTION , SHOT_PRODUCTION , ASSET_PRODUCTION , POST_PRODUCTION , ALL .","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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] } push Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited. fetch Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull. Request body { \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login . Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time. pull Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table. pull (single object) Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID. Request body { \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull. Reply The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] } 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 starts the sync session. push to push modified items (or an empty list to download all table data). fetch to get some information, including the number of tables and rows available to pull. pull to pull the updated data from the server. 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 This query starts a sync session. It must be called before pushing data to the server.","title":"sync"},{"location":"dev/server-reference/#request-body_2","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_2","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Sync session started. You can now push your changes.\", \"query\": \"sync\", \"content\": {}, \"serverUuid\": \"unique-uid\", \"debug\": [] }","title":"Reply"},{"location":"dev/server-reference/#push","text":"Query: https://ramses.rxlab.io/example/?push This query is used to push (and commit changes once you\u2019re done) data to the server. It can be called as many times as needed to push all the data, and the last call must include \"commit\": true to commit changes and be able to pull updated data from the server. If the commit is not done, nothing is changed on the server. Only one table at a time can be pushed, and if there are a lot of rows to push, it is advised to split the data in several pushes to the same table.","title":"push"},{"location":"dev/server-reference/#request-body_3","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"rows\": [ { \"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 } ], \"previousSyncDate\": \"2022-06-15 15:44:23\", \"commit\": false } version : version of the client. token : the token got with login . table : the name of the table with the new data. rows : the new data. previousSyncDate : the date of the last previous sync; this is used to limit the data returned by the server to only data more recent than this value. Set it to a past date to download all data from a table. commit : set this to true if it\u2019s the last call to push and you\u2019re ready to save all changes on the server and get its updated data.","title":"Request body"},{"location":"dev/server-reference/#reply_3","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Accepted data. Waiting for commit.\", \"query\": \"push\", \"content\": { \"commited\": false }, \"serverUuid\": \"unique-uid\", \"debug\": [] } commited : whether the data has been commited.","title":"Reply"},{"location":"dev/server-reference/#fetch","text":"Query: https://ramses.rxlab.io/example/?fetch Use this query to get information about the available data after a commit. This includes the tables to pull (which should be the ones which have been pushed), and the number of items and pages to pull.","title":"fetch"},{"location":"dev/server-reference/#request-body_4","text":"{ \"version\": \"0.8.0\", \"token\": \"token\" } version : version of the client. token : the token got with login .","title":"Request body"},{"location":"dev/server-reference/#reply_4","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"There are 2 tables to pull from the server.\", \"query\": \"fetch\", \"content\": { \"tableCount\": 2, \"tables\": [ { \"name\": \"RamApplication\", \"rowCount\": 50, \"deleteCount\": 2, \"pageCount\": 5 }, { \"name\": \"RamUser\", \"rowCount\": 5, \"deleteCount\": 0, \"pageCount\": 1 }, ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } tableCount : the number of available tables. tables : the table information, including: name : the name of the table rowCount : the number of updated/inserted rows deleteCount : the number of rows which have been deleted pageCount : the number of pages to pull. To improve performance, you can\u2019t pull all rows at once, but one page at a time.","title":"Reply"},{"location":"dev/server-reference/#pull","text":"Query: https://ramses.rxlab.io/example/?pull Use this query to pull the new data from the server. To improve performance, you can\u2019t pull all rows and all tables at once, but one page for one table at a time.","title":"pull"},{"location":"dev/server-reference/#request-body_5","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"page\": 1 } version : version of the client. token : the token got with login . table : the name of the table to pull. page : the page to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_5","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"table\": \"RamApplication\", \"page\": 1, \"rows\": [ { \"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 } ], \"deleted\": [ \"uuid-1\", \"uuid-2\" ] }, \"serverUuid\": \"unique-uid\", \"debug\": [] } table : the name of the table. page : the page number. rows : the new and updated rows. deleted : the list of UUIDs which have been deleted from the table.","title":"Reply"},{"location":"dev/server-reference/#pull-single-object","text":"Query: https://ramses.rxlab.io/example/?pull The pull query can also be used to get the data of a single object, using its UUID.","title":"pull (single object)"},{"location":"dev/server-reference/#request-body_6","text":"{ \"version\": \"0.8.0\", \"token\": \"token\", \"table\": \"RamApplication\", \"uuid\": \"123456\" } version : version of the client. token : the token got with login . table : the name of the table to pull. uuid : the UUID of the object to pull.","title":"Request body"},{"location":"dev/server-reference/#reply_6","text":"The server replies with: { \"accepted\": true, \"success\": true, \"message\": \"Retrieved the 'RamApplication' table data, for page #1 (rows 0 to 9).\", \"query\": \"pull\", \"content\": { \"uuid\": \"123456\", \"data\": \"{some data}\", \"modified\": \"2022-07-15 15:44:23\", \"removed\": 0 }, \"serverUuid\": \"unique-uid\", \"debug\": [] }","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_7","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_7","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_8","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/sitemap.xml b/docs/sitemap.xml
index 1a413bb0..818c558a 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -2,497 +2,497 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://ramses.rxlab.guide/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/changelog/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/credits/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-extend/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-import/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-pipeline/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-publish/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya-scenesetup/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/addons/maya/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/admin/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/applications/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/assetgroups/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/assets/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/filetypes/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/install/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/pipeline/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/pipetypes/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/production/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/project/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/projects/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/schedule/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/sequences/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/settings/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/shots/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/states/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/steps/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/templateassetgroups/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/templatesteps/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/client/users/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/files/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/files/naming/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/files/tree/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/admin/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/config/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/install-docker-mysql/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/install-docker-sqlite/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/install-src/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/install-synology/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/install/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/components/server/update/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/objects/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/enum/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/implementation/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_asset/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_assetgroup/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_daemon_interface/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_file_info/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_file_manager/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_filetype/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_item/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_metadata_manager/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_object/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_pipe/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_pipefile/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_project/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_sequence/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_settings/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_shot/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_state/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_status/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_step/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ram_user/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/add-ons-reference/ramses/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/create/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getAssetGroups/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getAssets/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getCurrentProject/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getData/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getObjects/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getPath/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getPipes/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getProjects/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getRamsesFolder/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getSequences/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getShots/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getStatus/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/getSteps/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/ping/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/raise/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/setCurrentProject/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/setData/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/daemon-reference/uuidFromPath/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/files/naming/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/dev/server-reference/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/licenses/gfdl/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/licenses/gnu-gpl/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/administration/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/pipeline/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/planning/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/pipeline/production/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://ramses.rxlab.guide/quickstart/</loc>
-         <lastmod>2023-12-14</lastmod>
+         <lastmod>2023-12-19</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 9ad984a4ea4b8afd3c0067bc616d61c457f85097..8f5129a3a41e784412ee673df2d23c7bda83bc8b 100644
GIT binary patch
delta 749
zcmV<J0uueY2D%0ZABzYG%fx|^2Oobgr3yh+D|#&I<BW_w*>&+NegOIQwUa<2ksxuY
z=ATQ#Vy%8!jn^~l+4<FzHIoO5NqcuWJ)50QC*-78+6|Y}-@mTAkJGEg$-G39C{OBO
zmoBGc&f!zvKR!OrlFnpBNHZUYKFP8Ek^0@i{&aRRU7Sqnr=4K?Yx9{KFBgC9EUBI*
z3Y#d+;*$|~v!Q53{k(4j_Q#8qtyhcl)AJAA*?D(%QHSh~?G2Noa04wPtrkjXv!3^R
zN4AjuMe<J5_DsePJav(j&WWeZ+u$8J{yd?ScPL6L)}o`QOim$*bv+t0k~ru<MmvHs
zmph}=h(u139Mx5(1Ryncsx*JPeuF55vf80oLoiy3tN|8`XL72uYlyxCC@~6lsSV|I
zAQZ25DGOsjv?z=49v3MXLiDQ0b~nQT{~?*Nv?$Tg3VBrw%4AElD&!>0WUGr>)^32|
zjvgm+v&cAckO?Lg%VdM8*A_2{e3m0!?UE?6x3+{A1nESrEC&p0j>JlS;jQ8MKoLX<
z@mOJJmEJA&0D|3Bke%}Ko?>U$X=O0!6|OUZ*;ABg;<fX}4{Izoh_(bJn8vW82evMM
z$G0+XKA}|SUFsq&DU<F27k}-hFhewNib*iI5@fx*)h<(93aB~R_^r^W_@zg5Tj9jO
zwD@?N-Zlil*sYTbjBF{3nh6QeK-uOaVCc5p1xRj_5{=Dx-|M*gd4~p$&3L2c4fg2a
z0wi;;U5}d!Tx?`QOSao)2o^aJ->}%0E&z`cUO{Cf&Nqoy-huMxRx{v!<GWk>rW=d=
zrNsI>-!RXQ4$;5XY6S}Xo%u7<L*^TiM=Y=o1a^rzcex!y|JV$@_LH{)E>_pkTh_S-
z`;NGV-1amuuTqVc<XWviER|s{bfp^tPbBMCdtPvxE<&Ah<l7wZV#T<k!3gKL-h}=s
fdA}L8Dq7yBEdIwU^_#D{C@=m3FCYQxH$(scvgL6-

delta 749
zcmV<J0uueY2D%0ZABzYGqYHbH2OocXXsZxZwW7zOKF-M4vl|z`;s=m#Upom9i3F*a
zYW}$-EY|9$)p$L#o}FJlS~Iz)n6!5n)3e#>bV5#grQLWj{r&5z`!Ky+oXkr!iSncl
zcIjfe%sG7O`-g{zS<;!T2x;cy*eAKHf24kQus@xBoGwl#_0vwU{k8ebjhBCmc9v96
z6NOEbX7SO8+u2yOqJG}D0sG@c%GRsJ`RVz)?(DofdtZm_j_nPTOW{TuBCQrmXtSR8
zdq=jA{#o*mrtO)GA9?B`DV-Bfo43I`a{PHhDeq8}R;)!wkC~i866<<2W+ZXYfsA$p
zWiGcyrzH|ONpe(InG%51+^K)k==u$!6v}FcVhzD)DY6DwFrLV%&aN@~5}?E=*g+f0
z>p&=8?NS!TfM`(`;XN)=Foft;k?n4V1O7uYV`)*Mp%wC~7?jDDXjRBbn8{WbwXEF;
z!(Dou$ju_-#6c#QR4kJXre0gTB=Sj)bhS&O$llr#UJ#@cwXz&BtT{^(`-QiL=RHLb
zCB$QeomF}_=n(|Fs~|h&<sHS&uG7k3(konN0<)(m(Zp-#jUU%oY!Gb;N-&LKMfYr7
z{+4fL-h4u-&b!n_8Yq+P0T+MGrZ7V^Z;DAUxDsT&yU{LF90b&yZ2VSeRQ%u(-Bvg;
zGA%ydrne0NFm~(Y0wY_>qGmz@G*Gtr2pGC;cL9>yq(oyg-uF7Le%hgdV>8~Ud4s+5
zZ~>Az*RIFS1uix+p(WdGGX#sAh;LYIOBaC039q0s66c%5EAL48b1O4&zwzBIebbFa
z{!(K7ov)eaM~CQNYqbIe{?7cF=^^vA$V)7+4g_|IId{1oL;u(ez4DW`0xnfo(OcHJ
z2K$b<hTQfvFt1XLmgHKkKMu+;7rN4ofhUsnt3A)SO&6g~Ir41|c(!6((O`sgTyH`z
fO5Sfqt%{a+DU1K{O8w@mF3O9)p<)ipH$(scg-CV&

diff --git a/src-docs/docs/components/addons/maya-import.md b/src-docs/docs/components/addons/maya-import.md
index 8ba2bbab..375462e0 100644
--- a/src-docs/docs/components/addons/maya-import.md
+++ b/src-docs/docs/components/addons/maya-import.md
@@ -2,11 +2,7 @@
 
 # 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.
-
-![](../../img/maya/importsettings_preset.png)
-
-In the first tab, you can optionally select an existing preset.
+<!--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.
 
 Presets are stored in a folder inside the Maya module folder. You can save or load a preset with `Edit ► Save preset...` and `Edit ► Load preset...`. When a preset is saved in the default folder, it is listed in the box in this tab.
 
@@ -18,20 +14,21 @@ Presets are stored in a folder inside the Maya module folder. You can save or lo
 - `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't need them.
+You can safely delete these presets from the preset folder if you don't need them.-->
 
 ## Format settings
 
-For each format to import, you can set some settings.
+<!--For each format to import, you can set some settings.-->
 
 ![](../../img/maya/importsettings_format.png)
 
 The text on the right can be copied to any [pipe type](../../components/client/pipetypes.md) in the *Ramses Client Application*. When importing an asset, *Ramses* will first look for these settings, and if they're found, it won't show the settings dialog unless the user checked the box `Edit import options` when importing the asset.
 
 - Files can be imported as **references**.
+- When files are imported as reference, you can force a reload of the reference after it's been imported with the **Auto-reload reference** option. This will fix some import issues encountered in complex files in rare cases, where some connexions may break when programmatically referencing a maya file. But it makes the import process a bit longer (the time it takes to reload the reference).
 - **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.
+- 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. Note that in some rare cases, some connexions between the imported nodes may break if this shape is added to this group node. This seems to be a bug in Maya, and in this case preventing the addition of this shape by checking this option is an easy workaround.
 - 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.
 
@@ -51,6 +48,7 @@ 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
+autoreload_reference: False
 lock_transformations: true
 create_namespace: true
 no_root_shape: false
diff --git a/src-docs/docs/img/maya/importsettings_format.png b/src-docs/docs/img/maya/importsettings_format.png
index 3302c64acfd3fa909edb031a5f63af3a3a737a02..efa2b717bbad713d34baab80df39012605e0e573 100644
GIT binary patch
literal 16997
zcmch<cT`i)zcxxox`2R4Q+h|~9Z?XGCS5v6?@E;ts(?tZ5m37H-dh5Kg7h9hO6V;>
zXbF%|-r)Cl&-uOgp7Wk{*In!WvDs^eJ!Q|Hna?xN=lLZ1wWbOg@dIKkEG#nBmr6QV
zSlCyXOZyH1CMSr>iwSeX_S8{%hE+AfxPwXH*(+)&Vqw)LkX%~fW70(LUK)8~VUhRT
zUf6x^B{rB$D@VOIUb=3M?=)<^tZb~jtT1_4SOKioE{^YByF0phd9q5I1h9T!m43|6
z>WBFY;QyNvdo1-|rbR>~{`JH^&)=ra0OGbbQCL`tajHs+dLPX97b)J|oB76dSj`^m
z${6*AD)}9$q#h9ghj{nE9G}sTQjd4)l0@l=pMA~Vzk107*Z(2i>XOkWM)afBQ`rqJ
zF7IKe!fMo9^{Pzgk!0lYs^ohQ&XC;>0z4!!{i0iJY#d(l8<%iw1~2#w9HH*3<*St-
zN+q%j?-R2_!2=cxGAuf0f`gQO7rke=8H+TsB4O2?ODJE|=?=G`pt$aYzJWoe@5)HF
zob!?+ouFyWHRzxXRuSyVa&z7{EW^smIsn<;=B_ereG8IDZL>Mg_S2lYx2zB>cui_J
zxViOKHZOhF0_^HS9#c|MZYVg~<Ve2n_6MC#s2Q-Kdngn{b(s`zsB_NouJ=Z-NiEQS
zW>}k-qd$G(Rv;rITWQ_O?!j~@d(WyFb?`mH!onh<^CGL$s*8)2H4|rGaB%$3pU+ys
zs7VM<fHuE-A<4}TLY9UXcPS~yr)r(1d11z&{Cw7XgA7tp7W(?OoYa_q=sgm+4uFGZ
zoc2uwuKZ3mGgOt7ltiZ&JO%|IiyxHB(iGafVFsz`>6xn6OCT@$PCvBVWi=bF0i7b}
zO!~bw!eFE-zhIVC?`<p74-FCSOC3fy!S8$LkFPgCYTMfkiqLkt;V(mi=HM`DxP|a@
zO#NPsLtmwIb0#Hv@*)Mzd!q~&B+jAcLAcCs-h?WDZ{tt^75;u;{-l!>`L&u^CO%mH
zI-VXgxcTKgI%8*^XI%EHS>B$9bVPs{=&BJ*ePpM3O54MCqe&9)p5h1Heua_MKOD0s
zeF~X*Uc!|={Y;KpizFhOxkB<Cf%v|9OLwGtZs5EM@q9-2_-TdAV->D;wCuP$f3t-K
zUkqAgKEgEB-{=hs?)%f|48ZM-O$j*6@!wTRs;aM#<J-Q0&5^XY89&)v`XC^0;>{Kx
z_f<ldxF=3x$zkbxz}cejQCfB2FaJ(|gp-%Iw-Frk{WyCjMginn3Rhmn%fK_?DiDb2
zjNi<u_k~DRZm?0~9t9aVYIL-fsNVfcy!8z-G~*d&l-4%LE`7Ry@8<{tpH$@vT{|wz
zU2f#RVw6V6*X=F(UYsc0c)CEri%x(+HDd@A1!+$1K}yB2Ty3jBV90rQEzN+FVTnq|
z?$%gODWhifl#N3E49;~6dbn+lf1<&)dobE$!50dE)IA&UOt%6G!IC`Ir$S<ZlejvD
z@W5{7Eha4`rS)~vzrC=2vYC5>L<8S>t;@D)W-I47t=t@((=!I2;avNjf6ZVENKm+z
zTnd28dHMJlD<Tit;Z2d9M{(}UrN!C8p4iZf5#I`S9N~R5^d?ByK`kT=i+61w@$#?<
zH&{g_s&S!yRNh&G?idcexq_O&ul8nZaR<`{dSZmYpV(C5->kW{?>E`dSA&q5u-v@w
z-+#5S=xhQ{1az8)xDXA^ikrZ;Iap$BBxc~KU56Bdw>n8zIxlq<mi*zY5ReyXXE2O3
zXi4VNu$j9t9Ww4$lk0p%umXB+)YuU)Q(<IHCLt=ie15dnzbt^QR}|wObdq(x2oJIc
z1z&6ckG2aEjNuXdLUfX|0**x8Yh*RZRzQ22AR(5|#j~*1R34((k5gI;-ZN(X{=a|3
zGBO@YV`Jvw&$;jLy<L`=_rCBgTr}3hmsKVc7U$h`$(3H{G%~6CNwz`fJuGzrIiEh^
zNa2FLc4XR77EASgLo{ZmxxpL6*Iw(7-`TLdpn%7ncK;4Bl5DmK-#6&=N>gLSem^RA
z_9k?Sb8BX6G{-%1qW{OU)DS*GGWX7_CWN{1;Y8i2GM|~INJC@e%Cw<{nDwVmpG4ie
zn&(0-R#lop6?Dd`+p6%+fHZ3s7BV;;zML2SCD)TBIl7U(CiW{!yK}RLaCq-2g<kng
z_Et}{A89q7ANp-8(A=NLPt&|@g5&AD8Qdc-<ZB8=Ta-40ZSiEp^EhbzG;Hq!`kB0x
zh0qM+?1qi;lG<i7FfE)MElNO1nUom0Z*hZQbHs*nuB}UpW%Rk>sc1JiO_z<^XZvxk
z4PW(Xky-CUy)z$K8mm6JK2W&ih`&@*a6?ZqUasC;T2z>U@7<sy6yDw_oMp6zR138;
zPzX$JHG3)wLa33g9+;I|`ZCN<oMNeeeI9y^oE_aUObfyp-Iw_!0{_;-(w49~kj8hO
zGYb01U~g)_`4Cf}cEGl)S(zLq0dOIB<=*jw6q`#kVVNSz|8Q>!ceeHBq5000q1R34
z+WD{o$nI~EK&sZ;Z}y3Jrlsu+v%X7e9&clI(_eVu@|2X?>i>P>&Dl=p%{AIC5mUH`
zRrP6K`u|X1{o%GyZ#Xm<M@u%zU#?|V-6QFO`9~cu`YL?)X6b0{I|T93*GwA%Z)UvR
z=93H3uN^xs*WzYdv^#@*W@E{{?kk{2MyGBty>zHke|H9M$km|e3eUk#=0Wd6n$>TJ
zX=#SL<zU%eY$+2{>2>?k7v8F03~uTOMNUmIn>tN8BR+ts!8@^`eP91P@Q{x?_@b|k
zaM}BzRc~<#?M<)6>UPNi&xhS+T)WE;k}y^wsglPjslO<yu$$BpekL4wTx{XColZ;h
zn$IAvH?-No$$vO8qy9_`dlBu^eDyZaZrt&-!w%<SWoBHa464b0RvH-xQH;o7_kMNH
zYTR($(vs;QLyUwb%`Q2{xKC|!JzO8|p?4UlfazQd(ZSNF%A9%dQ;gLTQ@0#r`B^$y
z|JpOlkyYrLRF4hKtLy#1V~XdsQ+AncPG5c=^DGlBW{Ze$!Wr3_r&}jmZtna*?-a&-
zL!WCny7&Hm^;x>sL_}b=v{aSCJDIq=&(+2!743u{F6cV-)u=EnirdYpu^GaHnTvxi
z?|FEbJ;Ho&X3KOr%q!iuQo~FNZi3kfj6wcPNdUm)eX$(7O%VP6l!(sPFE@w-|D9sJ
zt9x_x5Wcbu5qo1HOjr7agRcXdPCXTIt{WUDSv%{bo?@o|01d&F>gnmER+cYjTvCKa
z!-L2S+}~7QE6f!xi1SxI4wp*Q@2Y<Dxrq@7*Q@u(6?d5pX^Q3z`Sj_S$^?~?TTsx`
z5mUrki^T?Ddz1L(Q?6;a65?^2baO6Xlt(1~_#0zMWm7`XMsAHO&#LF|O}RT1GTfcU
zWD(pRX6{BWSi0t`*P$<$?#yqRX2c2?#V0GV9)Z+=f*C&oMMz>E3_fXqb8DKg?7iYI
z>%biz9;_)Tq@de{Sh;$#J>VO)gpN--1<8$8B%2&{;SM{vxF~I80BSgmY*5Cc<wtRG
zF|Q|l@Ai$(tqr%qv!kR2A3SCed2Fv*pg;110sM(9hfmnHFvauq*RSh7Evmzq&z~#K
zoM);UuR$IguYN}a(v+BplUymlevu7szCB-l|3*KRM{U05Ak?<(AWhPGpPFk+JdhLs
z@rd7VM2_=|EqrvUcP$01eG_UF>X`v%j<$|g0*ZVqG7g$!eHkO9%=Dr+KVCCbl$b<D
z^q>#>*5$Kz*L^L?M||g@hVYt6M@9{_+j@-YjLD5WGi>2=PG<`RdZeT?sYqGAlgv<e
zR(xx~CiRKfEuxILce()(c$IL4V-oC(?JFv_5_whD*w%>`bMP&OB;JqKVm3iwzf%)U
zHC16AgWo4zi`Wt>bL4#quu3Pgi}zLtz^aDJgugnm^>0$Sq8T>+*n6DUwal()ffHbF
z&y^i;AQc-QZ@l(h4N874ARqwgd{#tAaP?W5KWjPx%DAsMUP-YWpRZ?my^1Sgd6VvQ
z`R7b+e<6|?_EfQ{*%UcmjehNMM)w&0)BUhJrqnfHMFV7m3OwG3t^-d6jsU>w0Ok>Z
zxk8<qmI!(@SPsHY?9p~7ZJ6xKv@gyE8Of6lc!E=o6nS<a`CEH@av490uFo|Mu1w5t
zIALDQT^ZhZ%nNhfgGhyU2*{6%8G%V1!m_p@`dxR;tKSxf<!Y(NE_UY77h&1y7r7F<
z;;j@dlV{)Rmv#`x(3#^!Pdu3m2GwhGgO5S+D{;kp^2N&l{u8uoy|r9br%Cg|o}ou_
zu7%|yx<?WcKrAWtkrEN)@G`D$379WC*C-NO1(HL#Y6+o|C%u}R8aomlZAlV$6@ArD
zcIQF`WQL?gYH&d!%ku)4+)fW*PbSI-cX#%mdv_mHGjxx=6U%&thJT%ZI8UM{q1tRg
zvO75N+T4w^_2V#|H(&)VD>Y2jXub{!2bp!@Agr4$Z4}mr)Q5LDQ+>SOVo=d+oiiR{
zc+U4?P`V5~rI=CCgJMvKklWt{k-E=CB%xj)qUQ!)TP!&bz@BF~8{ZRis9^aa=)5R1
zMVnDuM($MjU?#e1f<Q~cmBOdQ|Fj?a1(vFp+I9}y+BDblPN|Opk$!(JGmQ;nZZr(r
zrT5MXYhrteM7O<l#4U@OhJO^hcP(W+KV5pAyK9oTt$$K-)-z2cq9vZAJ1dWb+8JqW
zcFsrtss8DSqV8fi+)od-8wn{f*ATW0rbGZ+JWCWcV*C%Zf+<hwf=R*>Og!W)I9rXi
zI==486<srz4J+o!=Mu|*itC2ws+Ss7-dtDE>ZRiDmRypX_W9qv|6OpLJT-iVdLvf?
zIKO_++oC)?oR-HP*LdK2vj$7<n`iPW&h0o1T5~SCserx0n@!=HMa`+8?>zTU2b1Z#
zcG#fSW5E`3+xu!7&o#QA2;g2EE1egl3kKSUj0!IE>2S4A+nTqd%9336_==HxN;B`q
zC_+*K9U12txMxnJE(Ao<5sAMp*yOa=-9c7&zCoZl4Y?jX+g<wjEksgx7zaZ=?sxiY
zBE|jYHeL=k^LRgkw#fInH1W)!XMGyaU{hlF;n$B}3}j8Se3m}0By963iVqC%c`0ES
zBj);Cx70Z^Oa5sh+qR3lb3HBqf^AW%9aRe`a)zewt^z%cHt)=M!6S7oGQYK<HCgrv
z0gpW8a#8}{Gocqy$`1zpxy@!3E97flHHFz^`oU=5VTlVD%5!kMYkizC=)=;Yd8uf5
z9_mr%;>-4fuOmAJq_J~)RyO75|JF3e+GqYA=t;8K8f+InQ)>TNF47Rk8aGmUo(=EU
z!VVm+qN*BAKd^VaG5AHsw~C(i^8orxpl8CHuMmIzyd9XH{gs&t0N5@UBs({kgggSN
z%Pimb5!^EL>GBn*ad9`=#4>bK)Kl5Eg*;{P`TmU|UEeLF!lR{}dOu*``R*zJu4|s0
zZJ7CEdRnK=lSO)lt>?459PYrKS<W*bN#C!{ON#UM!!Cshz!<18E#q^0^xX#{LGf1b
z0yo{R4)UG(y*IsR->g&(rptkc3di@&39c9u%g^fl8U%AdTB#IOBXIojX<>W}O4HUO
zMcor3MPY2-lOOy6x3}(G%yH))H6{;VaYR8yLt2;Hqme8F8AnPtP?<N5j5e(lZ0?Ac
z(=Dq1>R@ZP*$m~n@w|Tn?zi!1vd+g~zVUlp2~HZFWHs-0ivRRKcOr%%8~V=~Ijy1h
zkWgx&bv9nCV@pneMLj^MuGJ8PS;C0Tc>5W-fr$r1ox#!oW}ZGjv3B+5C`14(8>xeq
zf45a5yFE~?ULW7!|LST#pz#V`-E<&T4V0<-c6NZCo@>npKG6wIum_ExQQ^BOU}$7}
z+f*AZ`&m>lz$JP41v6QB)K?g(g{EY4KUzKFaDRWEL+d*U@4Soi?=7jRR+bHckt@UB
zIpGDGpO++#N2KJhj7Xit;ybNO{I3>ZBunvAf!*3Z$1;=~?r+~>%%NYlZNjIY+U}bw
zIkCx0dyyH!^hNehPi<U1$zaDiMs%PaMO%VtPYPtAYf4J6LI0`nLIzvTz7%Cm^};-5
z6Le4gE7zt#56Clw8sd>rXPVt}6ppTO&*>Ohh7cY+O%k&x+E}nX;4}WX88MS3EaF~0
zl1i`F<k@a34-ZN_Tl(ACLN4S1!{{~HP*vGYr0xU^I57JF%(OIAwF8YF3Z|z1j#a-$
zsr}ih@to5(I{C{_ukb&EDy!;G+49*7DHRc<Yzd~{N<Q*gp#>T>FzXxmB6r1*g~E?2
z58>eGI48xz#L)D$UEPeugmxZg;v;x(d24yKKDfZnFz(Wqp@}I7%`@-%Ti|wX6(98%
zd?*0d`T4Vq&z7*{t7@qy4+?X*KbPk)B`Qmx{Ibm1<3X=HyVO<Znb##B)v?x`Q*|Kz
zczY`Z@5phoNIB@q_T<mxbfu!7>_I2n@B0l*45E$mQ!_yQ8ZE0v!M!$$%#VoN!hj@v
zA~E|20TUsGrqRjDTzNv^dmBS#r`AIob;XkiIM<o@@79}sDJ%@y<h?Uz6Qm~)9h*V=
zy>TT4`+acEPP|_ANAEaYCGCMz;(5*s%2Y&yWZf%*v=uWgar8iceb5XNJ>93+=3Smu
zXCc@y^a(9m<I)&dIO<6ZAeYa#H$)JR%<j^PT8sq^1TlC-8^X6jyynzM<jWG|QQWeF
z*=edy*zp|I!oy0}pZ3aChfBT=deg62u!uO1E7euiGzmkL$*4prt46l&BF-Fzg91FG
z5>|$FX`=D(?=TSU(X!?VjU}DflAfpXQCWJG^XtOmIjIz)qI=SV$k&^`3!N>9zbygL
zMK^iuX)rJPCvfkt<f2_{+n}IQbAP#sVA`D^XTysi7zNm3u2J1G{)`)O)NW|B<hP|Z
zEpv=iZgHOlVel8FcF<cjg{T)QDr}w4^x11H3+d!M<XsAx<LI?w2PX5@Kb!fMH`{qr
zztSJ8t9r2b9mnWIhbBHeHP6d|tLY0asSz!2qTAfWt?`8Rc@k9Lq<Y(yfsOS?zKfNO
zm9(bs=qt{~Y5_~-4_uq9UEhHU+$`vK2LrsXd=Pm<x@S&Ad&0x_?sqV==3oBI&9VOn
z8HB&ma%U-{rY`^|sGk-2OTqQY+M1_$dQbp3J<{k!=Sh+)KxsBmd#0G2_1OV~re?iT
zB^{;qwdGk5`OCAQ|Jai;2demkRd)1~xFWPvWq?IwPmy2bBRV2Txp?JUZ`CL{fBi^T
z%0WJfGg7YhaW;PHH}TLKSK+M_6HW&?>a9Oo0zbrTAJK(Sji(;3yi*Xo-bti?pdcS9
zp|TD}udZ%?<DB@V;JK+Tvi|x+N|Y|EPs%u9Y9UG_ZTRKA{hskj<u8pT*c&~^OG8<K
zro|_<iFNst+-0Vbf9L^{4swIK!zS0XL1%qylD-F$<eA=R1%G{DeeQ4mto5%#Hdpnu
zc}I~!9o#UV>G68=8ByJjw)}{s71PlzM&#cP_K=^$!DvB2^N!zi7J<K(#ny_5@0rQq
z0&iTqE~#P@WFvtBSB$^))hyf;)lU7h-8jrPqRj!!MoWWoPTii5Oi}yJ6I6`>WMAq2
z_+2!-sWc(baDVEc6%Iu)t%2xZQZrdA&%k@If^{$XPOE_SA>{xtEaN^4dhZqAG6ne3
zQzY_JQQO7YHU2BRp`Yk#dHdejgoac4Q_qLKi)f|m`=`;X_N-y@LhFOrJ7vJ9%!rNo
zMvO@j{c-=)^J!R1!$JWV^USAhr~l?m=;6?Xis!1eTaW;*zm-Eue;#^Qwc%tEO-%R?
zt#Bxh*>bp!`}ufV{c{Wtb;ZNrlQ}VBT7h(f_Atm{*TL{?3y7t_fX@eC^MJYQc%u>0
za1d|cvM2<<ENU!uOeP&rpYI_1@PXP+!9CsaO+q{kSM5dZ{&sWvyR7z2A{S$M6A<i$
z3d~^djE7CX`BYk=sMop9l&^xLt$p0g<oj+N<vdzr@z1oVQAInhYuQ_*PuW{-6Yt+;
zED+h!T^$aQyaJ8s??G~ZVC2gTkV|nDsn1nC0teo%frNa)WlbyZRW2Z4KXtM}osl-5
zTz$A{{?`=%%I_5pxDXPD8rZ}N<u+Ala(8*|>|E~eZMl4%R-%QBG%W4%f2sxBe&Gu9
zrzvvrH_pmvYVl@zU<%s4`miyE<pevW@^r82?#eR^#0BGZrkzogSqgb4hPZnIEm{|<
zO#Hv?`-@e$E2j~6K^ky*&ohtmt*(rh9gW;Xd<?6)fGLaD`X$n>WR(!?=(54%P(3r8
z6yt+F1AQL}f|>x&^0nOO)#VxxnwAPqZ+-k7lwResBM$E!3{r^DZ0w$wksf<gIg-!2
zAlpYC$(t)@|LpJ@m$$3bvA>IbvdwGIP(wy`*HjZ0ym6PH%*|l`xV6QT=-oEWO(MnD
zuKv(p4rV#hg<}gF?E{C9xiUlCT_-}FjW^y+rH(N%Q=w|@#&#*vUrM_7OorI?HOt&|
zfX2RNNOv(1j`p^<ZMNZV8TqTJ&~W`6UVFf&W4iDl^CWg5U&|#jyLamO6>M}HN+QnM
zY!4V1-uKzuOJ84<r#COWR=`(1G<{E%(7a>d>D%y|R^x_G@*_t}{fZ{y=J}o2i=qwi
z#X2z!);AClcCV?uW7@nNp2wdb?uz=rK4V?)_bh$uUk*54PWQ!f4p@_-L__WJI`(9j
zq#Jy7gvaq^;tB#1%5Jo@apB7X(ZOWiuj8zuc==m(CHA+fj6(ll+b^d(dOoZlH9O(p
zXV#mnNRw2hQ+V9&)+Bl|{kr9Pf4(N5%dOFV*~H%Qd+{#+q|PE*xKh|?OFh{;DH~tv
z_iKS0?!nd_;S_=M29)IPE4_#JPf5ZW^t@wQpHxO1d};bUpFTagP++_8EY*r&lfTwv
zS@?jQ-`I=r0sKo8!&LCeLCv6N(*z>$WK-ZcgJ9vYmVkR4(4evXs~(frx6{BSNJ~9=
zyp?YJqI2RO%})QeL2tL5cK(3YQ)#7nu<WD7%@`AJLqDc>v#}6@$B)rg)2sVkMH^iQ
zt|Kvrr=mt~lgF$bHT#C(tr|3x{;8|0{>vF~BFUb*#97zLCTsKEP;Z0EQ`h#;jjRgk
z!3MoEa3(T^?y>(3r>F755*i`8neV&D<zv(*==ZtpuV`jMxd2+f%Y|=_9@Cl>-wWJb
zt8h+bCeN4cDnG+)KSoIQ?V%qR&wVs~HNqCZo<w;$8y!!NN+moeOn7dW<VbQvfHZDB
ziU7q+ghY^pN-V%8IyQbEJ~O>Z=jl-{O0)j$!~?q+h}7`Yq2pnd8qOZw6i}fh`a|o^
z#MtwEqs6+PG4Qb0oKa3e3zQSuJYjq=atzvNixQcBghFa$@73@5Rg3!870(%dC(PnA
z>=qg~{AK@nLn+my!(SoYi|*nukp>hp`TTyicBDr+wo}_Eda~#BTsOy;qjZZdidF9C
zFT3iE8z-E=%p%ET<|=+V!1aa`$zU)k$)rES*X}0e54)BWIWh?p6^L?eNPr3e2S(5C
z$<zx5==Pgd_)W||w`|VW6>@xJ4|Ua4G9(GVP8EF)8d*aPQI6#-q88if0?xpBI2QM|
z-d!%6GfFGiAGdY(>5bO55zk8qdZ=Yu@L9}Gb{k)y!deVwq-|QKBAkztO%}V+#Gklx
zFnA3#dH+FnsBk-vbUCB#R#YBC*#yc<T}?+|PJ(>3l3vYptFZp~hac=TR6kpcHPf>X
z+GVm8ZoFVMFZ{x2#xv0S4pbgv^m}u2d{6Nm41kS0ujB!zWPy+EqnVoz{W}nm@;TKe
zIq{C!Ra=uP6jm+j8fvg)NT`r^UKZwS0tKdE{3<_b8@`^T`wRW}O0h&NTY0xb!20f+
z(ZhWP6Q+Du7D{dTwTM8e#CDR4PnWjAk1P(vD&S9@1sD@1hwaCO4A=(@I}(Mo`aMrM
z5>)_4t!TXur<2EfDiGmVDjLqF(`e$SNFv{%eIK7y`Wca<Z+bB;fC%sU4ozXU(XT**
zI*}w&ogN6ciU+d_4&%3XFPdvMB7J1A<7FwJtzescM*V|+x&<P?OKP|zP&Lgy&KYB1
z+HkXNB;svpKw54;q_=$Jk>mzN9HU31#T;jkGEH4}sFPHJpLR28t<pO$Jv?9+*@?DU
z=y%-fgZfi17iPP!sfVl?<#1`oi|lAkAE%W;GWm7+2&sgJ@fMap%9xL!nxy<W8Rs3z
z2xH7?wXLi$=+|p$UCcm-A?K$^D0}~q3FqS%8tl|!*zxv&?2E6e!8$~tL#22!MhP6b
z9akpxFCAeEBaf}-U+B$ZOf#{O<?#bR4q%;KQm{?g9U8;JsOzmJ{U>k)VN2eA-LVnp
zEvKz+XQY%8rI=GPhR?a6ou`n+E}32uZIjR0rCKTEPuOa~gfo!hiAwSp>F}cOr@fR+
zM&G5OA^_w+qy5tHLQq}AY*#yZnO#|fy<qc%v+IfOf)0#CD|L+>bdTwN4b0N^_X&@X
zmz<CAH)MzkemO!8GoxinX1?53!)y-9!L=XFZZy~K7YOKZO{hzvINPBfUmrkBqa_x-
zs7+9<53z&)G&m+%%rQQ^yAio~tOfeQAH^MX|CDQdQcJ;giBdzHbMVn;nWj@NZ3FC1
zJ24EQn;6(AQ2Cg;w}7BrqTvx&Ifg9``<bgiRLCbLOmwc%RV83j^Q+^}*;ip|j31%5
ziaqINAbjGxnq6Y=vypK+Iy8%dYL^i2guUiWm6`KZz{WsY2+0L+jhC%}=H;sW2Qh(|
ztcEGWx7r&_4q&wPwhVX1ip_$ts2Z|)KxEeUv>{WgvfwYVN5Ar*7DMn7CXDKyh~@pU
zIh<T8#OmDm=9N+Z%Iy~}g{TaKYY>%YT|GHf@0THV{cKUX!WEgmV&U^^LcAitGQ-%O
zV`NX}^Q63YiEKTEKQdSPPA38lG`dp+{o3^_hVK2rxwGBShu;@ho!tuu3b|bNK;SIw
z5)co`Xh&c`Lf;v)d31Y`?;1tx{4x=BC7Ak%UI*Ojc<ss!-jp`=-y##S3!DYzJTE9H
z=obw16B4rTa(8r8ji=B{>cU}s?rzxwz9r9UzXK?2(le(GfLKi~J4%L*;X7@&6rGRI
z55d?eiL%!-;Y_;#mdNqxj9sZii=}c>#0JP8(2ja-SE+TLW-Wr)+r#-!b}f2c_S$wP
zw>IeKsmI>y#->)->%|6XYbKkkX+ZmF1CzhTcoVRQ)~{_T7m@p|yCpJjY*#HJQc<Cg
z{ZK8p`G&@aB=|D&J-?sQ>u@D8J*?D|Yk?9WzUO|ea{XY=r^aXBxzEVl9u2ma;6{Kr
zFOjEZxP*NuoWUmu+5cod=TGp`<UZ!DIEhwjGRZs4K@=hIH@#He0VHwk3rT&y{HuQh
z)0b1?w^rtRj;q-Vj+T0=dYk7Bk;OvIL02i;A3WlChhyuv8V~Z$*aj~ug-XEPwL>Ur
z5y4MWKZ?!!H#SPKg%g5AYh7Td^<m`F#oqgPgi-y#ap^@eTD8f3*k8^ZWW%6?lm0$-
zvfz@Lm;J;KR*sxWv72kC)7h-@>)y)1(J|C&z2|H{^3`fA=gv|H%bzyi<gPbOSkX3z
zLrTpH-fF%i6$F)dKO!G_WkTF@vY&*E9&6j`$Fp?Sc@Kgx+$6qTyBG^AOgh#&;KTs4
zJAHe2-S5EuLw%YgOXD~Tn?HD#ys$g#DVL}41Jy6OjREylK#;t1(=w_pT?(s@`Z(+(
zJF=D<zp=j{8qw57h2Oea|AH?bQEC+4tjk3_F~6yCuYtBPO6D}^RPEk6@91DP*eO_!
z(>o0)Tf?ny@Cw&pNulI(qF+;Y(A#&Y>#;Q+FlN44`_O>}%0t|Dewgo2x|@I2Td4k_
z0}XO;qybumLMgj{Cr)1_WPWtIA|Nu7FMGLhP9%h$%Ko<fzz4}#xLNt;PspxSAJ1K=
z^m(NM;e1wgAoYRGb6*~=l<}9xS!EnA<?v@xo^n|WKM>QZw5AUL_<#aou=>~_I#%{t
ztzIR?pcCaqO`6nwo2N@kiW6e)T$FVmAl5*jM*hPcnwm4iI({xcm&3OWRi4N;rA3x|
zTrN9WSTbYwEQgJ{0e{B*T(FIY_Wc>e*&nY5Aiz#E@TsjKL|~CE{~~l+!`~Dq9^y{n
zj~<xXLkfgo5310-(Y&W<I~d_3yby*;x_aq~yd_L4{Y-X4tG=N!BbTLLCWL-nlYljA
z(#3iPoTTBshJKWxc4X{#;A{Zv2$^x235iH+h@Zs0moe*rJt-(i45>!W*f|^R<Q)|R
zV5sU#s-WH7rG&O`_vkQPO{^sd%)$$5Cz1A6%rcFgIk@w2pj6J`?AvJUd~Hvo`Y5@a
zydOy}{8)2I_*;+S#)qw=fNGnH_IB~-0sDZ}H&M<(XHBRozBME*H>M+2M7ABswJs}_
zF!~JN<-5so=0NU#hf_~@3X$g?!YEDe*)GiZMQ6<K`oM?n*V<cyoICMQ;nMelR6_;X
z_J-&|6u0nR%Jsg&4-&3&#?rKcJ&Ml^w~W&~T+jl{c=2oNKz9TWV}B|;yFLo<^gAHk
z0S|C}!ZIMddrL*5DaE?5xWrhy8v~VY#sC1-cF!(M{dBF&{a*IQcXPYXSyjPP7j<fF
z1?h9!vk8!hz*59VAl*|<mZ_#)Timl~K;AMZKT9BUXPuAN)Rp4<o{ut0_#s5TpH{hM
zh<rCkb4D?K>kW~<eYedG@NmMX{A7{~jMtMF3uDoLQJCDas-kxPB3Ci2D)aHV!B&AM
z&x6+Mr$~ls$=u7IQ70JR@~@AwU!&-bDQQ9uNiGT_coG`)-P>ixnrPn4fV<m>z)ib%
z#Z5+wfRJ|CUj5Mm7HqzLcW}%`z4xG(<(Zw!LJ$dL?j+;=abVCQN=pD*lrE9*=P2>Q
zV0rxjo8O{pCfPX3!tZ!57!<qk(cHwuHZC{_$=NWlT2<FEU)qN`e6WiPR3|5GC)$sq
zr}El+g3<y0OkRs0q2g_W4ah9nH^m1bTTj|<@r$dIMVow-Z;j4w<HeJ0Rt>ptJ@WG^
zN53#wi#yID893DMV8iV9CHCsW8<~qZkw;q2!VlZhDPGp4P^BjJR?9kvz1?j$Qg~f-
z5R$0^VkxQgWM4m03z-Z_8zj`5w)sYN=-Ngu9r{{=wz*1#V&-V-M;gBhzUeJrw5Q^p
z@uOIFC`hE=V^8S?(x)+F^ik{$l5&GKTwYu8MD3WBm9rqpe#PXhQ;lRY=wmt1-Ve$y
zqse=C!C9z{Gbn=C4^{y&boEm^r6QKH`%+psjR^e~Tm+0KnH|evmiyFx#LFcG{Ensb
z-Y+2<P2<|`YELuf*avHy2HAy)X&L}Ztv#M7DG%hH(dpTlN>Kl$Qi>X8D<zp>w@AWb
zl)8xXy%@6M*D%<)NRpnd^lB$B+qiziC!S-P7iRlWWjIs%BUjD)<8;RtT6a44*#?+6
z7y2oQRws)zVlLl~6)!|5-{)k%`0RenP|e8c9<7(1bGW|;1(UVwGwC|odjo8jTAjfk
ze}x}>R4`!q#1|R|6(>mLk;B(c*=X4o)&cP^9g6_smDc)lwe-f;85<?~V}O}`LKm+r
zj~QehB?PTk!jG+^)k8Ow^LCfBuv7#iQ&u$I$RBpJKGY<&v_$qmI<nH~Rw7(GJvc6F
zn|ji^UigzTs)ot-dnDUtwqEVHM2slCaB~8LswRdtC2%);d_dfK$sL|G(o+H2o4QgS
ziK*3%5RiIH>lSVPIUh_E3~>CRf*4m}u{tpAG|)xK>&ZM37<Pg1rsr3_zq1eV_o&tC
zfg}y1Jhg!zmaRY3uYh>7OCHm7O{06ZcSSD-d=YtVj*Tdz;yp>^O1h?3nz&Vu(}D7U
zghxPzV{InzfaYO-VES4*xPF?mhv?L84tr5E&8nS-FLZdW?IdfHvAEaAJAZMSQFOyQ
zE*HGSzmv)J*6*)x1~E0CZD%|uR$lvPoMCo##8nMCe~gGH`6DP|v3z}Z#P+Jl(9+Qa
z<C8pny?jl&XusshL!&l7_O`NvqP?Osrbe1@ngc-Zn~+>DD7DSePkp=SwW>@|)c%hw
zeoYYQQBYX@CY`Bpdsd2Cfq<}f3ETZjQAQM5kZ>jwpVGrz6Y#;Z4c~J>D{*g;eO?7v
z`)b`eX%MC?e1|xrh&4HrvvQAszmaah(#uQqm`}!ug&dgIVM-C<YB+m6CcHnXJ3A>j
zFIa7MpXg7HJeuFZ_!Zd$n95XDn)f_m7;DMM5AP$vwLR?zuq_pglu_g9n4v<i07H#c
z4?#mJye}Oow_9v7^-x<b)*8h5`}8!w+69{mLg6vnpssiL$GJO-KT0Rn-n4jB^hz_y
zk=H@2U;HKCB;I^Bli$SKp@!-(qzY}J;d4L`Lj}a+_w^J!wZ>7?<4`BAs6m(JkvFn3
z<_>xRAg{p6TBklH1po-PJ=Rj5pU<^0l!F+u*W^}EfKs$6i0a6mZ;Mts-z>`+v~4U&
zP37Wvd~}xUH3iC|FF6%^{QYuc<csC~=mH0&uI}{PZdUzBshXePd^?O1+r5d*y#D#c
zEtoCeMPs?gZ;Ik_L@<@J-7H{i-Y^p1C#8Wiba%yiEUu@<(VC`7bJ6S|vk1zQ?I=$4
z)NtcY5ka}hZeC_%kxU>fGOh1-;=wnfd7-4@?=p?{Ty2qT$fxHJ<-&o<;v^jT`8SDN
ztz^a&-l}paF|Gda_YkNf2;>PMgq&oH=BsinqB)|KRs(>7X2J!%*0i)@BR?(<!X<+=
z$+BhQsX2Vt$_M2m!Qp*Jo8uxah|uc%)>_Iq5`9MWulntzi`2=`NzH;15BdX8GiA&x
z)Vnd`+F{*nd&v*qFb8!dq5}t~Zs80A*)VV&Y}g~)F)mHA9-{^sy;Uka+LQ4&Hb{KI
z+@x#Dcy+Ei0vr7*HAyPfFFy75h>FL=oa9NJGf5EA$*DcOnJ+N7@Z;X(q;iRi+XRgK
z_H8o|#_KrkjZTYdkGJ-LhbM-%7LijI!?|t0WjD^3yPt_l2=ydOvET(aA-A|vh!;+?
zs9Qc9<)e&2cD;9G6bJiWUtQP@G5m=zT&n8}rl6=cjZWi(cb^_W3;O(-Qx^u1hAqxZ
zASYv<wwpsD*(tY3mY}=78t~qTfEzyWS&gyV(p?{8K3#zmt{VpMRc?jzcd=0xfBAjh
znFnXlQDe1EnMS=UE)+rT2>~#gy{|q(*K0ueD9_O>JjszArFD<V%lX%V!`>~YBMf#!
z=Z^=?<9|=1IXF1%xa$XjLWHIut&EKFGr$4)mw~YAB_LKO4i^jb(>`R<zEE)yL;bSM
z^n0xDyg!~bQYiwJ+1N<|#$F@3?OXykGy`wi2cMib5chI{W4R=TdrzwH#Gj>C_k@az
z1x@KzrKY6&ji?DPRQ{BKN`<uLlpzA2L##O|wIA5c4eCxf{pG%)16%|6i;F_4=KRTr
zMNULIT0n2kRZ7lB>Nhg?_26dFZhN-uxh7|;S$JYWs(!2-c{_c`II8V4>vHd9%NNw+
zg;ryu*hH%n9to(oV=NS{`;W~lFUtoGcs_m2jr?>>A1*(hnxAtc7;VCzJY~Cl*EA08
za=}@0lo*a{9-);w^TinGK>VjupKH0cZQZ22CLrtUC<~jE+-n#xms8h+o^?Q?BQc@m
z>EV+Or6b+f2`e0!WAEjUzg}Rr{{%1patUi>$I?AIimP@>Ps4cqI_%!zh*bayv3KyE
zrS!D}>f9mL!jrg4YF|bDa&R>?NKsM`N0)#qM=t;vW4T_8?cInw3u>K~<vn-G*efQW
zeZ9)g>(F5<M97|~l_fq*YKz1e3yf}p?K3Z`{>=7G^2%>fqU?myqhs@zeA>+4%e{P`
z{t~TF6EtxbAoN2985er;7nANS#m3FM*QWon%Du%(?ih8md@a#nxy}iD4jh^{Fe?|b
zF^G6@dMsTtY<7YNZVzm7n)4|rKw#}MZg`cSq58o~t{yJs#?7*_U1dGiaLey<rY5#&
zCzpHhe0|!6Cf`n8-RzqiGya^)`H8mdW;{2G&8y5|WNG*vC?o!ex0?Qj$d@%;t-fo~
zjdn<m?92BRTCTpEeQdhm)%r7%g?}*)v5^SpN<3-T<JkprnorE;DMMz^8gqOcA{^mi
z;t+8f%j{IFExN-9CxmgrvPNSU!t^g6@0vVh-@r1@lA?mx?L(0BTa-RasC<QAja#I-
zSfV$%TloeOa!dBFks7_g=hu?*sW^6<yrKxEFBPF`Bd;`g_Nec0bFu4KqeSMA40hH3
z%ezS3?>acEI9qWZ_;%)p@kqVJ{{G}-cazYkQ{IwemG6OQk;C$0p#4?RgpQ%q2WQvC
z*hPK554<6!$86hbU=$g{P&t`erPp?{#&D2=LF*e8HyfHmzVv(nd&Gzxi+b<%184da
zkf~lu?P&fhj``Z48?$~N_2vuDojm*go~*}czjoy;vXqKG(o%<loCW*F%yJ!~0QN6s
z9{bWv%=(iRg>qc)JS?9W&qT<9B>-9EhGnj=IIoV>9u`Jc7AltFJqy=i3CQU3Cs3XK
zv6}LeyVU}>X|&3<;ipn$nSFqR901}z-FT<5(gP53+M#EK6tJWEWgaAp5ptO7@?cbX
zmV>l@7#SAtF>XrS=bt#Sr*W2wtU|0r8jcez3L#}#Taq|^_g_97mVT1pHtZ&U!GT~h
zs_vd<PkbuvNc2%>{%q2vd35UJeK`$_p4KQTg(dgk$ruQ)l$knT)?ae;PGlGkfOVQ=
zEZs#@-_kK_QDm7>sBpu!s8aLGd-1J?2YoH#73PbPWUgw{nH!Qypyo}J%Ax`OGV=b5
zdN%CNl9#~@e>o(EDx7G1w(Z67m?V6na`{Y0Z9$Fw1iiHGqPbIfHP@!h8JB8Kn8P!%
zf!EO0h2nSs?L@xDyghAST_{?}fqCoPHUmc6QgP<q#d*?lX0!~|{^Ju>3GLLpMsv;R
z^!rqFN*dNNIno%EIxcPIJJGw(JA6Y2v7VM4-N|R)JR0x3;+n18-Gr`cLW_QdJ7p~m
zG#Pe3g89b_MJKsHNw|iQ{Xev)ekzq^L+tEI>^-jfm+)20qGhXs#uOR}W!hhj7Y5y(
zT*Dk*h2Yb2SQuW%0O}C*Sj$SQeNm)_gsuN*m&+I9Xl|EAG?<q>O=6v_QA_{J6Rkyc
z{EI+JF!ub5Y+Qt)<fmVxgz1@>G<;SD1N@|LgVfa2JOWET<I%>RmU#q>$>=1!n2~=E
zPuS(O$0Ew&)XY1ZeOyNE@1pF-6PbW0s})x@Y9|5QZ}K<$qv0Fl9DMLV5m0~f^v7oB
zXxN$Wt1($&aGN_&(6`SW7e?FQG6oGX8G{1tnX>oEO*(_W^&%z2XnpFK%1vg|TvQr~
zSyDWEI4Ki|Wk;|u%K9})J+xT^Aptwhd0Tl+pl+9d?Zn1@))%f=(|4SUGg&o(%YL3#
zrqXb65XL9+8>RkHqYX+&$bOf24qVIe#KQ$@d5F9aMl>`@y$f!ex#4pzE*ZVx60)4C
zg4rN)U;p@BP=5A3qA+MXs(s8c48BW7c7L~_9WB>0q2pQ??8b5b_j!%&5UTQ`Q690@
zQP9^O+wjTcwL(75NW6o>s0RY$Bqx%Vk*TzD93P|`nd|l?K;PO(bC3l_(Mko<5pu?2
zpyK7;2_>DUwR(U7>GZR6OEDjVtT&q@D*N1LH=9RomekQQ1G08u?q>P?ux3F@ap;Gl
zi)kKoCyx;4!lTbQJV6L>gQ!02&Jv`Of+!LL?;4CXCvak4HQ%eG&Gf&xx!yJZIFc9n
z#P`>$7zOU-sB*<;%CWnglXCooV$;!2rhm+onltv`usc!h-t>*Zh{M(>8%Fc@;M^y8
z^rLmuzp6FYZn83EJ=DH5+|{k_2fQSw)F_lCMj1VzpD>%`4f$?t@cjM*K{YchI&pz;
z-2k6_=azdL!T}f=-Yt359#Z`hurKI(@@LwxGOQsZUhj%8T|C!+mcFH@Xs$4Zg<C5X
zx2o#uAx0T@vZn<_I8^~?9fJvnQ+jO8f^oGYTzzLzJ+S>Hg^O2i7L#-#b3%Y%NlFd;
z|3HA@hM}gQPR!Zc*+t2EjcUj*fDXeM8&KO>X|FMUh0A|h+p>AlcbIjH!k*Rh>;8l5
z0{<_lHvuEbg1m_qLC3Fp8B0wlw;NQN>>g7EU6+*&Rwz60vvh+CbgI3MKY~`@0xnM%
zJV&iCL^CA8_H`HVNW^|b^f`}Mj`NH6@ah%*O)qVZOlsvamlFT<wQv%W@r4djwavhg
zDht_|>~%0vR{9^Xr^LeNO_UDf^&-nKQu^Bq?G53D0CzUpw9}Q`%$3uB0P8LQbT=L$
zeX%E^GzV2YDLEo!+Azr0o`<fL&X+FR;@%K=xr)KJ4w%W84r&mDt_jfV{*iyMBI^iK
z@Nn#-{L+J>i{`xZOxU}fZxTaaj*`mHE|kEGHKRK!G(MUNUrrWk>C^6s4{KDhx*NS4
zGL=w_2;0Jl38J*t{{v0U4CH)3rGwJ_r=1r2L$s(>t4Qvv>3pdb1j>xqC^-6ZvzuM{
zQ^nDQV<aJWf$0HLGqYh})9w3H$rM?3_3oZS3k*;1X>FE9U?;3{@Om99$@{>mX+mO&
ze9aHF&ht&aAKy28ggu-Q(x+C<m!Z_>pADEj7VgZn6N}z=9J%l|3lqdsS9@WdMw8mX
zDW@IJoC8+p)lPUfHLlslM)CVd&3~=L*GJVo`zI&g<m-164Bz&mxMf-~>ihz(W6JSa
ze2xa~JbM6NnO;p@)lV(8dux5)x_W&t*4wU<(S=;qM|7#Nz27>Dcv}TfN%fEqs!u(G
zoftraQ%yz8FV|kl>$c)pXxi=`9de?R?tU}3LxsCd`S7#6CKRxfQMXAj7aU*5cz-gf
z^m6^H)SB7Nh%CH(y@eme$%>7parY*OglcphBinFO&`K*n{ujTSzC6b=Dkk0@QIhJ%
z6IG5s3L1QaIAqVsa7`YK72AnR&1eGDF*Q1P%k@9bHO07DF{scml*=fVp5b>^2&acd
zYs12~etTA-`?czR9q-Hk#MAJ0MR9=o^G)-Ke&%Y4+U{)ibEWLrWN>r7^W!5?=Ov1x
z*{U;d-hA~UC7KO8&grF0;jX0bFtLi9PQSfrJ?4=2gdOxAxC7|~WNAKFSM{f^yECqj
zL8GD(`_SE&b<|SY>Yw4qMdJ^?F7$ot=*=<R=3LyQOc~$v<;s<EdEtzE|I1a4exJtR
zil(ql^60jpzrC7l*qE@Zhjz|feCTPRgf%bF0q1BJkdM<9b%OWaLRCvN?Qlg_DHYcT
zCW;^qzCZlo*145Rgdy<oLj(Z%=YInlKJ_YP|He=&7;z+Spd`g@fJ@Eyzfwue!5>57
z-T9w_Uj98ChV-_<Tg~M^1mHhqNo#JSX}CFOLATZZKd|@h<A0mK)n@)j0=Gl!Z=nx4
zw;?pK|K7;I0&uV}lFQrJ3-jM9|Ho=^JN*Bt3Gv_6^k2mFkRHnajqg|n{O!|!ibpXW
z?DG7#JY38n1M_k(Zlyn;-i9guZR&qYglPTKb@{JR|M#*4A2k2z?cdw~yK4W7)(Ot{
z{&|o3+d!tbVFLd|t^AE-`Ttxw=fA%v!555n6!Vq;x&7~Te>SKz7DHX5;aQ5T11d8?
zPDE8aSuulKqnS@I6i(XEmuQM8^!p>ND9rYmp%5&OAwKhJa1|(jJr~3U|4U9qgpw`(
zJ1zfxmi%v1=D$zi4*gT~U$=iIHr`(%``>iI|1tOeRnb3@YiH14C~2F%zWz!Ztg0uC
z&v58IE3eJ3U%y)3t>6$45L8$N^+gwv!_VfOuP-lF6mK9V?!Pde$l<#f+c{aR)pxYk
zS9x|BPpu&^0&fQ5U5y<8n6Icc<S-t_O{UH@CEd6a^nMh^BK#lcPlyq+C|0`Rx`f7C
z+3wxM%huo+njFz^CDGbl<D)5EEe?xd86FFHgk11v=t(K&X-xQ91m0y-h&{6(Uc#3d
zitONdb@tDkrz^6aTO+@sSb`iPxr0?>+G!V|yIrB$emBa?V#~;Rz9;9a6h~QQDo11c
zPEBm1%SrLL{@2CePoZ>#@1X!;MNR-U6X70O#uoK_Oqbwjl_D7HYCa#>L)myRpvYL>
z!9-HwH)UGJc#TC9>0H%HaCLPB2?**V`NdVc>fT9y8GdEvr89XwS<q7bisCysW(Vqd
zcBU7^H+5#}e`nggM*?$|oV3HQKrgS!U(0(2b%KO3>x5XJgO~6cJK^$Bc^RytJzr^z
zzk9X3-?$5NF4t3_T0AdmxSuT*HqUIFB`f!O26dNrIw5>I^TUfP%RoQ`%BVKO`z9Cn
zW-ZD7osAwj@$Blu%-1;;zuq#wXok=1xys(;>_cuu?wk5_uIc4mXT#vflzL0WMHxKa
zl@>kw)uom~lNBM=eJk`vqZCJPH|XZRE8sub)=~|Z<nJVRrzr6auVL<S0aYvMAFEY_
zAxKa$@wkg0T=g{CjR<yM2eccRmpH2M(iK2zO+6k^ZbY>iT>h3G6%z18xAUK#EwDm2
z*4;x;*-#%|1cPPLd*zm^M@FNVG13`!_NQ=gT8;?Bgta{-|6@i7C8s*<lnl9fYm8Fq
z&gsq!J!q}3rmyioa~!}tRcjFaYm;t0h3}wezj&{z2X|XOIWw}&ctQUDROL&hlr=2#
z#Cq>4U03fnR%e|Q<jYJKh5!qFYq>CNQc`K~7H#Ky(dozAeUOI)<zTl(<jFQb`NI)Q
zb`;YLg_msj4>a?1GrpYOPUdD2`Caq!E<l1Nr1H7a5dwLl&_zKZ)LXFW11iog`_-jT
z=3ewQyM6!BBFMtotcM}gl<?u!&G1=ABe}Bh0X={z(LC7s_)<ZG=~hMbLCo#zt???2
zF@$5xPEv%TLOOZw8fDXQ^rzLxf8SPFMYrkbPQHXVl)VqCzF^|YG!_OF$7E(@sR)_2
zgzy<webMH@EY}v~ALl31(pANBceS$<Sw2$8pJRoGheICUF1e^P^uDO;AJL%<5kh6m
z3hzXL6IL;C4|bRsKuQe`5xb$T3Zwehml)P2udwiE>}^P6>5B(v69pFhX4sfjz11p*
z$>Mp*Jj+&myq+g#pmww93vI-~L@iQk2-w=%LQ*6!N{-6vB?aGuuilzBn9ajF2D7s}
z5Z9QTd(>8m9x4lWt7R{qY>k?5p}$WHZC&_bVZt2sB-eQX(QC;s&eBcXY9ocrI~<B|
zZhx`>2s3BOSV6(6o3DqxsygfHCOSxbF)o`E%@h;7h*N$^z~vf?1RN8M9xv+g@$#`b
xna{<l(@ZG(X%??{jnHfgu;E~_c@5`=rHoLwa;Yk+?DhvARFyTAs-9Vf{V#&53~2xW

literal 17888
zcmb`vcQ~Bi*DoxQ5D}yy(Gx=SL?1PRh#n<+OY|OP$Y2N(g6NE1qW9iwMAXsSXhVWA
z7>pPtW0d!n@Ao<9d9LgCp7YQ7!`yS1J@?*wt-aS;pS3<hU#TlnT&KHEL_|cP^ip1n
zi0Cqmi0G2$H4@;;@X>ZEaJb~IrTCnve3)SaIJsgYt0qfCR24;j^5!aVPWJAlfjbcq
zW!J^urCygpOCll#u#&v2&U@2sr2jhxG~_3qR4z=1B}S+$MwNnR2A1>PmKXGpR;)tm
z)mGfYjJz$k$Dlgc`^bjJY(?EBmY{?PgJywZH(7fVRS{I*oVX)bK#~j}EN%ei@{W3*
zzDMgW@u3q@NElo12NWAk(>=}cQ33z(+e!-rj}EDciS?b0WV;)r-;OMzMv*Q@gmxq`
zWd>wv=V%*0(<@!iHoY-XV71Z{;f4ewKr#mj{g$iWKaqP<Wx2y(#T_X`T5hKYi21zt
z1?uV5DtuV%x3!_v^vn!iqxzXg=G$Zbr1SMoH4YCsG%`H=jvIvKqBJCAP>h+ne%SZD
z5^0$-_<oJF%*EzrUwpN3vqwLk{`7F(MekhqXn(&^M!0fcWOKx;9hbgG-my!*mvPkE
z3vpU%M=B8$5q&$(??hKw^rj(xb%mf7n%vbtY;54y6=gQ%6O0<16VfHT2KdjG`3E8y
zCDP=9$!8hFRCMr}oo?!(@aW7$9C}1zUf?)0^SCH8mI}Hqw@2UcoBm1y@TBcamoj{U
z8J@Zc=nbm4q};9EO2l#I=YG1(pPxa)7t&@aB4v92%-hE&oxmfgX9lf1IT<-`ZN->i
ztNVf5&jjY&AR|&ojZ{#K{~}@WXpRlIng#Oa&XZPH#C;>C;yFFTp8ItbbZE4JmCoju
z?eP2~%oWmFOg6aSFDJeJQyenxCKbrbL_{CzUS`sqpP*$bx^%4RND|K9AM+;rZuIVr
z7p<-sm^OMCob@I*Y|#NPnC4=Xm}u%9FYhfjZe(*YD`ze}4w`jX?F^t_o%U+xjZGEV
z7sJT-<G{<?prfEfln;O6_TPrp@&Q&!&zD5-TOF-ROam=crze942yx8$j@e`|_i-wk
zcD04Q@d_|9FZ|Dug$Mq)GMCvpl+d=#&Ws&`ZenK_Myzshm<O-MnCy6%%3<fY5>wLx
zu|doySto!{svVFD1)Kz&%(;6DFn^WxC+PE&kCG?5U0*x%oF{5IGXBIO$CErm8mRTp
zCi+EDn-TXnmZ}YcJso41PyVE-889xdHBLb$!1gNO^V1_ZpcRZZ_lbzidH>8xVB<M5
zeccS+ZCp)A$tMWqlzrP9ACF~#9MqnSh&m-QA{=9xPky8ilLB*u<iBTJe@Cad{<4a&
z&q?i8%Ylj8YMtP?rN(<kC+f*^8z+Uy#QK|Oa}}qCU}TOQ>xN3pSeuZ)SM&M3bJvuH
z{0&z_SYo~m*e4pHRzWzMGCNJ!T5Ox2&G%^OxKZId)ay^#TneVxDQI=-+y-8lzDmV6
zPsWv~$};0--t>Nr7k?Ht((h#o;^aSFZ9SQSyY#^e7UQw$Vh%^Pi!P_rE+CW95K2b3
z%T3R}{wzHo=Rb|TlLhJN>9Mr8A5fxaX09L!ZjK_cYevF*$w{V|Psf-+y&E4lQp)$y
zv>ksGY(QUj2<|dR?t6*;_{3p0j57Mi{=oZRpJ+EPPn;5tB<8{XCc4e#2fio2d(**4
zGt3&Qljz`LE^R@TX~(@`Cp%l3AkX8#lTA^777b<}xpv9(;*-oJe2fs2wA2FgNhh<I
z3@Iro3X1hHJ77|zcw*+)bm-AUVrTl~aCXFR+D=nvM4C|QyW^he4omQAMLaCLWZxp2
z=2el0m@Aac*J~gDpb7oc#q8;4e>xc=z5mr-YTs9AeYIVUi0EA&zNO<7xm;%3!re-5
zdy|f1n?}~DbKj7@O;1qh=ahvX+RHDb{2lOQ_Z4i>jYap_($xSI3cfcoa^BX56Rh4p
zng})BTUj~$>9IlPQ)`6ZX~BBJWRAz8#5+?Iv97-7ge4aQY~q8E(yM}ijpgO+no{1F
zx#!6*9CAEs9Jn_Z7Sb-3-spWzs?FLv#_ZR5yo}pqrTt7^oNatUE2wv9LZQc9%+XX!
z9_cqaj=Y-)FnZLt4!*v8T!90jwM{@<+@56vtl*DJT`FB<EkX{{UGcW_9?2(h(G+6d
z9ynZLz2AdrKHNb}5;zW+UR9*M=q24aTdbm+@isZUP?{{NImx{~8`#wZCjQ2gDKqE~
zXQlk!E5a&^&;VCczinXcWZDy)7NTR8=#d=$=TVBN!y_b{|1sj+gsJ_=1{Kxun-_n0
zWLoVLdeY)^eQ(2Ofj}|wQ|iYGvgI1EtE}0*E5i8{pe8cUJTOQ4JMYmFtLMph3CPO6
z0c5QS3rE2dQRiGx?fQLFrz4<C&l;2k3w6|nT5C?{Od)8P!&XY)`TNt}y}=m&=n8dz
zz5Mo5ue}D`IortTt`**;hJQv1XjYlQwsZYr;bqrOQBwlP_bHoy&zEoN15?aGeFd<g
zL@yOy^gaPjiRKi-9{~p~S#vU=lREpp%Xc#M#UXpSCKm=Y<!HyNBb7!4_?jE^?KW^I
zVyV2?mAJ0)Tms}J0<{kLd)Z0Fu6%cXwR7pr3GcLo>6~}eVnkvE-4GOudqHa*o!i^j
z;oM4RcGEyBbEtAr_nt81SS2%Y#D5VAMJcp^#>4j#M*O=^Xn}V)bYJ)S<e-w})L-h*
zvu}9qprGD(k;MzT)_@XZv=jJJ9M?O&T~110`wbYuH~zeD;}kcL&jvBeA`j+*s0JuB
z{QI5yeKqCkSt?NDPQOpaCn{#Qw|5bF?b6B^%j?46<5)>(m&q;U5_=TAsR!mXfi~UZ
zGcVA!<+5jbjfie&>VoII!`^bZh`#UdZb~o|;RQ!*=G3aw8QXs=;>{QRjQ775*E@0e
zxL{F}0JQs7^WEeZvT&9l3!Fs%xK0AA=y#|<vNRyAQ;(fn%E+7Jh{0hx^XTA~o!EI(
zAI;WaJz$_8jRJgl+Ctu$#uaqz)h1o>Y6<1)q9;`wJ$zfhv`99|`R?2*g6x^gJLX0F
zpvf|WoG~Dzn-%CgnSXx7M#fV{NmKhJwjSp3D{+n72HspsjP*NeL99q!h*+Pj_CnxU
zPJa(9!vDzqYQTRJcRepJ@2$UD!T2BU>IgBgKyd`mf!BzGdEqRuOQskX?HT^F3E&Ml
zD4Cg=`I-X;;KCCz`Y`Q;Y)<%jo9KgZ@f&l<w)q$tml^aB?nyq{oQm~(DYEYzC+PmD
z1<<KdYC3(lsQ=ap9U)qM%E*D$)m&%<JR=RsWdG^~{mvcs4cF#Oy+pPHJH-+-Fpf$;
zHYy%>A4^{$j=ZW{_wSD(l2j9%=BTyHr);u$x_@ilxePq@Q`xqfyOjquYCewe7Net{
zQ`lZvI#a4C?R+zQB{WW;T<znWGF@`P$U^BLh};>oyuRM38i{=hg3QAb)8{P?UF!+N
z<3HP*nF{X!a|lyn(uWmTX2-h+mYb)EiivXx{HlKobL$@ETPcKk5PmLvbON7f*T6rL
z-9*Crs@PNH-F?CY^i72n#T{aegdmY>Aj~f-D&;DDkyLOCY{Re}YYYbi9o5$mP*G9w
ztg70ZOuF+idA+(^_+8(Xl%QrOH{-CTw0&N3o}9z6ZFX~R$QzSu6yhA&<49e3Cldw)
z%NR-QT(!6a`sxQwt3<0R$;UYX(-S=xbM)Z}uOxLj?|Tca*zCI{Pm{5xin!}h#Bo~_
zJpLJVy1l6H1AOrK`e%GJYBx8q*Udt`fkvfJ-YYQKxxK`=ubqwgZH3U=45|A}@Rz@>
z;tSYwEyvx}-D2G@iED5?74zP=UDjI=DgzqDuVq|6VzM7|Ufz>0L%C$LY2EO-*>k5Z
zs-8~$<?Q^<m1uVXiNv)a0Zl6(s*Uxg_^mrTnuL54jw}$}W9Nm&r@zC2jpN;;eaYQ#
z#44KZ0fKp~<3Hjf%O-SRQrwGce*Zgr|LAC5n21Q1Nn8AKY~pf2Hr}Pcu8CEvZ*EE*
zPGf0#6+S{s)fYfaYPlMg&H{)Y*qWxlZap*Q!cq5AmCFB2ObqZ<$mgIMSXJ$ImTQ>c
zCsx4H!~A~V<Lo=e8{Rz0rakJ$Dnsw9J>2%jJl#o@$G$#g+@Nzsr@_?Yt2`YW52lU$
zaToq~-D1A6snGTooPUP*8K!>8x5cu&*>I5yI7PB><A0T=B^lhjW8K8uI%`txg>|l}
zXF+>OJ!JI>u@dunZcQWf((R~Uxnpa-K`%HY<dM(Y7inxEgiEyuM`k9G%x~n1t1}>%
zmLZ=;vtv&xIPW<3X-jarTcojj6vN~F83EXY54&LU>Jl-(Sv${P4`0?`wn>7!H^VS`
z5h>aq%G&#*C_De|i`5utiyE@cVHqtGV(M=1ord*IcZdfcRiSlTL^@CH5dzX3bAD$I
zJH~=X-{<x#Edu9n7L3Owv=Q%M%{>e7rxk;Jst0rx;A7AzKRWXLxoHr_kJ>>0&?Uzx
z*Tm%r=jyjd2HC8{L&e_sDXLmFoz(nN4wFFFdSrj8dxM!Sy8_euB7Nha>5{>FYgzSq
zweqyB`{!vlcqCcL56DVPk4Rz7tt!<xjs80!BmL!VK6zd*jF75H)h%Yjgu_{|^9xFK
z7z{eP7S0-*nHkTKA?`S?%Hp9hO`_V~s-n2+Bgnz#AXBMAz81%o8b$FzsB&v#qsk#-
z<4<i&fR$&#)-Y3C7ddWxqC>;;a5AvN=kQ=)uv3Zi)7h`x%&x#YUpDd92Xx8c`|XOy
zQH-#z5C^p9pF*G2z0-YSaV5XH(-VYm14IV+Y}9g_*g7B|=~a3juN-B0M8nqdZm`uK
zQZzW2<gi9QD%bwliWPAhDBJ$>&FZaLn|9+Vf2B%@ykEfXk3_~Z)MI_pbC(96)+4Jv
z-WtToaPqTdV||m@cytvZ*zZ;yO625i!hYIj$0Tou=b1Nuh2EdKX@8&g56b?E#o)f4
z_Nd=xqp3cb*%ej14znP_UJ;?KEO8k8DU$@I=JAP;FJ4<QEd8Ji6%{hPsqF%hilfw9
zrTnru48ddWnJsm`)f{-_^33awYNR*uaH3VQ4(zQ{^eYb?g|&mOQn&9s$>$p!5jANE
zm|`Rgb#g|s7cH9BvOQ(Z^O8g_x0>K3i?W8<L>eKN%Q>+_?w?TPU0P3N^HM}*aKxrd
zu#5`)tB7sPUS<&Rt-@U<k8G#f;ORNltp>C4ljRDC@K8*xX`v{;;KW)p^>t^5Jc!ZW
znmd<-6elSalTb${^?g2(C8=`A>cP=`zuZzm*q~~Pm5Gdg>_8>w2y&_~<;dY{vr9c6
zZ)oe?U~a8yh))N#A!*H+V`}_{<Ac#WkV~w`($8&rrOn%>rftW*X_z<KLcADX&XlKl
zic^9cAcb_r__Ye~G#)vs@q+qXx*2Wd_cd72(!6ua0>+KM)S@AX)m{*$l(88q_>J9G
zHqjG;L|L8w{DqWg``VEqE^HB7^<<mpnYit7SY~2mYLSI?io%juI^9e&E8oz7@$lA)
z<JIw1s^&qJpuWwJHbThTYON=BXEJ`S3sgo&QE*w;<=|I#Sj0<1d@27hZKUs_-|u%p
zhwJ>xN*}MDy=Y%QI|FstD7Du<qCP|wPVv(zZN_fF^*yAO+V%4w>V8TUb!5*JYtx7Y
zVy8@rMX!1OXpI_%DEP^`tfj>oTgV)FmH*T4-2L6ij)c)AWpw>qL}cVVCkqr)Z#C-h
zsPwAe9Q76oRmZgHDxRO~!qfkQxS++tYM9~}{p4s0(VrvjFFIf8{rHGs6L-B{HF&Zi
zQk~iWR!ssEw?a8)-c>t2wuTCxt_FW}oojhre>@sapzvGtbV|;|)d_K!m*fj)F^`7I
zh|On#_Y9+oWfKW+Hj4)1Et_v2DE4T`Btg;ioZF`--y`iFF^io9d{Z7<I(V+Yp1#y!
zPOj6E-OiBAVz1C{Tf1k)qpmL{0aceZ1<eKOl}fcvOcQ1XL3z*!DZS(7auYQYm~+<Z
zRU=d53;Wv?JIpHmkoArgr)~@QwYpn4`}^YImF=<?;uxxAbLB*M5PP)SxbRINdI9h5
zXU~>TyxfeBD64<mEV%g|=jQ-b3$7Q|CLTUMIn|b)Mz9u<98693?PV*0buBeCOLE*R
zeTb{)r&T>TaUlrbZ{kZoLlp8=>RfhlkG5~qxsFrbtpVE|EU@SpT^0wiMS1!-95tAg
zNi6vKco{Meih}2<=|+5?BrcSf8<r>})gIv{WGK%Z$`xy4sbJxR>{Sx%)O4DCiPtOn
zXzZ2B7ptzWbcrVCsK?oqoMGnzy4)>i;kK`QFXjW@bY5P)=JMviyWv1u#7n)uW4GsY
zk<SZNftj25(Io-8&vn?pHDiPFI=58L&(F6UCi5dvW0~c^S*PMELuaRtidrn;Y0|#S
zOxkKS5HSpjca2;llSe)IG!6COPSh-^ZmqDJuTGeCYEK}_-V_2l{emoz<j{7$digQ|
zRNwc_#H)Y$YFW)R;!2g=TB_b}zJ8b4hc;>34|*RJDVjhu;mw&NuuDyFkO}l1x|T;W
z=Yg%kTK;}PO;Aw<*1Pl;62BXHuB2pg=)4zcD8ek>b*jaw)~unV+u-A2hGbI3p??+g
zG!j6ffqFE>qQxP0hef-EAzrnER^2-A!zrm+KKO|2Fk>9+6po@LQn#4!schb&)jMP@
zsAplx1^Xsq;5*sI(or;lB`B03Ka(p|+QFKyl0l+^s=SHH??x)OWac&n#D03q>qlaU
z^o_4n<=ec?7;x`YB4eqFn(^#0>LqjQ%%f99D!8`de!3`u`40L`E3)~#n)I2Df_HU`
z)sZvy*A2q1x~<6x{0$1f(QW{;Ih-Ih@I1)GnRNZcD@@fSyI;=;IsdMZF85?;cJ{iX
z=y`c$GWXf&j;Vo|uc|kFdz2=8C`~)Zq4gv!$KU02yt#aLBE%~t38L8I6<#eSVqGA!
zf2Dzdh|9;r4*dF-v%i3N(_A46WV0HX-<Ys*u@hnU5;V+PND@LfZza$yjA%>*TTT~g
zBsE&-Rn$GjMf%;N&J_S9XDRSY(dml_s^yR*jCE05TK~e0gIqG^<Q!^U8P1VfMcynl
znL`=Or_5$o*Du|l+WCDm6k8=EJJ%?UdR;A>HqUEX=8`t*J?T}_JN+~^Rgtg$`XQ65
z$9?GYN}NBN(920qy14dhT$hOSo^w%Q2i4Z4KJO5N;&MQoYVVJ<>z`$Qp3c(5jW3$F
z%#xdTF$a_FEs<|7Y8bSPRPkuv**Q%&^|m#?XF$bBX*>L*PUO5<sH5@NesrB&JxEA@
zYHyp1$XvKtz)U`XyC}5$U9NHqI^61hi8RU1SizX^JyRp(PkSeiPsD(i%L)FJ^9WTG
zou#!gvF^ZM2t=d~X4wVbmrQ0@qZWO&2F~{q|MZW*{H2ekDNO$8h!G`9+b*l&Y3tkR
z^1zf4<q_qyxi+&CYskm5!eg@E!E`;-nSqCiaixPj-^+c_OCg69YOLv?sD$W0MZ4#x
zjQj(c#yFQP-7I03j$;j=6DIIe3tgW;P~+bpbl8|<EApX3qeocFFw}z_WxlDdj|PmT
zYPlsf!%->-XrJ>XLtID3slQ#-mFA?#jl@LLjU`mwkC`flkpp-;bSEk1fLG|4RJZpM
zgJ*BS4Mu`cqsDZpVx3qM9KXd^<6ptU(DY)b$Vi4A{TyBkd0Clp>g)$b>nt_L^M2`L
zC3q5gxOIMk%TYMkKDI?Py21!{E(t@};K38J-2^rK;=#3wC=TvVF^ZN;&WvVN(j$LX
z;?L9Mxxf~YJ((_tA0wgkuj{1{qem0;4STIy-j-#pRL&U(h@N?8Ofj(yNx9-Fw$cW2
zx`_*yj+*lu(DOW4l8;>qP58<S3%v}Fp_thFp6|1YIFBN%$}B)ye8=0RANH=&D|SVx
znRRe>u!s(Iuq~CGr>hnsSH>b~MJW1EH7)=oVPY>!$|vgoag8H0I#w{HmV~6m5&=qQ
zZe|nYsIK<$@;`{uX%~Aqn;axyAaI@$f{i(|SY)1{L)ri?T9nrr0O0peO9c|!Vq>>X
zwD&&t<I;FL>X}|!>qvp$o%{shQK$@Pn}GW}E#-EZRybUYCxnWC<5V;*ImUf%amM47
zAj?HvZl(SWNo*i{QVOaPjUf=o^9TLD87a|{U5he3qn_ECs)p&|nvYX*#K_UE=Fo#;
z$8!kAuM?96@5D5uERm*vdGOxpGUDhX84<RBj%B<o=-jK(8ghC_gRA%Zjn<s!-x3!V
z4@s!Ag2ODSu#?T58UvYUzqI#4&)3_f31zFqA{NjI0B0#tQ^>d3x|@X~7jQZI*`&SH
zgo9(+tcUMr87$omf888~{UgtnfA2g~_T1YzS@Yma&cqQa&-Uykf(=x`wp?zsoyNuf
zs>CF{^7zX7$-<PK^6A9Q9$*CdM$8&_(Da6$bh^I?uQ*nZt%vIEp{E^PvP%9gE5ocn
z|9mJnl<(?`P+qSU-hF_t7{*BB8xZqD!-s@b1hzxt48y;~E{aDCwRiZVMeu#6hmC|G
z#MNFAd_xD|XzZ-iiTM4<g^uTf=AC)}ME)k1Smbbttg-9xD?zU9rpwv3+marw*DKl}
zL4V^&!J2)dvZwxA>{J7tK|3Wn1bA!UIFB|uS>|zELLdc9Qg69cM+eG7v2~p~*<<r{
zG5N>0Q4Wtg@h@QM!LJXcJ<=;N9#$h?`)O1}E6GW$nVSG5gJK+<Ro3)01~`uFZ*I)8
zi@vsAz2pBUo1w(WUv_nvu-b)NyI148HJz&Zvrv5?^R<zJ&FV~gL-MvF>S%DU!71F%
zSH*7TH<R}H)>EUA9QC#~Asaj)-&BNRBfGm=>VL<s+$u)$)v*=A@Q>H#dy%?M&;cr;
z--`T7$wMW87c{qO<Z!Ce@g?Qi*#oqhS>}fUvbdnJNmo}Z5!d#wRxP~^hknyWud#CJ
z5Q8MD)z?qwv*|c7laX+m>rZ<XwrTy-H%A^|7qJ_;rKRjfJeZd6{#ZhDnVGaNMhSn|
zdMbB#YO%MC0c2Q`$3OH2VJ2gBc__|Jl|QnkRc&#bF{dm>eRs27OSgewck>=K(F-P*
zO&O=CF>l?81^2@I2jE(L&z?99X}iP^)=mB_A&QiJFCUyxy;f7OR-Sn42{Syhjjm6L
z&t2YL@qi~g3F7K8!>uH>lew|+_wRbCABX7T?#KKZ_yYYdTKvUaddQf&<JlP)&8*AJ
zynXqgIVTmwS3md>Ayn<??wft&PSHm7U`^$030JC`Xst@7l=STh#uO3rCKSYH-%*H}
zJOSl$j=ht^uKQ#fOq4Irug)<0shw?sMUm7CJ7yXwYevH<S?~Vj`cB*Z`U2+;1Z-iX
z%LA8M)sD22-^o-@7G8zd`WP8KTzM~x>Y|e2q2)LASi51SF7s}Vk&9J{$u2(b%bDgx
zQl5YmXB;Ep3Pna{IaS~DP2@*?_<lb!=A>0sot;9y@^<+kA$ni1+C4MRt`FsAw_pL$
zX~&&9?ZvdVC2F?Rnu*TOk&SZA1={Jf^vcOETG+`mnU$c`<`hiJ&`O}gW-LRrxFL_;
z^s!Tshf5m5=ZiS4PVgA$D;d{V63J6%j8={=S1H?KNW#PqF&O)9GmZpw-~|uCfJFS2
zrFV;3kY7JLQ{yN2NBX?dpn<)A5Uen>otRXn$BhuX2K<5EJXBp-!}FCN-oL7gA-zRb
zI$7$Gzb<0PStmOZAyD66<bJxx%ych4sskNZkwLra<BygIsq`JAId%Ik1}poEBkW=W
z&a$+OxTgTb*=oMNl3&?i=?RTzoLmQWNJLk@uidbiowbTEl_+nAqp|RItbug9v6Ey2
zu3FI9Sdxs{r`*r6o{96%fSsQzXh|&8$4dg0wsi1WFz1DnWMk!T!uKA<{isYtBW3?^
zMNQYoEWu$$iMJu!V~OWW_r*5`I;g}wG-KW3b`XpnjSs9BWqY6C)G@W(zFol-ZtJ5D
zW;^^lkX*yfy&b3Hc`9n)PYzygU*ERGwsAajYKWeg;&}wphw@CoyIP~VvtM$ShO_HO
zQWQRKDG?sRyzo4NkIe7Y@)^nt^Ufd{coeBZ#S_gLeKF+30s;a&3FESyudiE!xCP;c
zET<?^c$t}tPRJ^nl&C~;x%?dkSKH1zzrC9DOxsLa)fZP2hQjGXhCGFREDG_B#JJ$A
z37VHzn(SVoJQVCOndciSW)QGN{l=YW_CH~ask}SJI`33LEjyCGi}4tClfx;F>I_Xf
z#Mc8H@rNB)VfWsYO^0IxQCSOqC&aeOF{Yzi;4x33V|lkg<4^}voxf%^-KU|%=Y}k=
zjWe3*9J|B0_#1aTX`^oF`Ih;*5;%q=-Wp{7aBR*f%ir+cJrT!5h%QFEqt{cfPKPfp
zn$EUETTC3xmH{(@d~i>`9-+128nShbIYiB9?0b(=NmA1I6*+@DSA>NJLo^1Hd|j7&
z6T>AEX@pHi4mYEHPg*@7vM6DMaaTBP1$b}VA9w5`qZZ1v2%rz-7eMZ|=+bbP1n-_q
zt2S4HC3dl`N)|Oft~J;t0a$Flqc?Z44-y6fhtCPogv!v+j0=ZcBClfj)|LvnWUKpX
zU*P@@Qw;QUv5PMwY~RugzJpxs;%qyhqIm7i*3z)PRwQd*j}YZAKmYacyt#g7gZODn
z?)mx~$mVAl?ZT2JBZSWtqR7J>QEYR9uhR{w#9`8y&;RreGpAhSmb+g6Uha0-?kMj#
z^9Hiqeh-19bY13^ZKadl$a!k%$2oC1YaPO<@uV+m3EOkZ6MGlFH~ThivbE{Uu=3q$
zh{-P{1+P!Uzi4P_O9CE!ICzjcG~iIt#twx-Jym=R*RS)d*g49-c(I^|4pcUWPE0FO
z(8RTWH{!lTq;H^Bum7TM4{szW{Ad5rH7W*F6Q7z;RaJer?VvMlV%cDmK2cNZo%8b-
z?5csQmLq=}@49=pBDhj;D3^wWZ~>5zL)33v!hM5asl?bKjj<uH^ILhC)hC^?w`3mt
zhCBfW1>}Z2?ph3)@%>6is4EUVKi3OaRf*8Gmg-67P99OS6LE11*<|ZI`Ko;zW{9V|
zJyy2U3>GkWklfTakK#El@dv24V~&||WHpjDMym7;@giJu$?hA10Y%zq5Sqc>4nVtY
zb&X7ZIg>AC-JpP3c@C5KxYr0I3SKf6uHMfBZFx62!Un1fm4>UyNZKq&6rFa9J2PBb
z%<2xFss;)S8WvebA;c9EfaJgj`DT~K2NYc4;R4o1JR9ji0$QI@>lzQ*(vy!v&h$>6
zr)Z*0UU^KlfjTBz69Hz-x>SguU5YhK2f*`f#C@XZ4~r|(d_HqK50qImYd3FO<>5%1
zHMn?T?svTTR~zS{QYmrcAH8I($ZL(}FxQ#KE2maSD!rr7@43#E)pqC5Fu`*7gL-Wn
zU{Fu;Sj9sMz8e(~=VG`y8J#~r2pRpdUhuu^#pY<mFV`FgwwLs&H}5khw#OoOkR-36
zqcx_^BaL4q5_Xx^j7?vZIctJ-z0;uj?#}9KB<}5F>L+#wIiGF0LnNB}<C6w4m~60_
zh;k@De^*&h<hyF$-1y_YAWY{m(Z)t#!S_qXWOO=z@$Qmjmb;&6MYKXVoIN65u)4%s
zIoI<9$?fQ#2I*u>Rmpt6k@B<3F|hGx+tGp5YB4yx+#UIty(YyyB0u@L>ReL1n}Qi_
zz3BL7k~U2+Ss2~Wk4(MR^<yF=0Ho{7W%%wXwOq;VYmu^>eaQ$6ONa@Q<5-_K^x|~s
zXY`d9H-ArzNs(B2%t8;IT78@bS>C<l)jujEr5ZIhJ)E|WAI{Tlh;9~|O1a0t`AFFq
z`e8@GoUHVg+SLSnHiOu^tYbP(OQ+`&3r*$P{nwFQm~7{n=ZL_)w84Ss8<Z(513U`7
zM$Y7`GjGR8!YFEuZ5qI1P8(lRgmU_uYab~AKldE?xl3xK3CG{&I)mIs+u3cnL~dQX
z1=3PnSf^8Zu{gT(E~fpfv{ShU{Ih08O0*UP0=Fp~6?bs3Fu&;QwOrv>dbAXlMs#^U
zcx&cv&%S_uaIX3_ZRBz~L{7^$Gv%G?1{tfZ;qNd9w%B<;+;(i!rah#j)x3d)v&}{z
zj_jOior;Uu@6Q`F8nAq<OpE=>UmH~-r4Qm6KsKVU?ZPcI_b%Z3Mm?HHhB)_nYB%g|
z<qaE+zQI6}EcU3sp;OI};|M&E0W^(e;%*!7fY0Y&{m6(#!;%yHW*b~8_+_L-N*VYy
zj7Hj8(zpLf0R&lnOiceLNK2KhaeHem%OxV?&sfc2{R1ggOv%M_zAK;?G*O@d&sR%b
zUG5I|47bXzX&=+P&r6dxV{y52fd+IsC|Lb&?ut~mGze<_@`a+zBQKPO%7)ij_+a{U
z5M3V1i79`97ZT^Co^ck(X(N>;{X@X{utjB${Ji00N03fn8m-;nEdBO7#&=Gs1)d8n
z)=Vk#hbRXj%|Q>q{S-=76+GJThc<2RGh;QN#gF9#I7WCJ$yTifB#}1dV}+djcF+&|
z`-g`Evo$tW0L~BWi1m)M-?e|OGh|$ML5}4pTKz}!J-!4a{(Y;j-XEJD=)ZsG)zw)d
z2k+{+z+`@==zvc_S}6!3IOx?Tz34&GB?B@2Scpv%OG5vgbbq9%?6R*CC2Z}0Xg;MF
zkG~49IxxN$9TW4WC|>nGwYxK`L2^}ZaN_nz?}Rer!b$kss4BWlmm_;Wz>HU(Xgncw
z=S{h195T6O*0bAQ77quOqE1kMVOF&ib@EZ&ABt6^`Np?^TlYnnpRJvX^tUK#8*$dS
znXE$-p7tV&`u4w246o6uj;_J^s~L<&2FPkG&kA09!rGwO1Jh8o5Bfr(;FPkUHLOHW
z%)alh@dp8cE7u&J6;qW=nr?hCx{;-QjVIuBAu3BNsG^kY!);PY_V+2J$nXuJVY{r?
zg?+g-yfekLcinuo)DrHnmu`g(COKV%J$LDCn<<^ru*ErD8}fB8d-5Qy4+2gI8?JRB
zulHZm=aYW3e+I0ihn+0dc-R0WIhp1@A5AWe(OTZk<Hrs4J64aFX+DXU1-<ZNVHXPr
zNf*hZK8EtQ2x!OJ#hE%>D%(!wy~}2n+;F5%_Z55%F7pX@^~38(U<a{kHLsr9!43@O
zst%*AeozW~{QUMI?ONNd%7=oFBAzR5`PF~YXbEfE`E`lnwG{ik)R7cq+pqA4ks4gp
zX>7ox5ZJ&_`Cx9rb^^27t0XX-?mkU2->lCoR!kOe=A)wbcnK4XQwBd#=_Se5pvYgp
z(x)L*ST<_>F6DFEN`v#!G4IKfE{Tna&Trt!jAPDwEqc|*?EcYY>q1P6m!>%x#a{+>
z=kl+S^=_^VhiS{4z7aKYI=CtxM5E$ygBSMfD9pKPvY-L1EbBG2B#yp8y~_3;_cp}U
zXiLcT37UdCcYdo>c-Z5!mXVhTq-OBS(L{vOUdeWYK9@?>`kL`l^*ykvc`Bu!w2;Gu
zRQu_ThIUOv|8!Tqey~|hWit_X6yR1p3xR03U>u$gbZ1i(lBj*tt=DiBO%Zv@(WG$a
z$!rxDsiI;xgKZ>zoL2c`A2-uzR6UWm>(t)q!gd7C{b>9&49fm^QanY~eX6;o_lEsV
zn~7GZU-&DZrbIWz@t@3UR#BIcQ9xSsrUnqlyFRLWJ(Q}YS-`*$KPInzA7)iA&K=?T
zzyX$$S-*?V7b?ATk#AA`saO4Lexa0XwY7QP*^z(fR*Z%q@8_?Ge*UeLM{P{sHlqy;
z4XeX}>PXv49pm^aE8aL~a^%HEtu^${=y+ke&5#@jb%10AJzn0FqodFPrh6Lj&v;wi
zW<N^z{2Z+&s+JUfkmsh4F}~|m2k##>&mkUP9O2(e`s^!Yt~$x(@WYs+<Je(Z`843d
za1edYH|aB_#YQihtdEhZJ03YTP5yW#Zk3$!IP`8WQj*n3Vq$Sb!-(=g`lZj8J7V>*
zQ5vh@J@OW7Cm6X$as~n0;lHuJG2vOqr16PWO_G|@qr&-K@9k$czX32WO9fKqT89ve
z5+%k^^1{~d0S?j*P{&evHv0CWilzL*bX~rvfdl~W<MGo=MC(GARm`bJpSc31m7!)=
zVC&A_GHYUjgF+FQ;2p((N?&$&DaG?oL%jC1Bwq=gmnHKv#*ep}*oCecL=UXy4(e>>
zPu7_Qd%8HNSZV?BW&GKhU&~s<30+F~W77GS&ktt<zuZ;t%Z<~ZLkRIjS?_7&@L}Wt
zjh@r8?$z_i7rR?y>OtbbFgP@jBxvLHj+wFlDThxFIORF=u@+xM|BOy~y%{)_a{ZpC
z?>%J2<M6!dyW!4!b&}r)aC`L!jDw(g73j+H4Ko8h-S>=cK0Q_o{gbJzz7WPW_SXCE
z*_&D4_o!y`SKd$#k(39x$aD?qRpgyRpB#*NM?}m%6>yTmOvf2pl+sGJ62JVL74HmM
zvkFY|eR`Aa!KEc(Nioie*=&Z#Zq&D&-c4R%rTe@dA2emo2IzLp5E&N|syb<P_*B-Y
z+_uF5%;M%!{G2hm)i#ihU(CJW>3(4O?n=&T?u^Z4exuB^xQgrCBP&w~#xK6M(?H4%
z-frOb9rMICu(x`4Yt4YXdlU21nAOI|gYkR0#U75b!@2Y5fx0{5o-IYdBi#!8)gl+0
ziRmI@w{MV$mk%67CBBb)q>|(t+-Cx@upW@!OL0ErP5K6BGV0Lyz86O9ncACaP27Bv
zaD9hMK+qr-@7t+&UWf~8VoJDQRHxfxGEsVW@X)GPBG$CV+)%Cl$y*$y@2`8;e5i6Z
zt4|~`OLYDw({j(GAIk-?CvjdiY8ViZKz|YdYX0~<b(4+Nk6W|4QzLrpIKxwppRWCR
z)qcGGMfA*<6<%`y&NrE~y9<uvgAnAWWRDo*$E+sAMT|l!G50jBwaY@!fN|CQJFYUv
zuPk`w?vF3{oZ1G}HRh%V!*0-$vwM72NlhG=y`wWr)7n4Uu62jSinf?HclM2TzM7Kp
zVqow?;S}rZB6f3z>s0H@K*i1@KjB{EE@j>7dL~yiwU?A}M0pWOwfD|3m(rt6?_lGa
z!rGLJ#A&{-D0VI}vQS(R@#y^*7`DQO8@n`zuFq}a1=kzt6PE(1hS}+sKd(4f|5yvZ
zHchG&Z{&@(2v?wgEHdiBs3nH|A#Ol3&3##=RKQs!Y2tf)dQ4E9AiLx%$o)P&OTSJM
zfw`1q;rTR~V^_O~BqF<>;K%CZcDm&bNj5K2S}bi-@GhDoZ+=|i7s*mtk?z&`k)9aV
z%%nCtZBWoX;xzlEHDf3CR^nR0B{$PBxZy2}O$I|+>Z5kdn}8!1wF#P*v>OyX!Y<ug
zE4A0@+WF9^*!Y-N*?ZrAAie^d(W5w1r-b;q_9iKX`#dAcb-$j}Qog|}#us&NRMU*J
zEu7ewbw>=4jw_mnzV2}%!|hNQr%S~wf*LEhnKZ0P*)r1;KdDd35jO!zNhj_%%?i!D
z(f=CYCO(tHvobNKstKQ~y+BYf`k{AA@YiCCKIXDWZTJj^hH1Rziqu7Yi(re-g!BuB
zrP98=*w4j5(!1H16)m2`Ex9KHSE8WK1}k%)rQTp&zm&?&fE^E8gAlxZt9s)EDdCFf
zy@|%2XE(N=t`xoVP!-qsM9A2k;)qeK7O)7q?4-b@Gf0}x?kyYSH1<WEeAR#>Nw<S3
zy<o9L^dTN%X86=0@Rk%`^x7Ddgyx|U??KTn1--~jT@Rm0^Ie?I``xq!XX^^-{)*S{
zkay~kyO}l%V5Kx`Tv-kQW9F?ERa7Hgd)JT_S>UO*-#!#`;`_&^CHP66g<znD5pjw3
zoW`f6_bU;#`fsUA24C8Vb9di5V)}-UUF5J~UL0llx=ND3C9Y<)xv+D9qDuJ@K3wxq
zFwgF3a<d(=VHig=EZ2$`TsKcv>)U2F%FNbn(rfv)yvUQ=;U;3enN1xx@!{2ooqX^R
z_C;4Ce>Gq6Luv|1wYk1Z`Hlv?)l(z>R@nDB?$!j#XQE%bZ!=E#g`<uWOv4}1h1<EB
zblFy2nPvv|d$2uF2cuq@w4X;HCK|P?)z7v7ZZ*^L!oD5L0VR!DE3E}zBz&TB7A-)F
zJzGz<nW(ZZN*_Pm^X$3D$d;y<bxG)%o|t%W`MWHiPe8e0iJ4PtR}+~_J<Yi%g?QT=
zFAtxw`;x9tM7b?2tT??fK_Je=p4>@MzTumZQ+DL;)i%Zj_a;}=oUJpfii}N~hU?ul
z*+Z=5^2KjRm~yX7TUA+ZzVdJ{o-)G^e=Xv?8&DSnl+ZpS9qRum$oqBv?MAn0P)<&)
z;H5M{;h!JL7G4}B?GFD9;wO8yKKz;jd%fHFYT*9GfKSin(^x=Pn;i+5=y&$4shRU%
zggPVbE<yFl=A<?$WyRH!;cAk25sGKx7iF1h?^=3n+VJGy{NyyU+a)o70pfH!O0c0U
zGFPR2<5pX;eHxAYd2Oh)Ygt%KZ|b*N%fHC5<57De$=^c358R4D-!HZYn%;c5HqR*1
zXs*kE`*UXjUmViPuDm_YH==C9YE_d)qna}(#q^xGZxk{R(YNAoFu2WmyjjFs(C$tY
zO?S~odyReHw8yo9009d3$gq9`G`6&Lhy<zJHzmCk=HV+8!Jsfn)8r2|BWm=BS(TE5
zNrJ#B`sV%N%eJ>QKIK@v=V}FCm~vC4jX{aQ_8{vg&%`Uwc6G!m)$Lw20S5g?g>~R7
zBBJq&0P}%{G(OklGEo-p8c&t<YPj3aZ<h#kG0&%GA9ruMm5leXG6E4TV5xI;vDW3X
z9OZf?RvyQVx#F%vL@YoJq&`9DGnciM_g)r*WMPF;a?wn!aP};0;J=E>ZUUum<2C;T
zoehiL@bc;TcsTqMIqm9yDh*>CpXYD!4CP@kjXr)a0F;UOfxODi4!7sIySln!6R(2Y
zw$kEs??L1bx0xs%^_<DaO>3YtKdcfQE7By~<QFXc=g5)`MsI_SE&@|)A0P<`VsHC&
z3j*Zu;=FX#2a~+*!tKBI?sTLr3MTh|^rzY<O`wuFsl?&-Q1GWzSW7GPPAP+ry{xy_
z5*vpqbV1M^lbkSj(3g>Pt3lb-?od3%_n6sR-ZQ;n{vb{DSp^z1BEx?X*ZQkL5sqRm
zi;uB}({PfC<eDij#{+MlgHRuhz<E&>PppZxiYoG96vY|kdymXx2O7Lj?N;l`9#w_*
zp93Xz=H-Q2yEx<4_hZh#8?~9&)-qx~?V=?ugxnn^P(n8EJhXZg!v)yf_Xd?|b*Uv~
zO!&i8H%^|Xk2Yb#r*aw^^oBE}xGw-aqq!O@IE^7s6{U`Ku28zL{}-y4V<)HOiNgMA
zv<tAo@m9+a^0krr;y%^7Pc>`_o1QqEHrv2Y8%m->Kl;vigw>RtOV&N=e`4APmFu-)
zFYFik!Z=!siee!ximX5pruxkynYKik!i5fhf3Q#K)`wMY^85wJ9U@AVuRAG|W>iv{
zhHl0w#eIPj*EgMqOcN6ZT4lZ^i=s=>My`fY98NW^$OE3&mW}#P9$f{z_;rj4PzR}f
z4#8!Jp`;lN8VW6P{75$yPW`U#T}$&aKKli>-}bVHR@dwZrE$6CK_+xBJCFxFn*KEK
z<t%2pDGVrTyygG%?d8z>1e=*FvTGV0N$>k!xAAKeKX&mkCE25{DWOPAvye>54{17b
zrL<9dV!+$y^~IoEXHRQiv5D?y(l^#nxe&^!Qyn@T_5}VLDpsAm4vQ!Imu2+^4?e58
z+qEZbf!QBnjKk+Zieyb01~t6VF6+YKZHpO&&;_>=^c}9Vncby;tU?ExSj7WCu2IF>
zGY1Bob9;Fc9Gectn<2o)%S%r`u13x*Fz%!_v2o8~MR&8_^*$qGV!vy8xFm;<YKl?0
zzoUv*hm_BjJ`8Lp{-l|)WW2wlJ<ZT$p}C2GAK}y|U25i4G?GbQDNg=0Rnu;Kj-N_I
zF*dXUse_Sgj4!2|PkuJ>a*LMw{c?H8Vl$lfpz?=zHm`M@0B@&m^G$VxhXQ-5^Cf`*
z`MNw@*2ms3XNPsmJoCUH^Aa<GGLnRYfKZ4XODwZ(5#`r3*ehN++$4==OPiA>f@k)?
zxm6?HGtz|f4cPwNi>s(}OtU|s$5OuFRoY_}SDm0(!?~>CjqP0g{Ibvt*TC}3=Z_jk
z+jWaqjc%)nHQDabPXr8sU%98(kEJ(P8S|vP>b1C>-#%;K)MP)GMOF`IcR5OGdImBz
zSspHGr#u6nW{dO5)d0yy<MQF-JGvu<xDq>^5KA=eqyB@4f&;<iB)6X2c<$rN>RC(y
zk8b9<eLrau*}Tl}bbnx)$vafVA?qTBuj!ZwL@h+kh%sCvi5a?@5Il{*oRyKVJ6CQL
zPstcPe%ZcEMY%FAImhTc4(`CS9pRHD*N72<LS}kMVHJ<IoI|DGGtEl@xy!>6eCL0>
z5oVbQKRsDTym6wNrJ|rauRyZF+i&@Jsa%3z^yZCRQ5!mvBn)UR-jJw2;MJpW_C?vJ
z7u$)0SF*nJ)K_+=$6cT7H1f)inLGh}VEpDCgOSG(nCL$zLX}iei*i>+c*CYOG*m|H
zjKlJG+k?>`55m6Pb}-WonXcmXn1kwb3Ohr_cN8nQeV=s^X<XzUA9k@uOguD--2X*h
z!6&FD^L6KH9Do`I|5IoM^=c$DuHJz}-3V7r+|PKWVQi>|l2_Qnm-dVDOi>gDE2=Ub
z26qFlN|${_vUD4Bipz|!iW@NOF&b(Are<ONh9nDCf6~}+X>8+3&gSGIc5-0++K-PW
z5jiFA=}M_-txDfu(lY10#p?BIWlc$Ibw+f-dnXIi>J5)Xic$A(ZZu)r39#&p>o&@Y
zxuKklMqc~tnzNN}f=nE?fOOSgyeoG6XD)zZRsKp^9^c%U=x4=4a3Oq>yYgOP8RMGR
zvI%F$hHg!xvaoOqXRl&fd5}rb9J0)$ON95GW7E0>pAHlRpROzYYS198o(PU~<0$KN
zr7TPJL<MhG%qpa78!z61H%)KO8ZvsA;D<-d{L)|G8?k0){Ui}!FqMx>6-};GUQQ&B
zED#c3UmumF<6(!IBtyP~Kj;6MRxR}dQ1qoNsJT3G6dCqR(n$(eFx8Mbl$>Sb*_W%}
zsWQ^Pm3ICsmT3F(w7DXVX}m3N^k={45=^E2S*hthsE(yN<2M>%$QYZRS<-nhbyOjQ
zzS0QCIFGY0_$a5>s@I*peVq+>Zh#v$+Lmp^bE)+81qDGDRFP12c-=*oxRUN*!T<bJ
zMSSHs5W2^(|A+AXf{Sv&SJA!SrZFLdG}kI)N@T(oVg3-5D}1E_bT3#7qqjUgvp?H0
z2Go7Hz)ZU8Gq$TN1o<4Ca55-lVZzXmgNKJPdv9A)<w_)#%7oL7PUx70K(m|A!yc3U
zo@Aklx!>Z~8ueiQEk-uycm!4VMoCWM&l`M93>#JLi_UI3$p_y@SaXfD$S-<A_oVaH
zQmI7x(vP&&ux|Sgf)~Yz<4J1VDz1~{_i|R*8pIy34wnl2?hPrp@bO;1&4G2ua?-%9
z&D<T4lVO_ZW%a0aM^Qo|6n#(f1qLPKul-r+0xG(9M<0QhPrt`euB!0|!p2X#&U4{7
z5wqXpnvH&80~`A}N@lrGj+_P2FW4D6za+5;Vpuw>>TQT^Ff*V5({)>wK{U~Cb&Ld%
zu<p72HCJ>+$i~wZEg^b>2O*6t4cS*!)h8hJ27ODDZ}jSghv*PJPxn{Bjfm-fZk#Lx
zz&d*tXkIo<jX8v>KGsauM322_`gZ*xK=rBZOZWHgb9lkP5Zk#|szc94A12X`Y&Ag@
zk#Qz;8D5r)hqD_C*7Dc{73fASWMo$`&84iD<Zu8Cf@?8W(<L%dpWOoZ0LYTac6Q<8
zBE2m$-~AyayYFpY0!580ITH(6f@i-NvA<xhoG_K~-3N}_%ZJT*A+=Xz?wlMn*{vx2
zp2`8L#~wYUc8yXQ7ucjV%IDaUoa3R@msQ>P9Qj6BG0W#^p2b~?tuP>;H!UW1Rrh|r
z#}%T|%ck5$+ti{wuY7<Y_QMO?D*0Xj9r`Dk7V?+T<WV*Vuog{#;xQsa#lI}5xq1lB
z8kqb4%yx>t{?DyIK->No5o+GU(c?c{{)Zp+A6xvtxb+YR(01n)fNo@glZTk;>H&C<
z=ox1Hg6Q=xH!C`9@YA`p6D>ds`Y`SKFX852uGjxK#9T0st^axM>B3FmhyIHUcA@tF
zi!k;-h(kJ-XU7%ib9}&kqB6KKc<Qz1E#RvyqscGe@bZ5?`=5R$2IRGq_RrMkJblFb
zmy-5>Xr*9{h91rSJ6`&cR?C07Yc)IrFp7w>7#A!qa6cW(@;Y+h{F#J6#lJU_c?+80
z7vkE6x9;C|x_FPR*%~$71$!;}a>jq3um2?7e`OUm7%{kULE^h>S>A@Cx#05=)$+N+
zBSh!^?NbGG+hyw^aCuZ5K&vl=AmFugV)yTpxH49m+W#P;|HCW)xmCMu<9|r=SHEhp
zc@v__YdsEs3B;q>dZykA0*FPo@V`VoLyxsb{R?g@5uOwmLo``)FeA|a^Y+LPFW?fO
z4(Ss9|0OYBOdr+uKizHqelZpQ*Pi7553T1CkifPf{uTe081COylnAo8;O~9#-2W1F
z?xF%vQi)p(v2&f-Y2sjI)BnT=d)5E|4Wg?6o!qU9LUe|gXu26;>Z1k_y{!m`+d!5{
zAo<I_@7NWXzpQyEB|z|LPNg-ztj|1tgDc^VKGTx`louJ#*rf~hTB!-0zIC}&m&w0E
z&P$B^uNAT)^jDLw4z^xor~ew3{~x{nS68J-+y8XuVb8kFF7k>?4cg_+<z{^85_Ujp
zal*iBQQB39?*w=2A3hre`nsO!JF?pFEP(%32Pfm{RWrvss$QVVL_*7h)Xs^(41cKq
z-^$s$eX(vvBM0kjhG+g&phVN`p}%^HnQikq8V3@T+xBgY5}tiidS<+u8$^|`jXRMp
z?f85KnH|4NXu(_GylGBUZ@2~1hmrFv0gU$nAPNOY>7_EMB2KZ1W`45<YZnip&sA^O
zi!Iz-8n{&Ib-_3b9g!#6^=A)$!|->X`=4UHFb)^0Lb(QPp+wKF0}8e`;d$%jJY)6w
z@6)x8^n8>wJM+>Ty-QiC3sq)J{wKdTF;$Vi`oEh#5BDupue`X>Io)`Y1cCyk)N!Gt
zy_wk`62YHuwm&nnv~_ftE&36hT1bRcIv!x-S)-U@(P=23Zk|3yudV16v-3dT)1F?-
z4iOt^ua`_xmbbU0D|}BI7knz_hw%$v6}y$(Y?~36y^Y(?KJkAhK(^pMz1#vF76q&6
z&_UCD2I<<d$ddAA<wz!}O&(nG=fkb&D4BfCyrWrEfn8L8TfIWn;cVTBd)1ly&{32A
zkpW%((5m+7!WF}nzq9mAJi45*dW9PI;OJ9D_yQqmOY&`dSt@G9Ys*81h*4s7kv^(%
zX>};%7bC&JWTUyY%QvgpZcWbfymx4ki61KiBjbpk`W6Q$powKK<J)$7xcgUTm0lG6
znjqY%Tav98+a|i_?i#{Bg#R-6b1WY+|HGHle_s=K)vveB!#^hn*fds|R6GV;LD`vw
zy-}%oD|=ynjpA_j$EAL|$scwx^`Uzp+$Cc*LFPWMnU#e6?I)Ltu#NVB++R%j@E?$a
z_eQ$yQ{)=#bW@`0KkP))m*9!G`TuMGG4Ecd-Du|jAx)>VNC@-otk*x5>t1V;5^=^9
zoO?brM~zWO^3`<t&U?y$y?jqhn^qbTPWx#Lka8IN9Mn{e_`?)XP}{snrsG9F!no&J
zQ8BmC`E=8nDlA7zrhP;~aYiJ|{Tk1h)gUP*!r5!o;wa4bbX0VK%5bGg&U<Oh!dY+Z
zjPWmjVt=t$T=)wq5u5u7y;(Fr!z^di?AKr>f8T;xYw7;l@OjMjrJ~HYO6$<%vk?Uf
z#i4q+9q5+xSsh_AK>a6xncm7Ult21a^p2?T;)96D<4VAz=010~bxp&Iikz~4RQcb1
z?V(8JWa^Vk=2AF+%Dv=k=4}r9pc!1a57t!NPvimv@YEgx{%?gPZf)qR9Z}`<2I)E;
zheiQw4<He#Ua8EuDs$)5+uM8f!o|m7sZI!a%+R9{w=s6$%|t`vS%NjVwWI#}At}!b
z+UO{QQ`MxapO5rz02L3)4b<#;aq%_<4;)o(Db(x>Y<YvhUVr~b1<QR3E@9YYl7Qeb
zIdj5LfqH+ci*x+Z(xKn%i8f*e2{iohE>*Nq7M1GK&RL+5=?U{8At8aaI`5VNi3$Kr
zO1DDhON=U9P`y#z!N=NmDySmuf;5y>K;B%VYmTw|kZ`r#1iOuX1b`8H=)Hps4eeD(
z`_>p^O4DNWGSAOfKOxc*UI#p5+-^K0mfH(hL|AzqD!NTO%egNK{?UX~Y$riZnKKgn
z-y=<45F^gX@#_Z_@EYSv@J8_b83(!s?Q(vYsfV<Qq9ytY_2%U_ZGG(0b^ybP`y7_m
g>}+go#GEt#!iY<A+@@RudP$_Dpe|qj+&u9A0}-rKhX4Qo