From 5a81a67d45ddb8bca91760c751fc9ef24cc0354e Mon Sep 17 00:00:00 2001 From: Duduf Date: Tue, 1 Nov 2022 17:09:33 +0100 Subject: [PATCH] v0.6 --- docs/changelog-api/index.html | 1447 +++++++++++++++ docs/changelog-app/index.html | 1491 +++++++++++++++ docs/changelog-maya/index.html | 1475 +++++++++++++++ docs/changelog-server/index.html | 1483 +++++++++++++++ docs/changelog/index.html | 476 ++--- docs/components/addons/index.html | 106 +- docs/components/addons/maya-extend/index.html | 106 +- docs/components/addons/maya-import/index.html | 106 +- .../addons/maya-pipeline/index.html | 106 +- .../components/addons/maya-publish/index.html | 106 +- .../addons/maya-scenesetup/index.html | 106 +- docs/components/addons/maya/index.html | 106 +- docs/components/client/admin/index.html | 106 +- .../components/client/applications/index.html | 106 +- docs/components/client/assetgroups/index.html | 106 +- docs/components/client/assets/index.html | 106 +- docs/components/client/filetypes/index.html | 106 +- docs/components/client/index.html | 106 +- docs/components/client/install/index.html | 106 +- docs/components/client/pipeline/index.html | 106 +- docs/components/client/pipetypes/index.html | 106 +- docs/components/client/production/index.html | 106 +- docs/components/client/project/index.html | 106 +- docs/components/client/projects/index.html | 106 +- docs/components/client/schedule/index.html | 106 +- docs/components/client/sequences/index.html | 106 +- docs/components/client/settings/index.html | 106 +- docs/components/client/shots/index.html | 106 +- docs/components/client/states/index.html | 106 +- docs/components/client/steps/index.html | 106 +- .../client/templateassetgroups/index.html | 106 +- .../client/templatesteps/index.html | 106 +- docs/components/client/users/index.html | 106 +- docs/components/files/index.html | 106 +- docs/components/files/naming/index.html | 106 +- docs/components/files/tree/index.html | 106 +- docs/components/index.html | 106 +- docs/components/server/admin/index.html | 106 +- docs/components/server/config/index.html | 1596 +++++++++++++++++ docs/components/server/index.html | 106 +- .../server/install-docker-mysql/index.html | 1470 +++++++++++++++ .../server/install-docker-sqlite/index.html | 1457 +++++++++++++++ docs/components/server/install-src/index.html | 1445 +++++++++++++++ docs/components/server/install/index.html | 208 ++- docs/components/server/update/index.html | 112 +- docs/credits/index.html | 106 +- docs/dev/add-ons-reference/enum/index.html | 106 +- .../implementation/index.html | 106 +- docs/dev/add-ons-reference/index.html | 106 +- .../add-ons-reference/ram_asset/index.html | 106 +- .../ram_assetgroup/index.html | 106 +- .../ram_daemon_interface/index.html | 106 +- .../ram_file_info/index.html | 106 +- .../ram_file_manager/index.html | 106 +- .../add-ons-reference/ram_filetype/index.html | 106 +- .../dev/add-ons-reference/ram_item/index.html | 106 +- .../ram_metadata_manager/index.html | 106 +- .../add-ons-reference/ram_object/index.html | 106 +- .../dev/add-ons-reference/ram_pipe/index.html | 106 +- .../add-ons-reference/ram_pipefile/index.html | 106 +- .../add-ons-reference/ram_project/index.html | 106 +- .../add-ons-reference/ram_sequence/index.html | 106 +- .../add-ons-reference/ram_settings/index.html | 106 +- .../dev/add-ons-reference/ram_shot/index.html | 106 +- .../add-ons-reference/ram_state/index.html | 106 +- .../add-ons-reference/ram_status/index.html | 106 +- .../dev/add-ons-reference/ram_step/index.html | 106 +- .../dev/add-ons-reference/ram_user/index.html | 106 +- docs/dev/add-ons-reference/ramses/index.html | 106 +- docs/dev/daemon-reference/create/index.html | 106 +- .../getCurrentProject/index.html | 106 +- docs/dev/daemon-reference/getData/index.html | 106 +- .../daemon-reference/getObjects/index.html | 106 +- docs/dev/daemon-reference/getPath/index.html | 106 +- .../daemon-reference/getProjects/index.html | 106 +- .../getRamsesFolder/index.html | 106 +- docs/dev/daemon-reference/index.html | 106 +- docs/dev/daemon-reference/ping/index.html | 106 +- docs/dev/daemon-reference/raise/index.html | 106 +- .../setCurrentProject/index.html | 106 +- docs/dev/daemon-reference/setData/index.html | 106 +- .../daemon-reference/uuidFromPath/index.html | 106 +- docs/dev/files/naming/index.html | 106 +- docs/dev/index.html | 106 +- docs/dev/objects/index.html | 106 +- docs/dev/server-reference/index.html | 106 +- docs/index.html | 110 +- docs/licenses/gfdl/index.html | 106 +- docs/licenses/gnu-gpl/index.html | 110 +- docs/pipeline/administration/index.html | 106 +- docs/pipeline/index.html | 106 +- docs/pipeline/pipeline/index.html | 106 +- docs/pipeline/planning/index.html | 106 +- docs/pipeline/production/index.html | 106 +- docs/quickstart/index.html | 106 +- docs/search/search_index.json | 2 +- docs/sitemap.xml | 214 ++- docs/sitemap.xml.gz | Bin 756 -> 796 bytes src-docs/docs/changelog-api.md | 16 + src-docs/docs/changelog-app.md | 53 + src-docs/docs/changelog-maya.md | 38 + src-docs/docs/changelog-server.md | 46 + src-docs/docs/changelog.md | 308 +--- src-docs/docs/components/server/config.md | 173 ++ .../components/server/install-docker-mysql.md | 47 + .../server/install-docker-sqlite.md | 34 + .../docs/components/server/install-src.md | 19 + src-docs/docs/components/server/install.md | 104 +- src-docs/docs/components/server/update.md | 2 +- src-docs/mkdocs.yml | 13 +- 110 files changed, 21367 insertions(+), 1274 deletions(-) create mode 100644 docs/changelog-api/index.html create mode 100644 docs/changelog-app/index.html create mode 100644 docs/changelog-maya/index.html create mode 100644 docs/changelog-server/index.html create mode 100644 docs/components/server/config/index.html create mode 100644 docs/components/server/install-docker-mysql/index.html create mode 100644 docs/components/server/install-docker-sqlite/index.html create mode 100644 docs/components/server/install-src/index.html create mode 100644 src-docs/docs/changelog-api.md create mode 100644 src-docs/docs/changelog-app.md create mode 100644 src-docs/docs/changelog-maya.md create mode 100644 src-docs/docs/changelog-server.md create mode 100644 src-docs/docs/components/server/config.md create mode 100644 src-docs/docs/components/server/install-docker-mysql.md create mode 100644 src-docs/docs/components/server/install-docker-sqlite.md create mode 100644 src-docs/docs/components/server/install-src.md diff --git a/docs/changelog-api/index.html b/docs/changelog-api/index.html new file mode 100644 index 00000000..e03d5091 --- /dev/null +++ b/docs/changelog-api/index.html @@ -0,0 +1,1447 @@ + + + + + + + + + + + + + + API - Ramses + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+
+
+ +

