Files
multi-user/README.md

94 lines
3.1 KiB
Markdown
Raw Normal View History

2019-08-08 22:55:53 +00:00
# Multi-user blender addon
2019-09-26 16:13:50 +02:00
> Enable real-time collaborative workflow inside blender
2019-09-26 17:16:19 +02:00
: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 datablocks across the wire.
2019-09-26 16:13:50 +02:00
## Installation
1. Download lastest release here.
2. Install last_version.zip from your addon preferences
## Usage
2019-09-26 17:16:19 +02:00
Settings are under: `View3D -> Sidebar -> Multiuser`
2019-09-30 17:17:00 +02:00
### Before starting
#### 1. Set user infos
2019-09-26 16:13:50 +02:00
2019-09-30 17:01:56 +02:00
![settings](medias/user.png)
2019-09-30 16:52:05 +02:00
2019-09-30 17:01:56 +02:00
- **name**: username.
- **color**: color used to represent the user into other user workspaces.
2019-09-30 16:52:05 +02:00
2019-09-30 17:17:00 +02:00
#### 2. setup network
:warning: If you host a session over internet, special network configuration is needed :warning:
2019-09-30 17:01:56 +02:00
2019-09-30 17:17:00 +02:00
| Host | Join |
| :------------------------------------------- | :----------------------------- |
| ![host_panel](medias/host.png) | ![join_panel](medias/join.png) |
| Start empty: Cleanup the file before hosting | IP: host ip |
| | Port: host port |
### In a session
#### Connected users pannel
![users](medias/users.png)
This pannel displays all connected users, including you. The camera button allow you to focus your 3D viewport on a user.
#### Properties pannel
![properties](medias/properties.png)
2019-09-30 16:52:05 +02:00
2019-09-26 16:13:50 +02:00
## Current development statut
2019-09-30 17:17:00 +02:00
Actually, not all datablock are supported for replication over the wire. The following list summarizes the status for each ones.
2019-09-26 16:13:50 +02:00
2019-09-26 17:16:19 +02:00
| 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.
2019-09-26 16:00:26 +02:00
2019-01-24 11:49:44 +01:00
## Dependencies
2019-07-01 16:03:40 +02:00
| Dependencies | Version | Needed |
2019-09-26 16:00:26 +02:00
| ------------ | :-----: | -----: |
2019-07-01 16:03:40 +02:00
| ZeroMQ | latest | yes |
2019-09-26 16:00:26 +02:00
| msgpack | latest | yes |
2019-07-01 16:03:40 +02:00
| PyYAML | latest | yes |
2019-08-12 15:29:16 +02:00
2019-09-26 16:00:26 +02:00
2019-08-12 15:29:16 +02:00
## 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`)
2019-09-26 17:16:19 +02:00
5. Create a new Pull Request