fix: bump version to 0.6.0

feat: initial support for blender 4.0

See merge request slumber/multi-user!181

.gitlab-ci.yml

@@ -1,13 +1,7 @@
 stages:
-  - test
   - build
-  - deploy
-  - doc
-
 
 
 include:
-  - local: .gitlab/ci/test.gitlab-ci.yml
   - local: .gitlab/ci/build.gitlab-ci.yml
-  - local: .gitlab/ci/deploy.gitlab-ci.yml
+
-  - local: .gitlab/ci/doc.gitlab-ci.yml

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

@@ -1,6 +1,5 @@
 build:
   stage: build
-  needs: ["test"]
   image: debian:stable-slim
   script:
     - rm -rf tests .git .gitignore script

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

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

CHANGELOG.md

@@ -186,4 +186,88 @@ All notable changes to this project will be documented in this file.
 - Exception access violation during Undo/Redo
 - Sync missing armature bone Roll
 - Sync missing driver data_path
-- Constraint replication
+- 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

@@ -11,9 +11,8 @@ 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.
 
@@ -29,35 +28,35 @@ See the [troubleshooting guide](https://slumber.gitlab.io/multi-user/getting_sta
 
 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         |   ✔️    |                                                                         |
-| camera         |   ✔️    |                                                              |
+| camera         |   ✔️    |                                                                         |
-| collection     |   ✔️    |                                                              |
+| collection     |   ✔️    |                                                                         |
-| gpencil        |   ✔️    |                                                              |
+| gpencil        |   ✔️    |                                                                         |
-| image          |   ✔️    |                                                              |
+| image          |   ✔️    |                                                                         |
-| mesh           |   ✔️    |                                                              |
+| mesh           |   ✔️    |                                                                         |
-| material       |   ✔️    |                                                              |
+| material       |   ✔️    |                                                                         |
-| node_groups    |   ✔️    |                   Material & Geometry only                   |
+| node_groups    |   ✔️    |                        Material & Geometry only                         |
-| geometry nodes |   ✔️    |                                                              |
+| geometry nodes |   ✔️    |                                                                         |
-| metaball       |   ✔️    |                                                              |
+| metaball       |   ✔️    |                                                                         |
-| object         |   ✔️    |                                                              |
+| object         |   ✔️    |                                                                         |
-| texts          |   ✔️    |                                                              |
+| texts          |   ✔️    |                                                                         |
-| scene          |   ✔️    |                                                              |
+| scene          |   ✔️    |                                                                         |
-| world          |   ✔️    |                                                              |
+| world          |   ✔️    |                                                                         |
-| volumes        |   ✔️    |                                                              |
+| volumes        |   ✔️    |                                                                         |
-| lightprobes    |   ✔️    |                                                              |
+| lightprobes    |   ✔️    |                                                                         |
-| physics        |   ✔️    |                                                              |
+| physics        |   ✔️    |                                                                         |
-| curve          |   ❗    |                 Nurbs surfaces not supported                 |
+| textures       |   ✔️    |                                                                         |
-| textures       |   ❗    |       Supported for modifiers/materials/geo nodes only       |
+| curve          |   ❗    |                      Nurbs surfaces not supported                       |
-| armature       |   ❗    |                          Not stable                          |
+| armature       |   ❗    |          Only for Mesh. [Planned for GPencil](https://gitlab.com/slumber/multi-user/-/issues/161). Not stable yet           |
-| particles      |   ❗    |                   The cache isn't syncing.                   |
+| particles      |   ❗    |                        The cache isn't syncing.                         |
-| 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      |   ❗    |                           Partial                            |
+| libraries      |   ❌    |                                                                         |
-| nla            |   ❌    |                                                              |
+| nla            |   ❌    |                                                                         |
-| texts          |   ❌    | [Planned](https://gitlab.com/slumber/multi-user/-/issues/81) |
+| texts          |   ❌    | [Planned for v0.5.0](https://gitlab.com/slumber/multi-user/-/issues/81) |
-| compositing    |   ❌    | [Planned](https://gitlab.com/slumber/multi-user/-/issues/46) |
+| compositing    |   ❌    | [Planned for v0.5.0](https://gitlab.com/slumber/multi-user/-/issues/46) |
 
 
 

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
+   :maxdepth: 2
-   :name: toc-about
 
    introduction
+   features
+   community

docs/about/introduction.rst

@@ -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,4 +11,4 @@ A film is an idea carved along the whole production process by many different pe
 
 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, 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

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: