multi-user/README.md
2020-12-02 14:22:56 +01:00

4.7 KiB

MULTI-USER for blender

Enable real-time collaborative workflow inside blender

⚠️ Under development, use it at your own risks. Currently tested on Windows platform. ⚠️

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.

Quick installation

  1. Download latest release multi_user.zip.
  2. Run blender as administrator (dependencies installation).
  3. Install last_version.zip from your addon preferences.

Dependencies will be automatically added to your blender python during installation.

Usage

See the documentation for details.

Troubleshooting

See the troubleshooting guide for tips on the most common issues.

Current development status

Currently, not all data-block are supported for replication over the wire. The following list summarizes the status for each ones.

Name Status Comment
action ✔️
armature Not stable
camera ✔️
collection ✔️
curve Nurbs not supported
gpencil ✔️ Airbrush not supported
image ✔️
mesh ✔️
material ✔️
node_groups Material only
metaball ✔️
object ✔️
textures Supported for modifiers only
texts ✔️
scene ✔️
world ✔️
lightprobes ✔️
compositing Planned
texts Planned
nla
volumes
particles On-going
speakers Partial
vse Mask and Clip not supported yet
physics Planned
libraries Partial

Performance issues

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
Replication latest yes

Contributing

See contributing section of the documentation.

Feel free to join the discord server to chat, seek help and contribute.

Licensing

See license