2019-10-01 02:47:03 +08:00
# MULTI-USER for blender
2019-09-26 22:13:50 +08:00
> Enable real-time collaborative workflow inside blender
2020-03-14 23:36:48 +08:00
[](https://multi-user.readthedocs.io/en/latest/?badge=latest) [](https://discord.gg/Q3TSmb4) [](https://gitlab.com/slumber/multi-user/-/commits/master)
< img src = "https://i.imgur.com/X0B7O1Q.gif" width = 600 >
2019-10-22 22:05:30 +08:00
2019-09-26 23:16:19 +08:00
:warning: Under development, use it at your own risks. Currently tested on Windows platform. :warning:
2019-10-22 20:21:18 +08:00
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.
2019-09-26 22:13:50 +08:00
2020-01-24 22:22:18 +08:00
## Quick installation
2019-09-26 22:13:50 +08:00
2019-10-22 22:40:08 +08:00
1. Download latest release [multi_user.zip ](/uploads/8aef79c7cf5b1d9606dc58307fd9ad8b/multi_user.zip ).
2019-10-22 22:14:26 +08:00
2. Run blender as administrator (dependencies installation).
3. Install last_version.zip from your addon preferences.
2019-10-22 20:08:28 +08:00
[Dependencies ](#dependencies ) will be automatically added to your blender python during installation.
2019-09-26 22:13:50 +08:00
## Usage
2020-01-24 22:22:18 +08:00
See the [documentation ](https://multi-user.readthedocs.io/en/latest/ ) for details.
2019-09-26 22:13:50 +08:00
2019-10-22 20:21:18 +08:00
## Current development status
Currently, not all data-block are supported for replication over the wire. The following list summarizes the status for each ones.
2020-03-14 23:36:48 +08:00
| Name | Status | Comment |
| ----------- | :----: | :-----------------------------------------------------------: |
| action | ❗ | Not stable |
| armature | ❗ | Not stable |
| camera | ✔️ | |
| collection | ✔️ | |
| curve | ✔️ | Nurbs surface don't load correctly |
| gpencil | ✔️ | |
| image | ❗ | Not stable yet |
| mesh | ✔️ | |
| material | ✔️ | |
| metaball | ✔️ | |
| object | ✔️ | |
| scene | ✔️ | |
| world | ✔️ | |
| lightprobes | ✔️ | |
| particles | ❌ | [On-going ](https://gitlab.com/slumber/multi-user/-/issues/24 ) |
| speakers | ❌ | [Planned ](https://gitlab.com/slumber/multi-user/-/issues/65 ) |
| vse | ❌ | [Planned ](https://gitlab.com/slumber/multi-user/-/issues/45 ) |
| physics | ❌ | [Planned ](https://gitlab.com/slumber/multi-user/-/issues/45 ) |
| libraries | ❗ | Partial |
2019-09-26 23:16:19 +08:00
### Performance issues
2020-01-24 22:22:18 +08:00
Since this addon is written in pure python for a research purpose, performances could be better from all perspective.
2019-10-22 20:21:18 +08:00
I'm working on it.
2019-09-26 22:00:26 +08:00
2019-01-24 18:49:44 +08:00
## Dependencies
2019-07-01 22:03:40 +08:00
| Dependencies | Version | Needed |
2019-09-26 22:00:26 +08:00
| ------------ | :-----: | -----: |
2019-07-01 22:03:40 +08:00
| ZeroMQ | latest | yes |
2019-09-26 22:00:26 +08:00
| msgpack | latest | yes |
2019-10-01 02:49:30 +08:00
| JsonDiff | latest | yes |
2019-08-12 21:29:16 +08:00
2019-09-26 22:00:26 +08:00
2019-08-12 21:29:16 +08:00
## Contributing
2020-01-24 22:22:18 +08:00
See [contributing section ](https://multi-user.readthedocs.io/en/latest/ways_to_contribute.html ) of the documentation.
2019-09-26 23:16:19 +08:00
2019-10-22 20:21:18 +08:00
## Licensing
2019-10-01 02:47:03 +08:00
2020-01-24 22:22:18 +08:00
See [license ](LICENSE )
