update sessions presets

Resolve "Numpy mesh serialization error"

See merge request slumber/multi-user!175

.gitignore

@@ -7,6 +7,11 @@ __pycache__/
 cache
 config
 *.code-workspace
+multi_user_updater/
 
 # sphinx build folder
-_build
+_build
+
+# ignore generated zip generated from blender_addon_tester
+*.zip
+libs

.gitlab-ci.yml

@@ -0,0 +1,5 @@
+stages:
+  - build
+
+include:
+  - local: .gitlab/ci/build.gitlab-ci.yml

.gitlab/ci/build.gitlab-ci.yml

@@ -0,0 +1,11 @@
+build:
+  stage: build
+  image: debian:stable-slim
+  script:
+    - rm -rf tests .git .gitignore script
+  artifacts:
+    name: multi_user
+    paths: 
+     - multi_user
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive

.gitlab/ci/deploy.gitlab-ci.yml

@@ -0,0 +1,21 @@
+deploy:
+  stage: deploy
+  needs: ["build"]
+  image: slumber/docker-python  
+  variables:
+    DOCKER_DRIVER: overlay2
+    DOCKER_TLS_CERTDIR: "/certs"
+    GIT_SUBMODULE_STRATEGY: recursive
+  
+  services:
+  - docker:19.03.12-dind
+
+  script:
+    - RP_VERSION="$(python scripts/get_replication_version.py)"
+    - VERSION="$(python scripts/get_addon_version.py)"
+    - echo "Building docker image with replication ${RP_VERSION}"
+    - docker build --build-arg replication_version=${RP_VERSION}  --build-arg version={VERSION} -t registry.gitlab.com/slumber/multi-user/multi-user-server:${VERSION} ./scripts/docker_server
+    - echo "Pushing to gitlab registry ${VERSION}"
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - docker tag registry.gitlab.com/slumber/multi-user/multi-user-server:${VERSION} registry.gitlab.com/slumber/multi-user/multi-user-server:${CI_COMMIT_REF_NAME}
+    - docker push registry.gitlab.com/slumber/multi-user/multi-user-server

.gitlab/ci/doc.gitlab-ci.yml

@@ -0,0 +1,16 @@
+pages:
+  stage: doc
+  needs: ["deploy"]
+  image: python
+  script:
+  - pip install -U sphinx sphinx_rtd_theme sphinx-material
+  - sphinx-build -b html ./docs public
+  artifacts:
+    paths:
+    - public
+  only:
+    refs:
+    - master
+    - develop
+
+

.gitlab/ci/test.gitlab-ci.yml

@@ -0,0 +1,7 @@
+test:
+  stage: test
+  image: slumber/blender-addon-testing:latest
+  script:
+    - python3 scripts/test_addon.py
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive

.gitlab/issue_templates/Bug.md

