forked from ubisoft/mixer
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '522-release-documentation-for-online' into 'master'
Resolve "Release documentation for online" Closes #522 See merge request animation-studio/blender/mixer!260
- Loading branch information
Showing
1 changed file
with
15 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,75 +1,38 @@ | ||
| # Mixer | ||
|
|
||
| **Disclaimer**: This project is in alpha state and actively developed. Do not use it to edit your production assets without a backup or you might break them. | ||
|
|
||
| Note that development is on Windows 10. Please report issues and submit PRs for other OSs. | ||
|
|
||
| Look for the details about the latest version in its [announcement issue](https://gitlab.com/ubisoft-animation-studio/mixer/-/issues?label_name%5B%5D=Information). | ||
| Mixer is a Blender addon developed at Ubisoft for Real Time Collaboration in 3D edition. It allows multiple Blender users to work on the same scene at the same time. | ||
|
|
||
| ## Introduction | ||
|
|
||
| Mixer is a Blender addon developed at Ubisoft Animation Studio for Real Time Collaboration in 3D edition. It allows multiple Blender users to work on the same scene at the same time. Thanks to a broadcasting server that is independent from Blender, it is also possible to implement a connection for other 3D editing softwares. | ||
| **Disclaimer**: This project is in alpha state and actively developed. Do not use it to edit your production assets without a backup or you might break them. | ||
|
|
||
| The synchronization currently supports cameras, collections, curves, grease pencils, lights, materials, metaballs, meshes, objects, scenes and worlds. | ||
| ## Features | ||
|
|
||
| Refer to the online documentation for details about current [features and limitations](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/features.html). | ||
|
|
||
| ## Usage | ||
|
|
||
| Download the addon ZIP file from the `Assets/Other` of the Gitlab release page https://gitlab.com/ubisoft-animation-studio/mixer/-/releases and install it into Blender. | ||
|
|
||
| From the Mixer panel in the 3D viewport you can enter an IP address, a port and connect to a server. If you enter `localhost` and no Mixer server is already running on your computer, then the addon will start a server in the background when you click `Connect`. | ||
|
|
||
| Then you can test locally between two Blender instances, or you can open the port on your router and give your external IP address to other people so they can join your session. | ||
|
|
||
| If all participants are in the same network everything should work directly. If participants are not on the same LAN, see [hosting a Mixer server](doc/hosting.md) | ||
|
|
||
| A Mixer server hosts rooms that are created by users. By default there is no room and someone connected to the server needs to create one from the panel. The creator of the room will upload its current blender data to the server, and this data will be transferred to people that connect to the room. | ||
|
|
||
| When all users leave a room, its content is destroyed, so someone needs to save the file before everyone leave, if you want to keep it. Optionally you can check the "keep open" checkbox so the room will remain open even if it has no users. | ||
| Documentation is available at the web site https://ubisoft-mixer.readthedocs.io/ : | ||
|
|
||
| As a Developer, you may want to read the [Developer environment](doc/development.md) documentation that details our setup. | ||
| - [download and install](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/install.html) Mixer | ||
| - perform [local tests](https://ubisoft-mixer.readthedocs.io/en/latest/getting-started/first-steps.html) | ||
| - [get connected](https://ubisoft-mixer.readthedocs.io/en/latest/collaborate/get-connected.html) and [work together](https://ubisoft-mixer.readthedocs.io/en/latest/collaborate/work-together.html) | ||
|
|
||
| ### Known limitations | ||
| ## Updates | ||
|
|
||
| - Avoid using Undo as it may cause problems like disappearing objects or crashes. | ||
| - Synchronization is currently limited to cameras, collections, curves, grease pencils, lights, materials, metaballs, meshes, objects, scenes and worlds. | ||
| Updates are announced in the [mixer-addon Blender Chat](https://blender.chat/channel/mixer-addon) channel and as a Gitlab [announcement issues](https://gitlab.com/ubisoft-animation-studio/mixer/-/issues?label_name%5B%5D=Information). | ||
|
|
||
| You will find more detailed information in the changelogs and in the announcement issue that comes with the new version. | ||
| ## Support | ||
|
|
||
| The active support repository is on Gitlab https://gitlab.com/ubisoft-animation-studio/mixer. | ||
|
|
||
| ## Repositories | ||
|
|
||
| The main repository is on Gitlab https://gitlab.com/ubisoft-animation-studio/mixer, please post your issues and merge requests there. | ||
|
|
||
| On the Gitlab repository you can see the CI tasks running (linting, unit tests, packing the addon and releases) and you have access to clean releases on the dedicated page https://gitlab.com/ubisoft-animation-studio/mixer/-/releases. | ||
|
|
||
| We do our development on both public Gitlab and an internal instance at Ubisoft. Mirroring is used to keep all repositories in sync (commits, tags and branches). We are slowly moving some important issues to the public repository to give more information to the community about our future developments and to open discussions. | ||
|
|
||
| We also have a mirror on Github https://github.com/ubisoft/mixer, as part of Ubisoft open source repositories. | ||
| The [Mixer Github repository](https://github.com/ubisoft/mixer) is a mirror that is part of Github [Ubisoft open source](https://github.com/ubisoft) projects group. | ||
|
|
||
| ## Contributing | ||
|
|
||
| You can [report any bug through issues on Gitlab](https://gitlab.com/ubisoft-animation-studio/mixer/-/issues). Please include the version you use in the issue and how to reproduce the bug, if possible. You can join a blender file, or a room file that you can save with the "Download Room" button in advanced room options. | ||
|
|
||
| In the code you might see references to VRtist or Shot Manager, which are other technologies / addons that are developed in our studio. Don't pay too much attention to related code since we plan to extract it in some way, probably with a plugins strategy. | ||
|
|
||
| You can [submit a merge requests on Gitlab](https://gitlab.com/ubisoft-animation-studio/mixer/-/merge_requests), but keep in mind that the architecture of the addon is likely to change significantly in the next few months. For bugfixes, simple refactoring, typos, documentation, or things related to the usage of the Blender API you can directly submit the merge request. For features please also open an issue to discuss it, so we can think about how it would fit in the future architecture. | ||
|
|
||
| If you have quick questions or want to chat with us, we have a channel on the Blender chat dedicated to this addon: https://blender.chat/channel/mixer-addon | ||
| See [contributing](doc/README.md) | ||
|
|
||
| ## License and copyright | ||
|
|
||
| The original code is Copyright (C) 2020 Ubisoft. | ||
|
|
||
| All code of the `mixer` package except the `mixer.broadcaster` sub-package is under the GPLv3 license. Code of the `mixer.broadcaster` sub-package is under the MIT license so feel free to extract it and use it directly in other python projects that are under a permissive license. | ||
|
|
||
| ## Documentation | ||
|
|
||
| More documentation is available in the `doc` directory: | ||
| All code of the `mixer` package is under the GPLv3 license except code of the `mixer.broadcaster` sub-package, chich is under the MIT license. | ||
|
|
||
| - [Client-Server protocol](doc/protocol.md) | ||
| - [Data synchronization](doc/synchronization.md) | ||
| - [Developer environment](doc/development.md) | ||
| - [Releasing a new version](doc/release.md) | ||
| - [Unit testing](doc/unittest.md) | ||
| - [Hosting a Mixer server](doc/hosting.md) |