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
< 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
2021-07-20 20:57:52 +08:00
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.
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
2021-03-02 17:16:59 +08:00
See the [documentation ](https://slumber.gitlab.io/multi-user/index.html ) for details.
2019-09-26 22:13:50 +08:00
2020-11-25 06:00:44 +08:00
## Troubleshooting
2021-03-02 17:16:59 +08:00
See the [troubleshooting guide ](https://slumber.gitlab.io/multi-user/getting_started/troubleshooting.html ) for tips on the most common issues.
2020-11-25 06:00:44 +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.
2021-07-20 20:57:52 +08:00
| 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 |
2021-07-20 20:59:30 +08:00
| armature | ❗ | Only for Mesh. [Planned for GPencil ](https://gitlab.com/slumber/multi-user/-/issues/161 ). Not stable yet |
2021-07-20 20:57:52 +08:00
| 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 ) |
2021-03-02 17:16:59 +08:00
2020-03-14 23:36:48 +08:00
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
| ------------ | :-----: | -----: |
2021-04-14 21:29:02 +08:00
| Replication | latest | yes |
2020-08-27 17:40:26 +08:00
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
2021-03-02 17:16:59 +08:00
See [contributing section ](https://slumber.gitlab.io/multi-user/ways_to_contribute.html ) of the documentation.
2019-09-26 23:16:19 +08:00
2020-08-26 17:35:06 +08:00
Feel free to [join the discord server ](https://discord.gg/aBPvGws ) to chat, seek help and contribute.
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 )