META

+

Ramses API Changelog

+

0.6.0-Beta

+

New

+
    +
  • 0.6.0 compatibility update.
    • +
+

0.5.0-Beta

+

New

+
    +
  • Changed and simplified data exchange.
    • +
  • Added step general settings
    • +
+ +
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/changelog-app/index.html b/docs/changelog-app/index.html new file mode 100644 index 00000000..eb613b82 --- /dev/null +++ b/docs/changelog-app/index.html @@ -0,0 +1,1491 @@ + + + + + + + + + + + + + + Application - Ramses + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+
+
+ +

META

+

Ramses Application Changelog

+

Known Issues

+
    +
  • #263: The client may crash when removing a project which is not empty.
    • +
  • On Windows, the tray icon may not be removed if the client crashes.
    • +
  • On Mac OS, the user specific settings (current project, location of the nodes in the pipeline editor, …) may not be saved.
    • +
  • On Linux, interaction with the timeline may be limited (impossible to select a shot, or open its folder).
    • +
+

0.6.0-Beta

+

New

+
    +
  • It is now possible to set the port to use to connect to the server.
    • +
  • Database manager/cleaner (for administrators)
    • +
+

Improvements

+
    +
  • A local database can now connect only to the server it was intended to.
    • +
  • The application can now show the server logs.
    • +
  • Better log and display of errors
    • +
  • Set to offline in case of server errors.
    • +
