Backups/multi-user
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: reflect doc hosting changes to the Readme.md

Browse Source
This commit is contained in:
Swann 2021-03-02 10:16:59 +01:00
parent 73b763d85f
commit 4726a90a4a
No known key found for this signature in database
GPG Key ID: E1D3641A7C43AACB
1 changed files with 34 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -19,44 +19,46 @@ This tool aims to allow multiple users to work on the same scene over the networ
## Usage ## Usage
See the [documentation](https://multi-user.readthedocs.io/en/latest/) for details. See the [documentation](https://slumber.gitlab.io/multi-user/index.html) for details.
## Troubleshooting ## Troubleshooting
See the [troubleshooting guide](https://multi-user.readthedocs.io/en/latest/getting_started/troubleshooting.html) for tips on the most common issues. See the [troubleshooting guide](https://slumber.gitlab.io/multi-user/getting_started/troubleshooting.html) for tips on the most common issues.
## Current development status ## Current development status
Currently, not all data-block are supported for replication over the wire. The following list summarizes the status for each ones. Currently, not all data-block are supported for replication over the wire. The following list summarizes the status for each ones.
| Name | Status | Comment | | Name | Status | Comment |
| ----------- | :----: | :--------------------------------------------------------------------------: | | -------------- | :----: | :--------------------------------------------------------------------------: |
| action | ✔️ | | | action | ✔️ | |
| armature | ❗ | Not stable | | armature | ❗ | Not stable |
| camera | ✔️ | | | camera | ✔️ | |
| collection | ✔️ | | | collection | ✔️ | |
| curve | ❗ | Nurbs not supported | | curve | ❗ | Nurbs surfaces not supported |
| gpencil | ✔️ | [Airbrush not supported](https://gitlab.com/slumber/multi-user/-/issues/123) | | gpencil | ✔️ | [Airbrush not supported](https://gitlab.com/slumber/multi-user/-/issues/123) |
| image | ✔️ | | | image | ✔️ | |
| mesh | ✔️ | | | mesh | ✔️ | |
| material | ✔️ | | | material | ✔️ | |
| node_groups | ❗ | Material only | | node_groups | ❗ | Material only |
| metaball | ✔️ | | | geometry nodes | ✔️ | |
| object | ✔️ | | | metaball | ✔️ | |
| textures | ❗ | Supported for modifiers only | | object | ✔️ | |
| texts | ✔️ | | | textures | ❗ | Supported for modifiers/materials only |
| scene | ✔️ | | | texts | ✔️ | |
| world | ✔️ | | | scene | ✔️ | |
| lightprobes | ✔️ | | | world | ✔️ | |
| compositing | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/46) | | lightprobes | ✔️ | |
| texts | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/81) | | compositing | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/46) |
| nla | ❌ | | | texts | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/81) |
| volumes | ✔️ | | | nla | ❌ | |
| particles | ❌ | [On-going](https://gitlab.com/slumber/multi-user/-/issues/24) | | volumes | ✔️ | |
| speakers | ❗ | [Partial](https://gitlab.com/slumber/multi-user/-/issues/65) | | particles | ❌ | [On-going](https://gitlab.com/slumber/multi-user/-/issues/24) |
| vse | ❗ | Mask and Clip not supported yet | | speakers | ❗ | [Partial](https://gitlab.com/slumber/multi-user/-/issues/65) |
| physics | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/45) | | vse | ❗ | Mask and Clip not supported yet |
| libraries | ❗ | Partial | | physics | ❌ | [Planned](https://gitlab.com/slumber/multi-user/-/issues/45) |
| libraries | ❗ | Partial |
### Performance issues ### Performance issues
@ -68,13 +70,13 @@ I'm working on it.
| Dependencies | Version | Needed | | Dependencies | Version | Needed |
| ------------ | :-----: | -----: | | ------------ | :-----: | -----: |
| Replication | latest | yes | | Replication | latest | yes |
## Contributing ## Contributing
See [contributing section](https://multi-user.readthedocs.io/en/latest/ways_to_contribute.html) of the documentation. See [contributing section](https://slumber.gitlab.io/multi-user/ways_to_contribute.html) of the documentation.
Feel free to [join the discord server](https://discord.gg/aBPvGws) to chat, seek help and contribute. Feel free to [join the discord server](https://discord.gg/aBPvGws) to chat, seek help and contribute.