fix: lobby init

fix: host solo
fix: session private by default
2021-08-16 15:59:19 +02:00 · 2021-08-16 12:02:10 +02:00 · 2021-07-30 14:09:40 +02:00 · 2021-07-30 13:47:31 +02:00 · 2021-07-30 13:17:29 +02:00 · 2021-07-30 13:16:43 +02:00
210 changed files with 16098 additions and 24799 deletions
@@ -6,4 +6,12 @@ __pycache__/
 .vscode
 cache
 config
-*.code-workspace
+*.code-workspace
+multi_user_updater/
+
+# sphinx build folder
+_build
+
+# ignore generated zip generated from blender_addon_tester
+*.zip
+libs
@@ -0,0 +1,13 @@
+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
@@ -0,0 +1,12 @@
+build:
+  stage: build
+  needs: ["test"]
+  image: debian:stable-slim
+  script:
+    - rm -rf tests .git .gitignore script
+  artifacts:
+    name: multi_user
+    paths: 
+     - multi_user
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive
@@ -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
@@ -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
+
+
@@ -0,0 +1,7 @@
+test:
+  stage: test
+  image: slumber/blender-addon-testing:latest
+  script:
+    - python3 scripts/test_addon.py
+  variables:
+    GIT_SUBMODULE_STRATEGY: recursive
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,3 +1,3 @@
-[submodule "libs/replication"]
-	path = libs/replication
-	url = git@gitlab.com:slumber/replication.git
+[submodule "multi_user/libs/replication"]
+	path = multi_user/libs/replication
+	url = https://gitlab.com/slumber/replication.git
@@ -1,26 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-## [v0.0.1]
-### Added
- Functionnal chat test 
-
-## [v0.0.2]
-### Added
- Property map shared between clients
- Callbacks to push modifications to the blender scene
- Observer Pattern for live property monitoring
- ID to identify properties owner (For primitive right managment) 
-
-### Removed
- Chat mecanism ( Will come back after the complete modularity refactoring)
- Unused files and sub-modules
-
-## [v0.0.5]
-### Added
-
- queued communication between threads
- various fixes
- multithreaded archiecture
- curve, gpencil support
- rightmanagment
@@ -1,108 +1,85 @@
-# Multi-user blender addon
+# MULTI-USER for blender

 > Enable real-time collaborative workflow inside blender  

+<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:

+This tool 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.

-This tool 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 datablocks across the wire.
+## Quick installation

-## Installation
+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.