+

Fixes

+
    +
  • Fixed performance issues with the schedule.
    • +
  • The resolution of the projects is now correctly saved.
    • +
+

0.5.0-Beta

+

New

+
    +
  • Many UI and preformance improvements.
    • +
  • Implemented the Offline mode
    • +
  • Changed and simplified data exchange.
    • +
  • Added step general settings
    • +
+

0.3.0-Alpha

+

New

+
    +
  • Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password “password” and you’ll have to update all passwords for all users from that account to re-enable their accounts.
    • +
  • The Client shows the current RxLab’s funding status.
    • +
  • The schedule now has a dedicated line to add notes/comments.
    • +
  • Added publish settings to steps, to be used with add-ons.
    • +
  • added a log level selector to the console.
    • +
+

Improvements

+
    +
  • The status of the connexion (offline, connected, secured) is now shown on the status bar. A warning is logged when the connexion is not secured.
    • +
  • Changing the file type of a step automatically updates the custom settings accordingly.
    • +
+ +
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/changelog-maya/index.html b/docs/changelog-maya/index.html new file mode 100644 index 00000000..9467b686 --- /dev/null +++ b/docs/changelog-maya/index.html @@ -0,0 +1,1475 @@ + + + + + + + + + + + + + + Maya - Ramses + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+
+
+ +

META

+

Ramses Laya Add-on Changelog

+

0.6.0-Beta

+

Fixes

+
    +
  • Fixed ‘save scene as’ with incorrect step settings
    • +
+

0.5.2-Beta

+

Fixes

+
    +
  • Fixed ‘save scene as’ when the corresponding step doesn’t have any general setting
    • +
+

0.5.1-Beta

+

Fixes

+
    +
  • Removed duplicate formats in import settings
    • +
  • Don’t add selection to sets during scene setup
    • +
  • Fixed publish with missing shaders
    • +
+

0.5.0-Beta

+

New

+
    +
  • Completely changed (and simplified) the server API to support syncing with clients.
    • +
  • Warning: this update is not compatible with older versions. As we’re moving from Alpha to Beta test, there’s no way to migrate your data when updating this time, as we were just testing the framework. Now that we’re in Beta test, this is fixed and future updates won’t break compatibility anymore.
    • +
+

0.3.0-Alpha

+

New

+
    +
  • Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password “password” and you’ll have to update all passwords for all users from that account to re-enable their accounts.
    • +
  • The schedule now has a dedicated line to add notes/comments.
    • +
  • Added publish settings to steps, to be used with add-ons.
    • +
+ +
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/changelog-server/index.html b/docs/changelog-server/index.html new file mode 100644 index 00000000..fdab6960 --- /dev/null +++ b/docs/changelog-server/index.html @@ -0,0 +1,1483 @@ + + + + + + + + + + + + + + Server - Ramses + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ + +
+
+
+ +

META

+

Ramses Server Changelog

+

0.6.0-Beta

+

New

+
    +
  • We now provide tested Docker configurations to easily install and run Ramses Docker containers.
    • +
  • Each instance of a Ramses Server now had a unique universal identifier (UUID) to make sure a client won’t connect to a wrong server by mistake.
    • +
  • Added new server-side logs.
    • +
  • The login requests now returns details (data) about the connected user (if login is successful).
    • +
  • Ability to deactivate the session timeout.
    • +
+

Fixes

+
    +
  • Fixed the user table in case a (removed) username already exists when creating a new user.
    • +
  • Fixed installation issues when using SQLite.
    • +
+

0.5.1-Beta

+

New

+
    +
  • Added (debug) logs to the replies which can be shown by clients.
    • +
+

Fixes

+
    +
  • Fixed issues when table prefixes start with a number.
    • +
  • Fixed connection issues when the URL ends with a /
    • +
  • Ignore some sync errors when not in Dev mode
    • +
+

0.5.0-Beta

+

New

+
    +
  • Changed and simplified data exchange.
    • +
  • Added step general settings
    • +
+

0.3.0-Alpha

+

New

+
    +
  • The Rubika Flavor is merged into the official add-on.
    • +
  • Added update command
    • +
  • Added publish settings
    • +
  • Added import and update settings
    • +
+ +
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/changelog/index.html b/docs/changelog/index.html index dc97ef29..a1f7f58c 100644 --- a/docs/changelog/index.html +++ b/docs/changelog/index.html @@ -11,7 +11,7 @@ - Changelog - Ramses + General - Ramses @@ -72,7 +72,7 @@
  • - v0.5.0-Beta + v0.6 (Beta)
    • @@ -390,6 +390,30 @@ +
  • + Install from source +
    • + + + +
  • + Docker (MySQL) +
    • + + + +
  • + Docker (SQLite) +
    • + + + +
  • + Configuration +
    • + + +
  • Update
    • @@ -697,10 +721,43 @@ +
  • + Changelog + +
    • +
  • @@ -741,7 +798,7 @@
  • -
    • @@ -763,7 +820,7 @@
  • - v0.5.0-Beta + v0.6 (Beta)
    • @@ -961,6 +1018,22 @@ +
  • Install from source
    • + + + +
  • Docker (MySQL)
    • + + + +
  • Docker (SQLite)
    • + + + +
  • Configuration
    • + + +
  • Update
    • @@ -1182,7 +1255,32 @@ -
  • Changelog
    • +
  • + + +
    • @@ -1211,75 +1309,11 @@ @@ -1287,10 +1321,17 @@
    -

    META

    +

    META

    Ramses Changelog

    -

    We’re listing here all changes for all versions of the whole Ramses framework. To make things simpler, all components always share the same version, all are updated if one is updated. All the components you’re using should always be in the same version.

    -

    For each version, there’s also a list of known issues. To read more details about these issues, check our tracking on Github.

    +

    By component

    +

    ▹ Ramses Application

    +

    ▹ Ramses Maya Add-on

    +

    ▹ Ramses Server

    +

    ▹ 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’re doing.

    @@ -1308,286 +1349,7 @@

    Planned Features

  • 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’s 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.
    • - -

    Known Issues

    -

    Client and Daemon

    -
      -
    • #263: The client may crash when removing a project which is not empty.
      • -
    • On Windows, the tray icon may not be removed if the client crashes.
      • -
    • On Mac OS, the user specific settings (current project, location of the nodes in the pipeline editor, …) may not be saved.
      • -
    • On Linux, interaction with the timeline may be limited (impossible to select a shot, or open its folder).
      • -
    -

    0.5.0-Beta

    -

    New

    -
      -
    • Client: Many UI and preformance improvements.
      • -
    • Client: Implemented the Offline mode
      • -
    • Client, Python API, Maya Add-on: Changed and simplified data exchange.
      • -
    • Client, Python API, Maya Add-on: Added step general settings
      • -
    • Server: Completely changed (and simplified) the server API to support syncing with clients.
      • -
    • Server: Warning: this update is not compatible with older versions. As we’re moving from Alpha to Beta test, there’s no way to migrate your data when updating this time, as we were just testing the framework. Now that we’re in Beta test, this is fixed and future updates won’t break compatibility anymore.
      • -
    -

    0.3.0-Alpha

    -

    New

    -
      -
    • Server and Client: Improved security. Warning: new clients are not compatible with older servers, you have to upgrade both. The update will create/update a new Admin user with the password “password” and you’ll have to update all passwords for all users from that account to re-enable their accounts.
      • -
    • The Client shows the current RxLab’s funding status.
      • -
    • Client and Server: The schedule now has a dedicated line to add notes/comments.
      • -
    • Client, Server and Add-ons: Added publish settings to steps, to be used with add-ons.
      • -
    • Client: added a log level selector to the console.
      • -
    -

    Improvements

    -
      -
    • Client: The status of the connexion (offline, connected, secured) is now shown on the status bar. A warning is logged when the connexion is not secured.
      • -
    • Client: Changing the file type of a step automatically updates the custom settings accordingly.
      • -
    • Maya Add-on: The Rubika Flavor is merged into the official add-on.
      • -
    • Maya Add-on: Added update command
      • -
    • Maya Add-on: Added publish settings
      • -
    • Maya Add-on: Added import and update settings
      • -
    -

    Fixes

    -
      -
    • Client: Username and password are now correctly saved with new servers.
      • -
    • Client: When logged out of the server, the client now shows the reason, and the error if any, before restarting.
      • -
    -

    0.2.12-Alpha

    -

    Improvements

    -
      -
    • Maya Add-On and Maya Add-on Rubika Flavor: Option to hide HUD when rendering a thumbnail or playplast.
      • -
    -

    Fixes

    -
      -
    • Maya Add-On and Maya Add-on Rubika Flavor: Fixed an issue where sometimes the file path would not be correctly in the dialog window updated using the “save as/new scene” command.
      • -
    -

    0.2.11-Alpha

    -

    New

    -
      -
    • Client: Added a timeline to make it easier to manipulate shots, and to be used with future features…
      • -
    • Client and Server: Added sequence color.
      • -
    -

    Improvements

    -
      -
    • Client: Improved statistics panel.
      • -
    -

    Fixes

    -
      -
    • Client and Server: Fixed ordering shots and steps.
      • -
    • Client and Server: Fixed changing a schedule item if it had been deleted before.
      • -
    • Server: Steps estimation method is now correctly returned.
      • -
    • Server: States are now correctly updated.
      • -
    -

    0.2.10-Alpha

    -

    Improvements

    -
      -
    • Client: More details shown in file lists (modification date, and more to come).
      • -
    -

    Fixes

    -
      -
    • Client: Fixed incorrect rights to edit steps and pipes for project administrators.
      • -
    • Maya Add-on: Fixed freezing transform when there are constraints or other links (ignore).
      • -
    • Maya Add-on - Rubika Flavor: Fixed minor publish issue with Sets.
      • -
    • Client: Project edition is now correctly disabled for all users but Administrators.
      • -
    • Server: Fixed an issue where step estimations would not be correctly updated.
      • -
    • Maya Add-On: Fixed an issue where Maya Ascii (.ma) files would contain binary data.
      • -
    • Maya Add-On - Rubika Flavor: When publishing animation, constraints are now correctly kept.
      • -
    -

    0.2.9-Alpha

    -

    New

    -
      -
    • All: The template versionning system has been changed and improved. Each template must now be stored in its own subfolder correctly named. See the Ramses Tree / Folder structure section for more details.
      • -
    • Client: The UI is more customizable, and the previous window state (location, toolbars, dockers) is restored when starting the application.
      • -
    • Maya Add-on - Rubika Flavor: Added a replace method to replace an existing asset/pipe with another one.
      • -
    • Python API: Added Ramses.replaceScripts and Ramses.replaceItem.
      • -
    • Server: Added logs and fixed security issues.
      • -
    -

    Improvements

    -
      -
    • Client: Important UI tweaks.
      • -
    • Maya Add-on: Improved icons.
      • -
    • Client: The current server address is now displayed in the bottom right corner of the application.
      • -
    • Client: The previous window state and dock locations are now restored at startup.
      • -
    • Client: UI tweaks and minor improvements.
      • -
    • Maya Add-on: UI tweaks and new icons.
      • -
    -

    Fixes

    -
      -
    • Client: Fixed a potential crash when using filters on the tables.
      • -
    -

    0.2.8-Alpha

    -

    Improvements

    -
      -
    • Maya Add-on - Rubika Flavor: Fixed shading publication issues.
      • -
    -

    0.2.7-Alpha

    -

    Improvements

    -
      -
    • Client: Administrators can now modify the status history.
      • -
    -

    Fixes

    -
      -
    • Client: Fixed potential crash when searching/filtering tables.
      • -
    • Client: Fixed the status which may not be updated using the right-click context menu.
      • -
    -

    0.2.6-Alpha

    -

    Improvements

    -
      -
    • Client: When a task is not automatically estimated, the estimation is now named “goal” instead of “estimation”. Warning: estimations manually set to 0 day are temporarilly ignored, use 0.0 day instead. This will be fixed later in 0.3.0.
      • -
    • Client: A new Sort menu in the tables allows to sort items by name, difficulty, estimation, completion ratio…
      • -
    • Client: The UI has been tweaked to be a bit simpler to use and improve a bit the performance.
      • -
    -

    Fixes

    -
      -
    • Client: The title is now correctly shown on top of the properties panel for statuses/tasks.
      • -
    -

    0.2.5-Alpha

    -

    Fixes

    -
      -
    • Client: Fixed pipes breaking when re-ordering steps.
      • -
    • Client: UI: Fixed the editor panel too big for its dock.
      • -
    • Server: Fixed error thrown when updating some pipes.
      • -
    • Maya Add-on: Fixed performance issue when using the saveas command.
      • -
    • Maya Add-on - Rubika Flavor: Fixed publish shaders not publishing all nodes.
      • -
    • Maya Add-on - Rubika Flavor: Fixed update command not listing shader nodes.
      • -
    • Maya Add-on - Rubika Flavor: Fixed publish anim not hiding the progress bar at the end of the process.
      • -
    • Python API and all Python Add-ons: Fixed performance issue when loading the list of assets with empty asset groups.
      • -
    -

    0.2.4-Alpha

    -

    Improvements

    -
      -
    • Client: Several UI improvements.
      • -
    • Client: Performance improvements, especially when loading big projects and in the schedule table.
      • -
    • Client: Keep a server history list in the server settings, to make it easier to switch servers when working with several different servers.
      • -
    • Client: Now checks if an updated version is available; added a donation link.
      • -
    • Client and Server: Added version compatibility checks.
      • -
    -

    Fixes

    -
      -
    • Client: Queue server requests to prevent spamming.
      • -
    • Server: Fixed status not correctly updated when the estimation was 0.
      • -
    • Maya Add-on - Rubika Flavor: Fixed publishing geometry and rigs with hidden nodes.
      • -
    • Maya Add-on: Fixed publishing with invalid or missing references.
      • -
    -

    0.2.2-Alpha

    -

    Improvements

    -
      -
    • Client: Improved statistics accuracy and UI
      • -
    • Client: Checks if updates are available and added a donation button
      • -
    • Client: More UI tweaks
      • -
    -

    Fixed issues

    -
      -
    • Server: fixed server error when removing pipes from the pipeline.
      • -
    -

    0.2.1-Alpha

    -

    Fixed issues

    -
      -
    • Server: fixed update script not updating the database correctly.
      • -
    • Server: fixed incomplete list of steps for some projects.
      • -
    • Client: fixed crash when loading some projects.
      • -
    -

    0.2.0-Alpha

    -

    Improvements

    -
      -
    • All: Added custom setttings in the pipe files.
      • -
    • Client: Name and ID are now validated before any change to make sure they fit the Ramses naming scheme.
      • -
    • Client and server: Added colors associated to users, shown in the schedule and item tables when the user is assigned to an item.
      • -
    • Client: Added User and State filters in the production tables.
      • -
    • Client: Added an option to show or hide all details in the tables.
      • -
    • Client: Added the ability to copy and paste comments from the tables.
      • -
    • Client: Added versionning for published files.
      • -
    • Client: Better feedback in case a change is not accepted by the server.
      • -
    • Client: Better UI feedback when creating/editing users.
      • -
    • Client: Added menus and shortcuts in administration panels.
      • -
    • Client: The pipeline layout is now saved per project too (and not only per user), with the ability to manually save and reload the default project layout.
      • -
    • Client: The project folder is now a local setting; you can push the setting to the server to share it with everyone.
      • -
    • Client: When offline, the client does not anymore try (and fail) to refresh its data from the server.
      • -
    • Client: Major performance improvement of the UI.
      • -
    • Client: Lots of UI tweaks.
      • -
    • Client: Added a welcome page to help you adjust the most important Ramses settings on first launch.
      • -
    • Client: NO state in tables is now greyed out.
      • -
    • Add-ons: A comment is added to a file when it’s restored from a previous version.
      • -
    • Add-ons: Added a debug mode for developpers.
      • -
    • Add-ons: For Python addons (all except Adobe), multi-threading makes long operations - like publishing or restoring files - non-blocking and much more performant.
      • -
    • Maya Add-on: Updated to use the new version of the Python API, improves stability and performance.
      • -
    • Maya Add-on: Handle the new versionning system for published files.
      • -
    • Maya Add-on: Filter shots by sequence in the open/import dialog.
      • -
    • Maya Add-on: New Debug mode setting for developpers.
      • -
    • Maya Add-on - Rubika Flavor: Improved stability and fixed a bunch of bugs.
      • -
    • Maya Add-on - Rubika Flavor: Improved publication for all pipes:
        -
      • Ability to export both to Alembic and Maya at once.
        • -
      • Ability to always choose between ASCII or Binary.
        • -
      • Ability to export animated geometry.
        • -
      • Ability to publish/import as reference most of the pipes
        • -
      -
      • -
    • Maya Add-on - Rubika Flavor: Improved updater:
        -
      • Filter selected nodes only
        • -
      • Revert to an older version
        • -
      • Keep PRS offsets
        • -
      -
      • -
    • Server: added the option to use an SQLite database instead of MySQL. This makes it even simpler to install and manage, when there isn’t too many users.
      • -
    • Server: Name and ID are now validated before any change to make sure they fit the Ramses naming scheme.
      • -
    • Server: Improved security with database encryption for sensible data (user personnal information and roles).
      • -
    -

    Changes to the scripting API

    -
      -
    • Added versionning for published files.
      • -
    • Added the new RamFileInfo class to help handling file names.
      • -
    • Improved the RamFileManager class and added a few new methods. Be careful, some method names have changed, and some methods were removed/moved to RamFileInfo, especially methods concerning file publication.
        -
      • Removed or moved to RamFileInfo: isRestoredFilePath, composeRamsesFileName, buildRamsesFileName, decomposeRamsesFilePath, isRamsesName, decomposeRamsesFileName.
        • -
      • RamFileManager.getLatestVersion is now getLatestVersionInfo and returns a RamFileInfo instance.
        • -
      • RamFileManager.getPublishPath is now getPublishInfo and returns a RamFileInfo instance.
        • -
      • RamFileManager.copyToPublish is renamed RamFileManager.publishFile.
        • -
      • Copy operations for files is now multi-threaded. That improves a lot the performance of your scripts, but that means the script continues while the new file doesn’t necessarilly exist yet, be careful!
        • -
      -
      • -
    • Updated RamItem to use the new versionning system for published files.
        -
      • RamItem.publishFilePaths(resource, step) is replaced by RamItem.publishedVersionFolderPaths(step) which returns a list of folder paths (sorted from oldest to latest).
        • -
      • RamItem.isPublished(resource, step) no longer have the resource argument.
        • -
      -
      • -
    • Updated RamStep to use the new versionning system for published files.
        -
      • RamStep.templatesPublishFilePaths is replaced by RamStep.templatesPublishedVersionFolderPaths which now returns a list of folders.
        • -
      -
      • -
    • Ramses callbacks for publishing, importing, changing status have changed a bit.
      • -
    • Files are now copied using a separate thread whenever possible. This improves a lot the performance. Call RamFileManager.waitFiles() if your script needs the files to be actually written to continue.
      • -
    -

    Fixed issues

    -
      -
    • Client: Available projects are only the projects the user has been assigned to.
      • -
    • Client: When clicking the “network settings” button from the login panel, you’re now correctly redirected to the right network settings tab.
      • -
    • Client: Fixed an wrong error when trying to log in with an unknown user name.
      • -
    • Client: Crash when removing an asset group still containing assets.
      • -
    • Client: Fixed an issue where shot/asset attribution would be reinitialized on edition from the production table.
      • -
    • Client: Fixed the size of the dropdown menus sometimes being too small for long sequence/asset group names.
      • -
    • Client: Versions for working files and published items are now correctly sorted from highest version to lowest, according to the resource if any.
      • -
    • Maya Add-on: The “preview” function now works correctly.
      • -
    • Maya Add-on (Rubika Flavor): Import Geo now works correctly.
      • -
    -

    0.1.3-Alpha

    -

    Fixed issues

    -
      -
    • Client: Loading of the projects taking a very long time has been fixed. Projects now load in an instant.
      • -
    • Client: Linux .deb packaged fixed (the doc is now in its right folder).
      • -
    • Server and client: Difficulty and estimations for shots are now correctly set.
      • -
    -

    0.1.2-Alpha

    -

    Improvements

    -
      -
    • Client: Improved feedback when editing items.
      • -
    • Python API and Maya Add-on: Improved comments when saving file (includes the version number when saving a restored version).
      • -
    -

    Fixed issues

    -
      -
    • Client: Menus, Context menus and clicks now work correctly on the Schedule Manager when there’s no project selected at startup.
      • -
    • Client: Minor code refactor to remove some warnings on Qt 5.15 build.
      • -
    • Server: Fixed an issue where users could not change their own password.
      • -
    • Maya Add-on - Rubika Flavor: Deformers and shaders are now correctly reset on geometry update.
      • -
    -

    0.1.1-Alpha

    -

    Initial release.

    +
    -

    META

    +

    META

    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… It doesn’t 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!

    +

    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

    @@ -1239,7 +1336,7 @@

    Prerequisites

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

    +

    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:

    -

    Once you’ve made your choice, follow these steps:

    -
      -
    1. (MySQL only) Create a new base on the SQL server, along with its user and password.
      2. -
    2. Un-Zip the Ramses Server you’ve downloaded.
      3. -
    3. Edit config/config.php with needed info (read below).
      4. -
    4. (optional) Edit config/config_logs.php if you want to enable logs on the server.
      5. -
    5. Copy the Ramses Server files to the web server (you can just copy the ramses folder from the ZIP archive).
      6. -
    6. Go to http://your.server/ramses/install.
      7. -
    7. Delete the install folder from the server.
      8. -
    -

    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.

    -

    config.php

    -

    The config.php file you have to edit looks like that:

    -
        // === DEV MODE ===
