feat: readme update
This commit is contained in:
parent
28d5b684ef
commit
573f4e813c
26
README.md
26
README.md
@ -16,27 +16,21 @@ This tool aims to allow multiple users to work on the same scene over the networ
|
|||||||
|
|
||||||
Settings are under: `View3D -> Sidebar -> Multiuser`
|
Settings are under: `View3D -> Sidebar -> Multiuser`
|
||||||
|
|
||||||
![settings](medias/settings.png)
|
### 1. Set user infos
|
||||||
|
|
||||||
| Host | Join |
|
![settings](medias/user.png)
|
||||||
| :---: | :---: |
|
|
||||||
| ![host_panel](medias/host.png) | ![join_panel](medias/join.png) |
|
|
||||||
| Start empty: Cleanup the file before starting to host | IP: host ip |
|
|
||||||
| | Port: host port |
|
|
||||||
|
|
||||||
### Host a session
|
- **name**: username.
|
||||||
:warning: If you host a session over internet, special network configuration is needed :warning:
|
- **color**: color used to represent the user into other user workspaces.
|
||||||
|
|
||||||
![host_panel](medias/host.png)
|
### 2. setup network
|
||||||
|
|
||||||
- Start empty: Cleanup the file before starting to host
|
| Host | Join |
|
||||||
|
| :----------------------------------------------------------------------------------------------- | :----------------------------- |
|
||||||
|
| ![host_panel](medias/host.png) | ![join_panel](medias/join.png) |
|
||||||
|
| Start empty: Cleanup the file before starting to host | IP: host ip |
|
||||||
|
| :warning: If you host a session over internet, special network configuration is needed :warning: | Port: host port |
|
||||||
|
|
||||||
### Join a session
|
|
||||||
|
|
||||||
![join_panel](medias/join.png)
|
|
||||||
|
|
||||||
- IP: host ip
|
|
||||||
- Port: host port
|
|
||||||
|
|
||||||
## Current development statut
|
## Current development statut
|
||||||
|
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 20 KiB |
BIN
medias/user.png
Normal file
BIN
medias/user.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.6 KiB |
Loading…
x
Reference in New Issue
Block a user