Merge branch 'develop' into 'master'

fix: cross-platform serialization errors See merge request slumber/multi-user!177
fix: deepdiff dependency error, freezing it to 5.7.0.
2022-08-07 12:39:06 +00:00 · 2022-08-07 14:36:36 +02:00 · 2022-07-31 14:57:32 +02:00 · 2022-07-07 14:34:33 +02:00 · 2022-07-07 14:29:32 +02:00 · 2022-06-12 19:23:41 +00:00
198 changed files with 5181 additions and 2866 deletions
@@ -14,3 +14,4 @@ _build
 # ignore generated zip generated from blender_addon_tester
 *.zip
 libs
@@ -5,6 +5,7 @@ stages:
  - doc
 include:
  - local: .gitlab/ci/test.gitlab-ci.yml
  - local: .gitlab/ci/build.gitlab-ci.yml
@@ -1,5 +1,6 @@
 build:
  stage: build
  needs: ["test"]
  image: debian:stable-slim
  script:
    - rm -rf tests .git .gitignore script
@@ -7,8 +8,5 @@ build:
    name: multi_user
    paths: 
     - multi_user
-  only:
+  variables:
-    refs:
+    GIT_SUBMODULE_STRATEGY: recursive
      - master
@@ -1,9 +1,11 @@
 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
@@ -17,7 +19,3 @@ deploy:
    - 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
  only:
    refs:
      - master
@@ -1,11 +1,16 @@
 pages:
  stage: doc
-  image: python:3.7-alpine
+  needs: ["deploy"]
  image: python
  script:
-  - pip install -U sphinx sphinx_rtd_theme
+  - pip install -U sphinx sphinx_rtd_theme sphinx-material
  - sphinx-build -b html ./docs public
  artifacts:
    paths:
    - public
  only:
    refs:
    - master
    - develop
@@ -3,6 +3,5 @@ test:
  image: slumber/blender-addon-testing:latest
  script:
    - python3 scripts/test_addon.py
-  only:
+  variables:
-    refs:
+    GIT_SUBMODULE_STRATEGY: recursive
      - master
@@ -0,0 +1,3 @@
 [submodule "multi_user/libs/replication"]
 	path = multi_user/libs/replication
 	url = https://gitlab.com/slumber/replication.git
@@ -158,3 +158,116 @@ All notable changes to this project will be documented in this file.
 - 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
@@ -11,52 +11,53 @@ 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](https://gitlab.com/slumber/multi-user/-/jobs/artifacts/master/download?job=build).
+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. Run blender as administrator (dependencies installation).
+2. Install last_version.zip from your addon preferences.
 3. 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://multi-user.readthedocs.io/en/latest/getting_started/troubleshooting.html) for tips on the most common issues.
+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                                    |
+| Name           | Status |                                 Comment                                 |
-| ----------- | :----: | :--------------------------------------------------------------------------: |
+| -------------- | :----: | :---------------------------------------------------------------------: |
-| action      |   ✔️    |                                                                              |
+| action         |   ✔️    |                                                                         |
-| armature    |   ❗    |                                  Not stable                                  |
+| camera         |   ✔️    |                                                                         |
-| camera      |   ✔️    |                                                                              |
+| collection     |   ✔️    |                                                                         |
-| collection  |   ✔️    |                                                                              |
+| gpencil        |   ✔️    |                                                                         |
-| curve       |   ❗    |                             Nurbs not supported                              |
+| image          |   ✔️    |                                                                         |
-| gpencil     |   ✔️    | [Airbrush not supported](https://gitlab.com/slumber/multi-user/-/issues/123) |
+| mesh           |   ✔️    |                                                                         |
-| image       |   ✔️    |                                                                              |
+| material       |   ✔️    |                                                                         |
-| mesh        |   ✔️    |                                                                              |
+| node_groups    |   ✔️    |                        Material & Geometry only                         |
-| material    |   ✔️    |                                                                              |
+| geometry nodes |   ✔️    |                                                                         |
-| node_groups |   ❗    |                                Material only                                 |
+| metaball       |   ✔️    |                                                                         |
-| metaball    |   ✔️    |                                                                              |
+| object         |   ✔️    |                                                                         |
-| object      |   ✔️    |                                                                              |
+| texts          |   ✔️    |                                                                         |
-| textures    |   ❗    |                         Supported for modifiers only                         |
+| scene          |   ✔️    |                                                                         |
-| texts       |   ✔️    |                                                                              |
+| world          |   ✔️    |                                                                         |
-| scene       |   ✔️    |                                                                              |
+| volumes        |   ✔️    |                                                                         |
-| world       |   ✔️    |                                                                              |
+| lightprobes    |   ✔️    |                                                                         |
-| lightprobes |   ✔️    |                                                                              |
+| physics        |   ✔️    |                                                                         |
-| compositing |   ❌    |         [Planned](https://gitlab.com/slumber/multi-user/-/issues/46)         |
+| textures       |   ✔️    |                                                                         |
-| texts       |   ❌    |         [Planned](https://gitlab.com/slumber/multi-user/-/issues/81)         |
+| curve          |   ❗    |                      Nurbs surfaces not supported                       |
-| nla         |   ❌    |                                                                              |
+| armature       |   ❗    |          Only for Mesh. [Planned for GPencil](https://gitlab.com/slumber/multi-user/-/issues/161). Not stable yet           |
-| volumes     |   ✔️    |                                                                              |
+| particles      |   ❗    |                        The cache isn't syncing.                         |
-| particles   |   ❌    |        [On-going](https://gitlab.com/slumber/multi-user/-/issues/24)         |
+| speakers       |   ❗    |      [Partial](https://gitlab.com/slumber/multi-user/-/issues/65)       |
-| speakers    |   ❗    |         [Partial](https://gitlab.com/slumber/multi-user/-/issues/65)         |
+| vse            |   ❗    |                     Mask and Clip not supported yet                     |
-| vse         |   ❗    |                       Mask and Clip not supported yet                        |
+| libraries      |   ❌    |                                                                         |
-| physics     |   ❌    |         [Planned](https://gitlab.com/slumber/multi-user/-/issues/45)         |
+| nla            |   ❌    |                                                                         |
-| libraries   |   ❗    |                                   Partial                                    |
+| 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
@@ -74,7 +75,7 @@ I'm working on it.
 ## 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.
@@ -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.
@@ -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.
@@ -1,8 +1,10 @@
-About
+================
-=====
+About Multi-User
 ================
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
   :name: toc-about
   introduction
   features
   community
@@ -1,7 +1,6 @@
-============
+========
-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.
@@ -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, with contributions from Poochy'
+author = 'Swann Martinez, Poochy, Fabian'
 # The full version, including alpha/beta/rc tags
-release = '0.2.0'
+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 = "default"
-html_theme = 'sphinx_rtd_theme'
+
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+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
--- a/Show More
+++ b/Show More