@@ -0,0 +1,46 @@
+<!---
+Please read this!
+
+Before opening a new issue, make sure to search for keywords in the issues
+filtered by the "bug" label:
+
+- https://gitlab.com/slumber/multi-user/-/issues?scope=all&utf8=✓&label_name[]=bug
+
+and verify the issue you're about to submit isn't a duplicate.
+--->
+
+### Summary
+
+(Summarize the bug encountered concisely)
+
+* Addon version: (your addon-version)
+* Blender version: (your blender version)
+* OS: (your os windows/linux/mac)
+
+
+### Steps to reproduce
+
+(How one can reproduce the issue - this is very important)
+
+###  Example Project [optionnal]
+(If possible, please create an example project  that exhibits the problematic behavior, and link to it here in the bug report)
+
+
+### What is the current *bug* behavior?
+
+(What actually happens)
+
+
+### Relevant logs and/or screenshots
+
+(Paste any relevant logs - please use code blocks (```) to format console output,
+logs, and code as it's tough to read otherwise.)
+
+
+### Possible fixes [optionnal]
+
+(If you can, link to the line of code that might be responsible for the problem)
+
+
+/label ~type::bug
+/cc @project-manager

.gitlab/issue_templates/Documentation.md

@@ -0,0 +1,30 @@
+### Problem to solve
+
+<!-- Include the following detail as necessary:
+* What feature(s) affected?
+* What docs or doc section affected? Include links or paths.
+* Is there a problem with a specific document, or a feature/process that's not addressed sufficiently in docs?
+* Any other ideas or requests?
+-->
+
+### Further details
+
+<!--
+* Any concepts, procedures, reference info we could add to make it easier to successfully use the multi-user addom?
+* Include use cases, benefits, and/or goals for this work.
+-->
+
+### Proposal
+
+<!-- Further specifics for how can we solve the problem. -->
+
+### Who can address the issue
+
+<!-- What if any special expertise is required to resolve this issue? -->
+
+### Other links/references
+
+<!-- E.g. related GitLab issues/MRs -->
+
+/label ~type::documentation
+/cc @project-manager

.gitlab/issue_templates/Feature Proposal.md

@@ -0,0 +1,18 @@
+### Problem to solve
+
+<!-- What problem do we solve? Try to define the who/what/why of the opportunity as a user story. For example, "As a (who), I want (what), so I can (why/value)." -->
+
+
+### Proposal
+
+<!-- How are we going to solve the problem?-->
+
+### Further details
+
+<!-- Include use cases, benefits, goals, or any other details that will help us understand the problem better. -->
+
+
+### Links / references
+
+/label ~type::feature request
+/cc @project-manager

.gitlab/issue_templates/Refactoring.md

@@ -0,0 +1,34 @@
+## Summary
+
+<!--
+Please briefly describe what part of the code base needs to be refactored.
+-->
+
+## Improvements
+
+<!--
+Explain the benefits of refactoring this code.
+-->
+
+## Risks
+
+<!--
+Please list features that can break because of this refactoring and how you intend to solve that.
+-->
+
+## Involved components
+
+<!--
+List files or directories that will be changed by the refactoring.
+-->
+
+## Optional: Intended side effects
+
+<!--
+If the refactoring involves changes apart from the main improvements (such as a better UI), list them here.
+It may be a good idea to create separate issues and link them here.
+-->
+
+
+/label ~type::refactoring
+/cc @project-manager

CHANGELOG.md

@@ -35,4 +35,239 @@ All notable changes to this project will be documented in this file.
 - Right management takes view-layer in account for object selection.
 - Use a basic BFS approach for replication graph pre-load.
 - Serialization is now based on marshal (2x performance improvements).
-- Let pip chose python dependencies install path.
+- Let pip chose python dependencies install path.
+
+## [0.0.3] - 2020-07-29
+
+### Added
+
+- Auto updater support
+- Big Performances improvements on Meshes, Gpencils, Actions
+- Multi-scene workflow support
+- Render setting synchronization
+- Kick command
+- Dedicated server with a basic command set
+- Administrator session status
+- Tests
+- Blender 2.83-2.90 support
+
+### Changed
+
+- Config is now stored in blender user preference
+- Documentation update
+- Connection protocol
+- UI revamp:
+  - user localization
+  - repository init
+
+### Removed
+
+- Unused strict right management strategy
+- Legacy config management system
+
+## [0.1.0] - 2020-10-05
+
+### Added
+
+- Dependency graph driven updates [experimental]
+- Edit Mode updates
+- Late join mechanism 
+- Sync Axis lock replication
+- Sync collection offset
+- Sync camera  orthographic scale
+- Sync custom fonts
+- Sync sound files
+- Logging configuration (file output and level)
+- Object visibility type replication
+- Optionnal sync for active camera
+- Curve->Mesh conversion
+- Mesh->gpencil conversion
+
+### Changed
+
+- Auto updater now handle installation from branches
+- Use uuid for collection loading
+- Moved session instance to replication package
+
+### Fixed
+
+- Prevent unsupported data types to crash the session
+- Modifier vertex group assignation
+- World sync
+- Snapshot UUID error
+- The world is not synchronized
+
+## [0.1.1] - 2020-10-16
+
+### Added
+
+- Session status widget
+- Affect dependencies during change owner
+- Dedicated server managment scripts(@brybalicious)
+
+### Changed
+
+- Refactored presence.py
+- Reset button UI icon 
+- Documentation `How to contribute` improvements (@brybalicious)
+- Documentation `Hosting guide` improvements (@brybalicious)
+- Show flags are now available from the viewport overlay
+ 
+### Fixed
+
+- Render sync race condition (causing scene errors)
+- Binary differentials
+- Hybrid session crashes between Linux/Windows
+- Materials node default output value
+- Right selection
+- Client node rights changed to COMMON after disconnecting from the server 
+- Collection instances selection draw
+- Packed image save error
+- Material replication
+- UI spelling errors (@brybalicious)
+
+
+## [0.2.0] - 2020-12-17
+
+### Added
+
+- Documentation `Troubleshouting` section (@brybalicious)
+- Documentation `Update` section (@brybalicious)
+- Documentation `Cloud Hosting Walkthrough` (@brybalicious)
+- Support DNS name
+- Sync annotations
+- Sync volume objects
+- Sync material node_goups 
+- Sync VSE
+- Sync grease pencil modifiers
+- Sync textures (modifier only)
+- Session status widget
+- Disconnection popup 
+- Popup with disconnection reason 
+
+
+### Changed
+
+- Improved GPencil performances
+
+### Fixed
+
+- Texture paint update
+- Various documentation fixes section (@brybalicious)
+- Empty and Light object selection highlights
+- Material renaming
+- Default material nodes input parameters
+- blender 2.91 python api compatibility
+
+## [0.3.0] - 2021-04-14
+
+### Added
+
+- Curve material support
+- Cycle visibility settings
+- Session save/load  operator 
+- Add new scene support
+- Physic initial support
+- Geometry node initial support
+- Blender 2.93 compatibility
+### Changed
+
+- Host documentation on Gitlab Page
+- Event driven update (from the blender deps graph)
+
+### Fixed
+
+- Vertex group assignation
+- Parent relation can't be removed
+- Separate object
+- Delete animation
+- Sync missing holdout option for grease pencil material
+- Sync missing `skin_vertices`  
+- Exception access violation during Undo/Redo
+- Sync missing armature bone Roll
+- Sync missing driver data_path
+- Constraint replication
+
+## [0.4.0] - 2021-07-20
+
+### Added
+
+- Connection preset system (@Kysios)
+- Display connected users active mode (users pannel and viewport) (@Kysios)
+- Delta-based replication
+- Sync timeline marker
+- Sync images settings (@Kysios)
+- Sync parent relation type (@Kysios)
+- Sync uv project modifier
+- Sync FCurves modifiers
+
+### Changed
+
+- User selection optimizations (draw and sync) (@Kysios)
+- Improved shapekey syncing performances
+- Improved gpencil syncing performances
+- Integrate replication as a submodule
+- The dependencies are now installed in a folder(blender addon folder) that no longer requires administrative rights
+- Presence overlay UI optimization (@Kysios)
+
+### Fixed
+
+- User selection bounding box glitches for non-mesh objects (@Kysios)
+- Transforms replication for animated objects
+- GPencil fill stroke
+- Sculpt and GPencil brushes deleted when joining a session (@Kysios)
+- Auto-updater doesn't work for master and develop builds
+
+## [0.5.0] - 2022-02-10
+
+### Added
+
+- New overall UI and UX (@Kysios)
+- Documentation overall update (@Kysios)
+- Server presets (@Kysios)
+- Server online status (@Kysios)
+- Draw connected user color in the user list
+- Private session (access protected with a password) (@Kysios)
+
+### Changed
+
+- Dependencies are now installed in the addon folder and correctly cleaned during the addon removal process
+
+### Fixed
+
+- Python 3.10 compatibility (@notfood)
+- Blender 3.x compatibility
+- Skin vertex radius synchronization (@kromar)
+- Sequencer audio strip synchronization
+- Crash with empty after a reconnection
+
+## [0.5.1] - 2022-02-10
+
+### Fixed
+
+- Auto updater breaks dependency auto installer
+- Auto updater update from tag
+
+## [0.5.2] - 2022-02-18
+
+### Fixed
+
+- Objects not selectable after user leaves session
+- Geometry nodes attribute toogle doesn't sync
+
+## [0.5.3] - 2022-03-11
+
+### Changed
+
+- Snapshots logs
+### Fixed
+
+- Server crashing during snapshots
+- Blender 3.1 numpy loading error during early connection process
+- Server docker arguments
+
+## [0.5.5] - 2022-06-12
+
+### Fixed
+
+- Numpy mesh serialization error

README.md

@@ -2,7 +2,7 @@
 
 > Enable real-time collaborative workflow inside blender  
 
-![demo](https://i.imgur.com/X0B7O1Q.gif)
+<img src="https://i.imgur.com/X0B7O1Q.gif" width=600>
 
 
 :warning: Under development, use it at your own risks. Currently tested on Windows platform. :warning:
@@ -11,36 +11,54 @@ This tool aims to allow multiple users to work on the same scene over the networ
 
 ## Quick installation
 
-1. Download latest release [multi_user.zip](/uploads/8aef79c7cf5b1d9606dc58307fd9ad8b/multi_user.zip).
-2. Run blender as administrator (dependencies installation).
-3. Install last_version.zip from your addon preferences.
+1. Download [latest build](https://gitlab.com/slumber/multi-user/-/jobs/artifacts/develop/download?job=build) or [stable build](https://gitlab.com/slumber/multi-user/-/jobs/artifacts/master/download?job=build).
+2. Install last_version.zip from your addon preferences.
 
 [Dependencies](#dependencies) will be automatically added to your blender python during installation.
 
 ## Usage
 
-See the [documentation](https://multi-user.readthedocs.io/en/latest/) for details.
+See the [documentation](https://slumber.gitlab.io/multi-user/index.html) for details.
+
+## Troubleshooting
+
+See the [troubleshooting guide](https://slumber.gitlab.io/multi-user/getting_started/troubleshooting.html) for tips on the most common issues.
 
 ## Current development status
 
 Currently, not all data-block are supported for replication over the wire. The following list summarizes the status for each ones.
 
-| Name        |       Status       |    Comment     |
-| ----------- | :----------------: | :------------: |
-| action      |   :exclamation:    |   Not stable   |
-| armature    |   :exclamation:    |   Not stable   |
-| camera      | :white_check_mark: |                |
-| collection  | :white_check_mark: |                |
-| curve       | :white_check_mark: |   Not tested   |
-| gpencil     | :white_check_mark: |                |
-| image       |   :exclamation:    | Not stable yet |
-| mesh        | :white_check_mark: |                |
-| material    | :white_check_mark: |                |
-| metaball    | :white_check_mark: |                |
-| object      | :white_check_mark: |                |
-| scene       | :white_check_mark: |                |
-| world       | :white_check_mark: |                |
-| lightprobes | :white_check_mark: |                |
+| Name           | Status |                                 Comment                                 |
+| -------------- | :----: | :---------------------------------------------------------------------: |
+| action         |   ✔️    |                                                                         |
+| camera         |   ✔️    |                                                                         |
+| collection     |   ✔️    |                                                                         |
+| gpencil        |   ✔️    |                                                                         |
+| image          |   ✔️    |                                                                         |
+| mesh           |   ✔️    |                                                                         |
+| material       |   ✔️    |                                                                         |
+| node_groups    |   ✔️    |                        Material & Geometry only                         |
+| geometry nodes |   ✔️    |                                                                         |
+| metaball       |   ✔️    |                                                                         |
+| object         |   ✔️    |                                                                         |
+| texts          |   ✔️    |                                                                         |
+| scene          |   ✔️    |                                                                         |
+| world          |   ✔️    |                                                                         |
+| volumes        |   ✔️    |                                                                         |
+| lightprobes    |   ✔️    |                                                                         |
+| physics        |   ✔️    |                                                                         |
+| textures       |   ✔️    |                                                                         |
+| curve          |   ❗    |                      Nurbs surfaces not supported                       |
+| armature       |   ❗    |          Only for Mesh. [Planned for GPencil](https://gitlab.com/slumber/multi-user/-/issues/161). Not stable yet           |
+| particles      |   ❗    |                        The cache isn't syncing.                         |
+| speakers       |   ❗    |      [Partial](https://gitlab.com/slumber/multi-user/-/issues/65)       |
+| vse            |   ❗    |                     Mask and Clip not supported yet                     |
+| libraries      |   ❌    |                                                                         |
+| nla            |   ❌    |                                                                         |
+| texts          |   ❌    | [Planned for v0.5.0](https://gitlab.com/slumber/multi-user/-/issues/81) |
+| compositing    |   ❌    | [Planned for v0.5.0](https://gitlab.com/slumber/multi-user/-/issues/46) |
+
+
 
 ### Performance issues
 
@@ -51,18 +69,17 @@ I'm working on it.
 
 | Dependencies | Version | Needed |
 | ------------ | :-----: | -----: |
-| ZeroMQ       | latest  |    yes |
-| msgpack      | latest  |    yes |
-| PyYAML       | latest  |    yes |
-| JsonDiff     | latest  |    yes |
+| Replication  | latest  |    yes |
+
 
 
 ## Contributing
 
-See [contributing section](https://multi-user.readthedocs.io/en/latest/ways_to_contribute.html) of the documentation.
+See [contributing section](https://slumber.gitlab.io/multi-user/ways_to_contribute.html) of the documentation.
+
+Feel free to [join the discord server](https://discord.gg/aBPvGws) to chat, seek help and contribute.
 
 ## Licensing
 
 See [license](LICENSE)
 
-[![Documentation Status](https://readthedocs.org/projects/multi-user/badge/?version=latest)](https://multi-user.readthedocs.io/en/latest/?badge=latest)

docs/about/community.rst

@@ -0,0 +1,17 @@
+=========
+Community
+=========
+
+Discord
+=======
+
+Feel free to join our `discord server <https://discord.gg/aBPvGws>`_ ! 
+
+You will find help, a way to take part in the project, public collaborative sessions, people to create with, information about the addon's progress and much more.
+
+.. TODO: Make a call on discord get a link / image for evry contributor ?
+
+Contributors
+============
+
+Swann, Fabian, NotFood, Poochyc, Valentin, Adrien, Tanguy, Bruno, Gorgio, Axel, Ultr-X, Wuaieyo, Softyoda, Staz, Ikxi, Kysios.

docs/about/features.rst

@@ -0,0 +1,32 @@
+============
+Key Features
+============
+
+Multi-User is a free and open source blender addon. 
+It aims to allow multiple users to work on the same scene over the network. Based on a Clients / Server architecture, the data-oriented replication schema replicate blender data-blocks across the wire.
+
+.. warning::
+    The addon is still in development Be carefull when using it. 
+
+    On rare occasions, it can happen that your blender scenes become corrupted, think of making backups to avoid losing your projects. 
+
+Collaboration
+=============
+
+Multi-User allows a strong collaborative workflow between users. Being able to collaborate in this way has opened up new opportunities:
+
+
+- Being able to create together and in real time on the same 3D scene, with instant feedback.
+- Being able to teach directly in the same 3D environment in real time, facilitating communication between the teacher and these students.
+- To be able to experiment with several people, to make challenges or simply to have fun.
+- And much more !
+
+Easier communication
+====================
+
+Thanks to *presence*, the overlay system that Multi-User provides, it is possible to see other users in the 3D space. The *presence* overlay is customizable to match your preferences (visibility, names, options).
+
+Session management
+==================
+
+The addon works on a session system. The creator of the session and the administrators have rights that allow them to easily manage the session (backups, user management). In addition, there is a management of datablock rights so that each user can collaborate as they wish.

docs/about/index.rst

@@ -1,8 +1,10 @@
-About
-=====
+================
+About Multi-User
+================
 
 .. toctree::
-   :maxdepth: 1
-   :name: toc-about
+   :maxdepth: 2
 
    introduction
+   features
+   community

docs/about/introduction.rst

@@ -1,10 +1,14 @@
-============
-Introduction
-============
-
+========
+The idea
+========
 
 A film is an idea carved along the whole production process by many different peoples. A traditional animation pipeline involve a linear succession of tasks. From storyboard to compositing by passing upon different step, its fundamental work flow is similar to an industrial assembly line. Since each step is almost a department, its common that one person on department B doesn't know what another person did on a previous step in a department A. This lack of visibility/communication could be a source of problems which could produce a bad impact on the final production result.
 
+.. figure:: img/about_chain.gif
+    :align: center
+
+    The linear workflow problems
+
 Nowadays it's a known fact that real-time rendering technologies allows to speedup traditional linear production by reducing drastically the iteration time across different steps. All majors industrial CG solutions are moving toward real-time horizons to bring innovative interactive workflows. But this is a microscopic, per-task/solution vision of real-time rendering benefits for the animation production. What if we step-back, get a macroscopic picture of an animation movie pipeline and ask ourself how real-time could change our global workflow ? Could-it bring better ways of working together by giving more visibility between departments during the whole production ?
 
-The multi-user addon is an attempt to experiment real-time parallelism between different production stage. By replicating blender data blocks over the networks, it allows different artists to collaborate on a same scene in real-time.
+The multi-user addon is an attempt to experiment real-time parallelism between different production stage. By replicating blender data blocks over the networks, it allows different artists to collaborate on a same scene in real-time.

docs/conf.py

@@ -12,17 +12,16 @@
 #
 import os
 import sys
-# sys.path.insert(0, os.path.abspath('.'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'multi-user'
+project = 'Multi-User 0.5.x Documentation'
 copyright = '2020, Swann Martinez'
-author = 'Swann Martinez'
+author = 'Swann Martinez, Poochy, Fabian'
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.1'
+version_release = '0.5.5'
 
 
 # -- General configuration ---------------------------------------------------
@@ -42,12 +41,15 @@ source_suffix = ".rst"
 # The master toctree document.
 master_doc = "index"
 
+# General information about the projet
+projet = 'Multi-User %s Doc' % version_release
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#
+
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'python'
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -60,28 +62,59 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
-import sphinx_rtd_theme
-html_theme = 'sphinx_rtd_theme'
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_theme = "default"
+
+try:
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    del sphinx_rtd_theme
+except ModuleNotFoundError:
+    pass
+
 if on_rtd:
     using_rtd_theme = True
 
-# Theme options
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
 html_theme_options = {
-    # 'typekit_id': 'hiw1hhg',
-    # 'analytics_id': '',
-    # 'sticky_navigation': True  # Set to False to disable the sticky nav while scrolling.
-    # 'logo_only': True,  # if we have a html_logo below, this shows /only/ the logo with no title text
     'collapse_navigation': False,  # Collapse navigation (False makes it tree-like)
-    # 'display_version': True,  # Display the docs version
-    # 'navigation_depth': 4,  # Depth of the headers shown in the navigation bar
 }
 
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = []
+
+if html_theme == "sphinx_rtd_theme":
+    html_theme_options = {
+        "analytics_id": "UA-1418081-1",
+        # included in the title
+        "display_version": False,
+        "collapse_navigation": True,
+        "navigation_depth": -1,
+    }
+
+    extensions.append('sphinx_rtd_theme')
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+html_title = "Multi-User Doc"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_logo = "resources/logo.png"
+html_favicon = "ressources/favicon.ico"
+html_static_path = ["resources"]
+
+
+if html_theme == "sphinx_rtd_theme":
+    html_css_files = ["css/theme_overrides.css"]
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'multiusrdoc'
+htmlhelp_basename = 'Multi-User Manual'
 
 # sphinx-notfound-page
 # https://github.com/readthedocs/sphinx-notfound-page

docs/general_settings/index.rst

@@ -0,0 +1,117 @@
+################
+General Settings
+################
+
+This section contains optional settings to configure before a session.
+
+.. figure:: img/sidepannel_general_settings.png
+   :align: center
+   
+   General Settings pannel
+
+---------
+User info
+---------
+
+.. figure:: img/sidepannel_userinfo.png
+   :align: center
+
+   User Info settings
+
+The **User Info** pannel is here to change your user name and use color.
+
+-------
+Network
+-------
+
+.. figure:: img/sidepannel_network.png
+   :align: center
+
+   Network settings
+
+**Timeout (in milliseconds)** is the maximum ping authorized before auto-disconnecting.
+You should only increase it if you have a bad connection.
+
+-----
+Cache
+-----
+
+.. figure:: img/sidepannel_cache.png
+   :align: center
+
+   Cache settings
+
+
+Multi-user allows you to replicate external dependencies such as images (textures, hdris, etc...), movies, and sounds. 
+On each client, the files will be stored in the multi-user cache folder.
+
+
+
+**Cache directory** choose where cached files (images, sound, movies) will be saved.
+
+**Clear memory filecache** will save memory space at runtime by removing the file content from memory as soon as it has been written to the disk.
+
+**Clear cache** will remove all files from the cache folder. 
+
+.. warning:: Clearing the cache could break your scene images/movies/sounds if they are used in a blend file! Try saving the blend file and choosing 'Pack all into blend' before clearing the cache.
+
+-------
+Logging
+-------
+
+.. figure:: img/sidepannel_logging.png
+   :align: center
+
+   Advanced log settings
+
+**log level** allows you to set the level of detail captured in multi-user's logging output. Here is a brief description on the level of detail for each value of the logging parameter:
+
++-----------+-----------------------------------------------+
+| Log level |                  Description                  |
++===========+===============================================+
+| ERROR     | Shows only critical errors                    |
++-----------+-----------------------------------------------+
+| WARNING   | Shows only errors (of all kinds)              |
++-----------+-----------------------------------------------+
+| INFO      | Shows only status-related messages and errors |
++-----------+-----------------------------------------------+
+| DEBUG     | Shows all possible information                |
++-----------+-----------------------------------------------+
+
+
+-----------------
+Save session data 
+-----------------
+
+.. danger::
+   This is an experimental feature, it is still recommended to use regular .blend save.
+
+The save session data allows you to create a backup of the session data.
+
+When you hit the **save session data** button, the following popup dialog will appear.
+It allows you to choose the destination folder and if you want to run an auto-save.
+
+.. figure:: img/quickstart_save_session_data_dialog.png
+   :align: center
+
+   Save session data dialog.
+
+If you enabled the auto-save option, you can cancel it from the **Cancel auto-save** button.
+
+.. figure:: img/quickstart_save_session_data_cancel.png
+   :align: center
+
+   Cancel session autosave.
+
+
+To import session data backups, use the following **Multiuser session snapshot** import dialog
+
+.. figure:: img/quickstart_import_session_data.png
+   :align: center
+
+   Import session data dialog.
+
+.. note::
+   It is not yet possible to start a session directly from a backup.
+
+.. _advanced:

docs/getting_started/how-to-host.rst

@@ -0,0 +1,54 @@
+.. _how-to-host:
+
+
+How to host a session
+=====================
+------------
+Local server
+------------
+
+The multi-user add-on relies on a Client-Server architecture. 
+The server is the heart of the collaborative session.
+It is what allows user's blender instances to communicate with each other.  
+In simple terms, *Hosting a session* means *run a local server and connect the local client to it*. 
+When we say **local server** we mean a server which is accessible from the LAN (Local Area Network) without requiring an internet connection. 
+
+.. _local-setup:
+
+When the hosting process starts, the multi-user addon will launch a local server instance.
+In the **Hosting** panel configure your server according to:
+
+.. figure:: img/first_time_server_host.png
+   :align: center
+
+   Hosting panel
+
+* **Init the session from**: the session initialisation method.
+  
+  * **current scenes**: start with the data loaded in the current blend file.
+  * **an empty scene**: clear the blend file's data and start over.
+  
+* **Port**: port on which the server is listening.
+* **Server password**: (*optional*) the server password.
+* **Admin password**: (*optional*) the session administration password.
+
+Once everything is set up, you can hit the **Host** button to launch the session!
+
+This will do two things:
+
+* Start a local server 
+* Connect you to it as an :ref:`admin`
+
+.. danger::
+   By starting from an empty scene, all of the blend data will be removed!
+   Be sure to save your existing work before launching the session.
+
+-------------
+Online server
+-------------
+
+However, there are times when you will need to host a session over the internet.
+In this case, we strongly recommend that you read the :ref:`hosting_on_internet` tutorial.
+
+During an online session, various actions are available to you, go to :ref:`how-to-manage` section to 
+learn more about them.

docs/getting_started/how-to-join.rst

@@ -0,0 +1,104 @@
+.. _how-to-join:
+
+How to join a session
+=====================
+
+This section describes how to join a launched session. 
+Before starting make sure that you have access to the session **IP address**, **port number** and that you have filled in your **user information** (name and color).
+
+-----------
+Server List
+-----------
+
+The server list allows you to manage your servers:
+
+.. figure:: img/quickstart_serverlist.png
+    :align: center
+    :width: 200px
+
+    Server List
+
+To connect to a server, select the one you want to join in the list and click on **Connect**.
+
+To know if the server you want to join is online, you can refresh your server list with the button on the top right corner. 
+Online status:
+
+- **Red**: server is offline
+- **Green**: server is online
+
+.. note:: 
+
+   If a server is secured with a password, a lock will be displayed next to the server name. You first need to enter the password of the server in its preset to join it.
+
+   .. figure:: img/quickstart_serverlist_private.png
+    :align: center
+    :width: 200px
+
+It is possible to **add**, **delete** and even **modify** a **server preset** with the buttons located on the top right of the server list:
+
+.. figure:: img/quickstart_serverlist_manage_buttons.png
+    :align: center
+    :width: 200px
+
+    Add, Remove, Edit Server Preset
+
+.. note:: 
+
+   Two server presets are already present when the addon is launched:
+
+   - The 'localhost' preset, to join a local session quickly
+   - The 'public session' preset, to join the public sessions of the multi-user server (official discord to participate : https://discord.gg/aBPvGws)
+
+-------------------
+Add a Server Preset
+-------------------
+
+To add a server, you must first register it in the server list. Click on the **+** icon and fill in the window with the server settings: 
+
+.. figure:: img/quickstart_server_edit.png
+    :align: center
+    :width: 350px
+
+    Server Preset pop-up
+
+- **Server name**: the name of the server.
+- **IP**: the host's IP address.
+- **Port**: the host's port number.
+- **Server password**: (*optional*) the server password.
+- **Admin password**: (*optional*) the session administration password.
+
+Once you've configured every field, you can save the server preset by clicking **OK**.
+You can now select it in the server list to join the session !
+
+.. warning:: Be careful, if you don't rename your new preset, or if it has the same name as an existing preset, the old preset will be overwritten.
+
+----------------
+Joining a server
+----------------
+
+CONNECT
+-------
+
+When joining a server that have already be initialise, the session status screen will be **CONNECT**.
+You are now connected and can start creating.
+
+.. figure:: img/quickstart_connect.png
+   :align: center
+
+   In session
+
+During an online session, various actions are available to you. Go to :ref:`how-to-manage` to 
+learn more about them.
+
+LOBBY
+-----
+
+When starting a **dedicated server**, the session status screen will take you to the **LOBBY** (see side-panel header).
+
+If the session status is set to **LOBBY** and you are a regular user, you need to wait for the admin to launch the scene (admins have shield next to their names).
+If you are the admin, you just need to initialise the session to start it (see image below).
+
+.. figure:: img/quickstart_lobby.png
+   :align: center
+
+   Session initialisation for dedicated server

docs/getting_started/how-to-manage.rst

@@ -0,0 +1,135 @@
+.. _how-to-manage:
+
+How to manage a session
+=======================
+
+The quality of a collaborative session directly depends on the quality of the network connection, and the communication between the users. This section describes
+various tools which have been made in an effort to ease the communication between your fellow creators.
+Feel free to suggest any ideas for communication tools `here <https://gitlab.com/slumber/multi-user/-/issues/75>`_ .
+
+--------------------
+Monitor online users
+--------------------
+
+One of the most vital tools is the **Online user panel**. It lists all connected
+users' information including your own:
+
+* **Role** : admin/regular user.
+* **Username** : name of the user.
+* **Mode** : user's active mode (object, sculpt, paint,etc.).
+* **Frame**: on which frame the user is working.
+* **Location**: where the user is actually working.
+* **Ping**: user's connection delay in milliseconds.
+
+.. figure:: img/quickstart_users.png
+   :align: center
+
+   Online user panel
+
+By selecting a user in the list you'll have access to different users' related **actions**.
+Those operators allow you to experience the selected user's state in two different dimensions: **SPACE** and **TIME**.
+
+Snapping in space
+-----------------
+
+The **CAMERA button** (Also called **snap view** operator) allow you to snap to 
+the user's viewpoint. To disable the snap, click on the button once again. This action 
+serves different purposes such as easing the review process, and working together on a large or populated world.
+
+.. hint::
+   If the target user is located in another scene, the **snap view** operator will send you to their scene. 
+
+.. figure:: img/quickstart_snap_camera.gif
+   :align: center
+
+   Snap view in action
+
+Snapping in time
+----------------
+
+The **CLOCK button** (Also called **snap time** operator) allows you to snap to 
+the user's time (current frame). To disable the snap, click on the button once again. 
+This action helps various multiple creators to work in the same time-frame 
+(for instance multiple animators).
+
+.. figure:: img/quickstart_snap_time.gif
+   :align: center
+
+   Snap time in action
+
+
+Kick a user
+-----------
+
+.. warning:: Only available for :ref:`admin` !
+
+
+The **CROSS button** (Also called **kick** operator) allows the administrator to kick the selected user. This can be helpful if a user is acting unruly, but more importantly, if they are experiencing a high ping which is slowing down the scene. Meanwhile, in the target user's world, the session will properly disconnect.
+
+---------------------------
+Change replication behavior
+---------------------------
+
+During a session, multi-user will replicate all of your local modifications to the scene, to all other users' blender instances.
+In order to avoid annoying other users when you are experimenting, you can flag some of your local modifications to be ignored via 
+various flags present at the top of the panel (see red area in the image below). Those flags are explained in the :ref:`replication` section.
+
+.. figure:: img/quickstart_synchronize.png
+      :align: center
+
+      Session replication flags
+
+-----------
+Manage data
+-----------
+
+In order to understand replication data managment, a quick introduction to the multi-user data workflow is in order.
+The first thing to know: until now, the addon relies on data-based replication. In simple words, it means that it replicates
+the resultant output of a user's actions. 
+To replicate datablocks between clients, multi-user relies on a standard distributed architecture:
+
+- The server stores the "master" version of the work.
+- Each client has a local version of the work.
+
+When an artist modifies something in the scene, here is what is happening in the background:
+
+1. Modified data are **COMMITTED** to the local repository.
+2. Once committed locally, they are **PUSHED** to the server
+3. As soon as the server receives updates, they are stored locally and pushed to every other client
+
+At the top of this data management system, a rights management system prevents 
+multiple users from modifying the same data at the same time. A datablock may belong to
+a connected user or be under :ref:`common-right<**COMMON**>` rights. 
+
+.. note::
+   In a near future, the rights management system will support roles to allow multiple users to 
+   work on different aspects of the same datablock.
+
+The Repository panel (see image below) allows you to monitor, change datablock states and rights manually.
+
+.. figure:: img/quickstart_repository.png
+   :align: center
+
+   Repository panel
+
+The **show only owned** flag allows you to see which datablocks you are currently modifying.
+
+.. warning::
+   If you are editing a datablock not listed with this flag enabled, it means that you have not been granted the rights to modify it. 
+   So, it won't be updated to other clients! 
+
+Here is a quick list of available actions: 
+
++---------------------------------------+-------------------+------------------------------------------------------------------------------------+
+| icon                                  | Action            | Description                                                                        |
++=======================================+===================+====================================================================================+
+| .. image:: img/quickstart_push.png    |  **Push**         | push data-block to other clients                                                   |
++---------------------------------------+-------------------+------------------------------------------------------------------------------------+
+| .. image:: img/quickstart_pull.png    | **Pull**          | pull last version into blender                                                     |
++---------------------------------------+-------------------+------------------------------------------------------------------------------------+
+| .. image:: img/quickstart_refresh.png | **Reset**         | Reset local change to the server version                                           |
++---------------------------------------+-------------------+------------------------------------------------------------------------------------+
+| .. image:: img/quickstart_unlock.png  | **Lock/Unlock**   | If locked, does nothing. If unlocked, grant modification rights to another user.   |
++---------------------------------------+-------------------+------------------------------------------------------------------------------------+
+| .. image:: img/quickstart_remove.png  |  **Delete**       | Remove the data-block from network replication                                     |
++---------------------------------------+-------------------+------------------------------------------------------------------------------------+

docs/getting_started/index.rst

@@ -1,9 +1,15 @@
+===============
 Getting started
 ===============
 
 .. toctree::
-   :maxdepth: 1
-   :name: toc-getting-started
+   :maxdepth: 2
 
    install
+   update
    quickstart
+   how-to-join
+   how-to-host
+   how-to-manage
+   troubleshooting
+

docs/getting_started/install.rst

@@ -1,9 +1,39 @@
-============
-Installation
-============
+=====================
+Installing Multi-User
+=====================
 
-*The process is the same for linux, mac and windows.*
+.. warning::  Under development, use it at your own risks.
 
-1. Download latest release `multi_user.zip <https://gitlab.com/slumber/multi-user/uploads/8aef79c7cf5b1d9606dc58307fd9ad8b/multi_user.zip>`_.
+Multi-User is often updated. You can keep up to date with the latest changes through the release notes on our `Discord Server <https://discord.com/invite/aBPvGws>`_.
+
+Download
+========
+
+`Stable Release <https://gitlab.com/slumber/multi-user/-/jobs/artifacts/master/download?job=build>`__
+    **Recommended**. A package packed with the latest features and is considered stable without regressions.
+
+`Latest Release <https://gitlab.com/slumber/multi-user/-/jobs/artifacts/develop/download?job=build>`__
+    **Experimental**. A package updated almost daily to include the newest changes in development.
+    These versions are not as thoroughly tested as the stable release, and might break.
+
+Install
+=======
+
+.. hint::
+    The process is the same for linux, mac and windows.
+
+1. Download the addon zip file
 2. Run blender as administrator (to allow python dependencies auto-installation).
-3. Install last_version.zip from your addon preferences.
+3. Install **multi-user.zip** from your addon preferences in :menuselection:`Edit --> Preferences --> Add-ons --> Install`.
+
+.. figure:: img/settings.png
+    :align: center
+    :width: 500px
+
+    The Addon Preferences Pannel
+
+Once the addon is succesfully installed, we strongly recommend you to follow the :ref:`quickstart`
+tutorial.
+
+.. toctree::
+    :maxdepth: 1

docs/getting_started/quickstart.rst

@@ -1,111 +1,48 @@
-===========
-Quick start
+.. _quickstart:
+
+Quick Start
 ===========
 
-*All settings are located under: `View3D -> Sidebar -> Multiuser panel`*
+Welcome to the Multi-User manual.
+You will find here all the documentation necessary for the good use of the addon: :ref:`index-manual`
 
-Session setup
-=============
-This section describe how to create or join a collaborative session.
+First of all, let's have a quick look at the Multi-User features.
 
----------------------
-1. User information's
----------------------
+Username and color
+------------------
 
-.. image:: img/quickstart_user_infos.png
+When you launch the addon for the first time you can find this panel in the Sidebar of your View3D:
 
-- **name**: username.
-- **color**: color used to represent the user into other user workspace.
+.. figure:: img/first_time_menu.png
+   :align: center
 
-----------
-2. Network
-----------
-
-.. note:: If you host a session over internet, special network configuration is needed. 
-
-Hosting and connection are done from this panel.
- 
-+-----------------------------------+-------------------------------------+
-| Host                              | Join                                |
-+===================================+=====================================+
-|.. image:: img/quickstart_host.png | .. image:: img/quickstart_join.png  |
-+-----------------------------------+-------------------------------------+
-| | Start empty: Cleanup the file   | | IP: server ip                     |
-| | before hosting                  | | Port: server port                 |
-+-----------------------------------+-------------------------------------+
-|  **HOST**: Host a session         | **CONNECT**: Join a session         |
-+-----------------------------------+-------------------------------------+
-
-**Port configuration:**
-For now, a session use 4 ports to run.
-If 5555 is given in host settings, it will use 5555, 5556 (5555+1), 5557 (5555+2), 5558 (5555+3). 
-
-------------
-2.1 Advanced
-------------
-
-.. image:: img/quickstart_advanced.png
-
-**Right strategy** (only host) enable you to choose between a strict and a relaxed pattern:
-
-- **Strict**: Host is the king, by default the host own each properties, only him can grant modification rights.
-- **Common**: Each properties are under common rights by default, on selection, a property is only modifiable by the owner.
-  
-On each strategy, when a user is the owner he can choose to pass his rights to someone else.
-
-**Properties frequency gird** allow to set a custom replication frequency for each type of data-block:
-
-- **Refresh**: pushed data update rate (in second)
-- **Apply**: pulled data update rate (in second)
-
-.. note:: Per-data type settings will soon be revamped for simplification purposes
-
-Session Management
-==================
-
-This section describe tools available during a collaborative session.
-
----------------
-Connected users
----------------
-
-.. image:: img/quickstart_users.png
-
-This panel displays all connected users information's, including yours. 
-By selecting a user in the list you'll have access to different **actions**:
-
-- The **camera button** allow you to snap on the user viewpoint.
-- The **time button** allow you to snap on the user time.
-
----------------------
-Replicated properties
----------------------
-
-.. image:: img/quickstart_properties.png
-
-The **replicated properties** panel shows all replicated properties status and associated actions.
-Since the replication architecture is based on commit/push/pull mechanisms, a replicated properties can be pushed/pull or even committed manually from this panel.
-
-+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
-| icon                                  | Action            | Description                                                                        |
-+=======================================+===================+====================================================================================+
-| .. image:: img/quickstart_push.png    |  **Push**         | push data-block to other clients                                                   |
-+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
-| .. image:: img/quickstart_pull.png    | **Pull**          | pull last version into blender                                                     |
-+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
-| .. image:: img/quickstart_refresh.png | **Reset**         | Reset local change to the server version                                           |
-+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
-| .. image:: img/quickstart_unlock.png  | **Lock/Unlock**   | If locked, does nothing. If unlocked, grant modification rights to another user.   |
-+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
-| .. image:: img/quickstart_remove.png  |  **Delete**       | Remove the data-block from network replication                                     |
-+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
+1. Choose a **name** and a **color** that will be specific to you and that will allow others to identify you easily once in session. Don't worry, they can be changed at any time in  :menuselection:`Edit --> Prerecences --> Add-ons --> Multi-user` or in  :menuselection:`Multi-User Pannel --> General Settings`.
+2. Press **Continue**
 
+Multi-User side pannel
+----------------------
 
+Once the Multi-User is launched you will arrive directly on the main menu:
 
+.. figure:: img/first_time_server_list.png
+   :align: center
 
+Three panels are at your disposal:
 
+- **Server list**: You can add, delete and edit server presets according to your preferences. At first launch two servers will already be in your preferences: *Public Session*, the public server of the Multi-User Discord, *Localhost*, to connect locally to your server.
+- **Hosting**: To locally host a session with a Blender instance.
+- **General Settings**: Include advanced addon settings like *user info*, *server ping*, *cache*, etc.
 
+Session management
+------------------
 
+The multi-user addon provides a session management system.
+In this guide, you will quickly learn how to use the collaborative session management system in three parts:
 
+- :ref:`how-to-join`
+- :ref:`how-to-host`
+- :ref:`how-to-manage`
 
+For more details on what the addon offers:
 
+.. - :ref:

docs/getting_started/update.rst

@@ -0,0 +1,57 @@
+================
+Update the Addon
+================
+
+Multi-User has a built-in auto-update function in its preferences.
+
+Auto-Update
+-----------
+
+1. Enable it by clicking 'Auto-check for Update' and choose the frequency you'd like.
+2. **Make sure to click the three bars in the bottom-left, and save this to your preferences**
+
+.. figure:: img/auto_updater_location.png
+    :align: center
+    :width: 500px
+
+    Update menu in the addon preferences pannel
+
+Manual Update
+-------------
+
+Sometimes you'd like to perform manual update, or even side-grade or rollback your multi-user version. Perhaps you are trying out new features from the 'develop' branch in a test session.
+
+1. Click on 'Check now for multiuser update'. Multi-user will now find new versions
+
+.. figure:: img/auto_updater_check.png
+    :align: center
+    :width: 500px
+
+    Check for updates
+
+1. Select 'Install latest master / old version'
+
+.. figure:: img/auto_updater_last.png
+    :align: center
+    :width: 500px
+
+    Install
+
+1. In most cases, select 'master' branch for the latest stable release. The unstable 'develop' branch and older releases are available
+
+.. figure:: img/auto_updater_version.png
+    :align: center
+    :width: 500px
+
+    Select version
+
+4. Finally, restart blender to use the updated version
+
+.. figure:: img/auto_updater_restart.png
+    :align: center
+    :width: 500px
+
+    Restart blender
+
+.. toctree::
+    :maxdepth: 1