-1. Download lastest release here.
-2. Install last_version.zip from your addon preferences
+[Dependencies](#dependencies) will be automatically added to your blender python during installation.

 ## Usage

-Settings are under: `View3D -> Sidebar -> Multiuser`
+See the [documentation](https://slumber.gitlab.io/multi-user/index.html) for details.

-### Before starting
+## Troubleshooting

-#### 1. User
+See the [troubleshooting guide](https://slumber.gitlab.io/multi-user/getting_started/troubleshooting.html) for tips on the most common issues.

-_All user-related infos fields._
+## Current development status

-![settings](medias/user.png)
+Currently, not all data-block are supported for replication over the wire. The following list summarizes the status for each ones.

- **name**: username.
- **color**: color used to represent the user into other user workspaces.
+| 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) |

-#### 2. Network

-_Session-related managment tools_
-
-:warning: If you host a session over internet, special network configuration is needed :warning:
- 
-| Host                                         | Join                           |
-| :------------------------------------------- | :----------------------------- |
-| asd                                          |
-| ![host_panel](medias/host.png)               | ![join_panel](medias/join.png) |
-| Start empty: Cleanup the file before hosting | IP: host ip                    |
-|                                              | Port: host port                |
-
-#### 2.1 Advanced
-
-![properties](medias/properties.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 somemone else._
-
-**Propertie frequency gird** allow to set a custom replication frequency for each type of datablock
-
-### In-session
-
-#### Connected users
-
-![users](medias/users.png)
-
-This pannel displays all connected users, including you. The **camera button** allow you to focus on a user.
-
-#### Properties outliner
-
-![properties](medias/properties_in_session.png)
-
-## Current development statut
-
-Actually, not all datablock are supported for replication over the wire. The following list summarizes the status for each ones.
-
-| Name       |       Statut       |  Comment   |
-| ---------- | :----------------: | :--------: |
-| action     |        :x:         |    WIP     |
-| armature   |        :x:         |    WIP     |
-| camera     | :white_check_mark: |            |
-| collection | :white_check_mark: |            |
-| curve      | :white_check_mark: | Not tested |
-| gpencil    | :white_check_mark: |            |
-| image      | :white_check_mark: | Local only |
-| mesh       | :white_check_mark: |            |
-| material   | :white_check_mark: |            |
-| metaball   |        :x:         |            |
-| object     | :white_check_mark: |            |
-| scene      | :white_check_mark: |            |
-| world      | :white_check_mark: |            |

 ### Performance issues

-Since this addon is writen in pure python for a prototyping purpose, perfomance could be better from all perspective. Soon I will start to port the multi-user addon concept to a blender branch.
+Since this addon is written in pure python for a research purpose, performances could be better from all perspective.
+I'm working on it.

 ## Dependencies

 | Dependencies | Version | Needed |
 | ------------ | :-----: | -----: |
-| ZeroMQ       | latest  |    yes |
-| msgpack      | latest  |    yes |
-| PyYAML       | latest  |    yes |
+| Replication  | latest  |    yes |
+


 ## Contributing

-1. Fork it (<https://gitlab.com/yourname/yourproject/fork>)
-2. Create your feature branch (`git checkout -b feature/fooBar`)
-3. Commit your changes (`git commit -am 'Add some fooBar'`)
-4. Push to the branch (`git push origin feature/fooBar`)
-5. Create a new Pull Request
+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)

@@ -1,25 +0,0 @@
-__all__ = [
-    'bl_user',
-    'bl_object',
-    'bl_mesh',
-    'bl_camera',
-    'bl_collection',
-    'bl_curve',
-    'bl_gpencil',
-    'bl_image',
-    'bl_light',
-    'bl_scene',
-    'bl_material',
-    'bl_library',
-    'bl_armature',
-    'bl_action',
-    'bl_world',
-    'bl_metaball'
-]  # Order here defines execution order
-
-from . import *
-from ..libs.replication.replication.data import ReplicatedDataFactory
-
-def types_to_register():
-    return __all__
-
@@ -1,69 +0,0 @@
-import bpy
-import mathutils
-from jsondiff import diff
-
-from .. import utils
-from .bl_datablock import BlDatablock
-
-# WIP
-
-class BlAction(BlDatablock):
-    def load(self, data, target):
-        utils.dump_anything.load(target, data)
-
-    def construct(self, data):
-        return bpy.data.actions.new(data["name"])
-
-    def load(self, data, target):
-        pass
-        # # find target object
-        # object_ = bpy.context.scene.objects.active
-        # if object_ is None:
-        #     raise RuntimeError("Nothing is selected.")
-        # if object_.mode != 'POSE':  # object must be in pose mode
-        #     raise RuntimeError("Object must be in pose mode.")
-        # if object_.animation_data.action is None:
-        #     raise RuntimeError("Object needs an active action.")
-
-    def dump(self, pointer=None):
-        assert(pointer)
-        data =  utils.dump_datablock(pointer, 1)
-
-        dumper = utils.dump_anything.Dumper()
-        dumper.depth = 2
-
-
-        data["fcurves"] = []
-        for fcurve in self.pointer.fcurves:
-            fc = {
-                "data_path": fcurve.data_path,
-                "dumped_array_index": fcurve.array_index,
-                "keyframe_points": []
-            }
-
-            for k in fcurve.keyframe_points:
-                fc["keyframe_points"].append(
-                    dumper.dump(k)
-                )
-
-            data["fcurves"].append(fc)
-
-        return data
-    
-    def resolve(self):
-        assert(self.buffer)      
-        self.pointer = bpy.data.actions.get(self.buffer['name'])
-    
-    def diff(self):
-        return False
-
-    def is_valid(self):
-        return bpy.data.actions.get(self.buffer['name'])
-
-bl_id = "actions"
-bl_class = bpy.types.Action
-bl_rep_class = BlAction
-bl_delay_refresh = 1
-bl_delay_apply = 1
-bl_automatic_push = True
-bl_icon = 'ACTION_TWEAK'
@@ -1,107 +0,0 @@
-import bpy
-import mathutils
-from jsondiff import diff
-
-from ..libs.overrider import Overrider
-from .. import utils
-from .. import presence
-from .bl_datablock import BlDatablock
-
-# WIP
-class BlArmature(BlDatablock):
-    def construct(self, data):
-        return bpy.data.armatures.new(data["name"])
-
-    def load(self, data, target):
-        # Load parent object
-        if data['user'] not in bpy.data.objects.keys():
-            parent_object = bpy.data.objects.new(data['user'], self.pointer)
-        else:
-            parent_object = bpy.data.objects[data['user']]
-        
-        is_object_in_master = (data['user_collection'][0] == "Master Collection")
-        #TODO: recursive parent collection loading
-        # Link parent object to the collection
-        if is_object_in_master:
-            parent_collection = bpy.data.scenes[data['user_scene'][0]].collection
-        elif  data['user_collection'][0] not in bpy.data.collections.keys():
-            parent_collection = bpy.data.collections.new(data['user_collection'][0])
-        else:
-            parent_collection =  bpy.data.collections[data['user_collection'][0]]
-        
-        if parent_object.name not in parent_collection.objects:
-            parent_collection.objects.link(parent_object)
-        
-        # Link parent collection to the scene master collection
-        if not is_object_in_master and parent_collection.name not in bpy.data.scenes[data['user_scene'][0]].collection.children:
-            bpy.data.scenes[data['user_scene'][0]].collection.  children.link(parent_collection)
-
-
-        # utils.dump_anything.load(target, data)
-        # with Overrider(name="bpy_",parent=bpy.context) as bpy_:
-        area, region, rv3d = presence.view3d_find()
-
-        
-        
-        bpy.context.view_layer.objects.active = parent_object 
-        # override = bpy.context.copy()
-        # override['window'] = bpy.data.window_managers[0].windows[0]
-        # override['mode'] = 'EDIT_ARMATURE'
-        # override['window_manager'] = bpy.data.window_managers[0]
-        # override['area'] = area 
-        # override['region'] = region
-        # override['screen'] = bpy.data.window_managers[0].windows[0].screen
-        
-        bpy.ops.object.mode_set(mode='EDIT')
-        for bone in data['bones']:
-            if bone not in self.pointer.edit_bones:
-                new_bone = self.pointer.edit_bones.new(bone)
-            else:
-                new_bone = self.pointer.edit_bones[bone]
-
-            new_bone.tail = data['bones'][bone]['tail_local']
-            new_bone.head = data['bones'][bone]['head_local']
-            new_bone.tail_radius = data['bones'][bone]['tail_radius']
-            new_bone.head_radius = data['bones'][bone]['head_radius']
-
-            if 'parent' in data['bones'][bone]:
-                new_bone.parent = self.pointer.edit_bones[data['bones'][bone]['parent']['name']]
-                new_bone.use_connect = data['bones'][bone]['use_connect']
-        bpy.ops.object.mode_set(mode='OBJECT')
-           
-        # bpy_.mode =  'EDIT_ARMATURE'
-
-        # bpy_.active_object = armature
-        # bpy_.selected_objects = [armature]
-
-    def dump(self, pointer=None):
-        assert(pointer)
-        data =  utils.dump_datablock(pointer, 4)
-
-        #get the parent Object
-        object_users = utils.get_datablock_users(pointer)[0]
-        data['user'] = object_users.name
-
-        #get parent collection
-        container_users = utils.get_datablock_users(object_users)
-        data['user_collection'] = [item.name for item in container_users if isinstance(item,bpy.types.Collection)]
-        data['user_scene'] = [item.name for item in container_users if isinstance(item,bpy.types.Scene)]
-        return data
-
-    def resolve(self):
-        assert(self.buffer)
-        self.pointer = bpy.data.armatures.get(self.buffer['name'])
-
-    def diff(self):
-        False
-
-    def is_valid(self):
-        return bpy.data.armatures.get(self.buffer['name'])
-
-bl_id = "armatures"
-bl_class = bpy.types.Armature
-bl_rep_class = BlArmature
-bl_delay_refresh = 1
-bl_delay_apply = 0
-bl_automatic_push = True
-bl_icon = 'ARMATURE_DATA'
@@ -1,68 +0,0 @@
-from jsondiff import diff
-
-import bpy
-import mathutils
-
-from .. import utils
-from .bl_datablock import BlDatablock
-
-
-class BlCamera(BlDatablock):
-    def load(self, data, target):
-        utils.dump_anything.load(target, data)
-
-        dof_settings = data.get('dof')
-        
-        # DOF settings
-        if dof_settings:
-            utils.dump_anything.load(target.dof, dof_settings)
-
-    def construct(self, data):
-        return bpy.data.cameras.new(data["name"])
-
-    def dump(self, pointer=None):
-        assert(pointer)
-
-        dumper = utils.dump_anything.Dumper()
-        dumper.depth = 2
-        dumper.include_filter = [
-            "name",
-            'type',
-            'lens',
-            'lens_unit',
-            'shift_x',
-            'shift_y',
-            'clip_start',
-            'clip_end',
-            'dof',
-            'use_dof',
-            'sensor_fit',
-            'sensor_width',
-            'focus_object',
-            'focus_distance',
-            'aperture_fstop',
-            'aperture_blades',
-            'aperture_rotation',
-            'aperture_ratio',
-        ]
-        return dumper.dump(pointer)
-
-    def resolve(self):
-        assert(self.buffer)
-        self.pointer = bpy.data.cameras.get(self.buffer['name'])
-
-    def diff(self):
-        return (self.bl_diff() or
-                len(diff(self.dump(pointer=self.pointer), self.buffer)))
-
-    def is_valid(self):
-        return bpy.data.cameras.get(self.buffer['name'])
-
-
-bl_id = "cameras"
-bl_class = bpy.types.Camera
-bl_rep_class = BlCamera
-bl_delay_refresh = 1
-bl_delay_apply = 1
-bl_automatic_push = True
-bl_icon = 'CAMERA_DATA'
@@ -1,71 +0,0 @@
-import bpy
-import mathutils
-
-from .. import utils
-from .bl_datablock import BlDatablock
-
-
-class BlCollection(BlDatablock):
-    def construct(self,data):
-        return bpy.data.collections.new(data["name"])
-
-    def load(self, data, target):
-        # Load other meshes metadata
-        # dump_anything.load(target, data)
- 
-        # link objects
-        for object in data["objects"]:
-            if object not in target.objects.keys():
-                target.objects.link(bpy.data.objects[object])
-
-        for object in target.objects.keys():
-            if object not in data["objects"]:
-                target.objects.unlink(bpy.data.objects[object])
-
-        # Link childrens
-        for collection in data["children"]:
-            if collection not in target.children.keys():
-                # if bpy.data.collections.find(collection) == -1:
-                target.children.link(
-                    bpy.data.collections[collection])
-
-        for collection in target.children.keys():
-            if collection not in data["children"]:
-                target.collection.children.unlink(
-                    bpy.data.collections[collection])
-
-        utils.dump_anything.load(target, data)
-
-    def dump(self, pointer=None):
-        assert(pointer)
-        return utils.dump_datablock(pointer, 4)
-
-    def resolve(self):
-        assert(self.buffer)      
-        self.pointer = bpy.data.collections.get(self.buffer['name'])
-   
-    def diff(self):
-        return (self.bl_diff() or
-                len(self.pointer.objects) != len(self.buffer['objects']) or 
-                len(self.pointer.children) != len(self.buffer['children']))
-
-    def resolve_dependencies(self):
-        deps = []
-        
-        for child in self.pointer.children:
-            deps.append(child)
-        for object in self.pointer.objects:
-            deps.append(object)
-        
-        return deps
-
-    def is_valid(self):
-        return bpy.data.collections.get(self.buffer['name'])
-        
-bl_id = "collections"
-bl_icon = 'FILE_FOLDER'
-bl_class = bpy.types.Collection
-bl_rep_class = BlCollection
-bl_delay_refresh = 1
-bl_delay_apply = 1
-bl_automatic_push = True
--- a/Show More
+++ b/Show More