diff --git a/README.md b/README.md index 3c99206..8fe3d39 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,11 @@ > Enable real-time collaborative workflow inside blender -:warning: Under development, use it at your own risks :warning: +:warning: Under development, use it at your own risks. Currently tested on Windows platform. :warning: + +![settings](medias/connexion.gif) + +This tool aims to allow multiple user to work on the same scene over the network. ## Installation @@ -11,8 +15,12 @@ ## Usage -### Host a session +Settings are under: `View3D -> Sidebar -> Multiuser` +![settings](medias/settings.png) + +### Host a session +:warning: If you host a session over internet, special network configuration is needed :warning: todo ### Join a session @@ -23,22 +31,25 @@ todo Animation support is under development. -| 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 | :heavy_exclamation_mark: | | -| object | :white_check_mark: | | -| scene | :white_check_mark: | | -| world | :white_check_mark: | | +| 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. ## Dependencies @@ -55,4 +66,5 @@ Animation support is under development. 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 \ No newline at end of file +5. Create a new Pull Request + diff --git a/medias/connexion.gif b/medias/connexion.gif new file mode 100644 index 0000000..2ca2698 Binary files /dev/null and b/medias/connexion.gif differ diff --git a/medias/settings.png b/medias/settings.png new file mode 100644 index 0000000..a44d12a Binary files /dev/null and b/medias/settings.png differ