-
-    // Activates printing the SQL & PHP errors.
-    // For security reasons, it is important to set this to false in production mode
-    $devMode = false;
-
-    // ==== SQL SETTINGS ====
-
-    // either 'mysql' (works for MariaDB too) or 'sqlite'
-    $sqlMode = 'sqlite';
-
-    // ==== MySQL/MariaDB SETTINGS ====
-
-    // Host URL
-    $sqlHost = "localhost";
-    $sqlPort = 3306;
-    // Database name
-    $sqlDBName = "ramses";
-    // User
-    $sqlUser = "ramses";
-    // Password
-    $sqlpassword = "a89pppuD";
-    // Table prefix
-    // should be a random character string
-    // you can setup multiple instances on the same DB
-    // if each use a different prefix
-    $tablePrefix = "jaom7Jdr";
-
-    // ==== SESSION & SECURITY SETTINGS ====
-
-    // Whether to accept only SSL connections
-    // This should always be true, except maybe on dev environments.
-    $forceSSL = true;
-
-    // Session timeout (seconds)
-    // The client will be disconnected after being idle for this time
-    // 30 minutes by default (1800) are more than enough:
-    // The official client makes a call at least every 2 minutes by default.
-    $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 must be the server public adress, exactly as used in the clients
-    $serverAddress = "localhost/ramses";
-
-    // This should never be changed, unless you change the key before building the official client or implementing your own client.
-    // It is used to break compatibility between some updates of the client/server framework
-    // It can be used to make sure only your own client, built by yourself, can connect to your own server. In this case, keep it secret!
-    // It is used to hash passwords.
-    $clientKey = "drHSV2XQ";
-
    - -

    These next options are only used in MySQL mode. Ignore them when using SQLite.

    - -

    And finally complete these settings too:

    -
    +

    Once you’ve made your choice, follow these guides according to your environement:

    +

    ▹ Install from source

    +

    ▹ Docker (MySQL)

    +

    ▹ Docker (SQLite)

    +

    You can adjust the server configuration by editing config/config.php and config/config_logs.php.