documentation: append quickstart page
17
docs/conf.py
@ -36,6 +36,12 @@ extensions = [
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = ".rst"
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = "index"
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
@ -64,3 +70,14 @@ if on_rtd:
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'multiusrdoc'
|
||||
|
||||
# sphinx-notfound-page
|
||||
# https://github.com/readthedocs/sphinx-notfound-page
|
||||
notfound_context = {
|
||||
'title': 'Page Not Found',
|
||||
'body': '''
|
||||
<h1>Page Not Found</h1>
|
||||
<p>Sorry, we couldn't find that page.</p>
|
||||
<p>Try using the search box or go to the homepage.</p>
|
||||
''',
|
||||
}
|
BIN
docs/img/quickstart_advanced.png
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
docs/img/quickstart_host.png
Normal file
After Width: | Height: | Size: 8.9 KiB |
BIN
docs/img/quickstart_join.png
Normal file
After Width: | Height: | Size: 8.5 KiB |
BIN
docs/img/quickstart_properties.png
Normal file
After Width: | Height: | Size: 16 KiB |
BIN
docs/img/quickstart_pull.png
Normal file
After Width: | Height: | Size: 3.0 KiB |
BIN
docs/img/quickstart_push.png
Normal file
After Width: | Height: | Size: 2.9 KiB |
BIN
docs/img/quickstart_refresh.png
Normal file
After Width: | Height: | Size: 7.1 KiB |
BIN
docs/img/quickstart_remove.png
Normal file
After Width: | Height: | Size: 1.7 KiB |
BIN
docs/img/quickstart_unlock.png
Normal file
After Width: | Height: | Size: 3.8 KiB |
BIN
docs/img/quickstart_user_infos.png
Normal file
After Width: | Height: | Size: 4.6 KiB |
BIN
docs/img/quickstart_users.png
Normal file
After Width: | Height: | Size: 5.0 KiB |
@ -7,9 +7,9 @@ Welcome to multi-user's documentation!
|
||||
======================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
install
|
||||
quickstart
|
||||
|
||||
|
||||
|
||||
|
@ -2,6 +2,8 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
1. Download latest release [multi_user.zip](/uploads/8aef79c7cf5b1d9606dc58307fd9ad8b/multi_user.zip).
|
||||
2. Run blender as administrator (dependencies installation).
|
||||
*The process is the same for linux, mac and windows.*
|
||||
|
||||
1. Download latest release `multi_user.zip <https://gitlab.com/slumber/multi-user/uploads/8aef79c7cf5b1d9606dc58307fd9ad8b/multi_user.zip>`_.
|
||||
2. Run blender as administrator (to allow python dependencies auto-installation).
|
||||
3. Install last_version.zip from your addon preferences.
|
105
docs/quickstart.rst
Normal file
@ -0,0 +1,105 @@
|
||||
===========
|
||||
Quick start
|
||||
===========
|
||||
|
||||
*All settings are located under: `View3D -> Sidebar -> Multiuser panel`*
|
||||
|
||||
Session setup
|
||||
=============
|
||||
This section describe how to create or join a session.
|
||||
|
||||
---------------------
|
||||
1. User information's
|
||||
---------------------
|
||||
|
||||
.. image:: img/quickstart_user_infos.png
|
||||
|
||||
- **name**: username.
|
||||
- **color**: color used to represent the user into other user workspace.
|
||||
|
||||
----------
|
||||
2. Network
|
||||
----------
|
||||
|
||||
.. note:: If you host a session over internet, special network configuration is needed.
|
||||
|
||||
Hosting and connection are done from this panel.
|
||||
|
||||
+-----------------------------------+-------------------------------------+
|
||||
| Host | Join |
|
||||
+===================================+=====================================+
|
||||
|.. image:: img/quickstart_host.png | .. image:: img/quickstart_join.png |
|
||||
+-----------------------------------+-------------------------------------+
|
||||
| | Start empty: Cleanup the file | | IP: server ip |
|
||||
| | before hosting | | Port: server port |
|
||||
+-----------------------------------+-------------------------------------+
|
||||
| **HOST**: Host a session | **CONNECT**: Join a session |
|
||||
+-----------------------------------+-------------------------------------+
|
||||
|
||||
**Port configuration:**
|
||||
For now, a session use 4 ports to run.
|
||||
If 5555 is given in host settings, it will use 5555, 5556 (5555+1), 5557 (5555+2), 5558 (5555+3).
|
||||
|
||||
------------
|
||||
2.1 Advanced
|
||||
------------
|
||||
|
||||
.. image:: img/quickstart_advanced.png
|
||||
|
||||
**Right strategy** (only host) enable you to choose between a strict and a relaxed pattern:
|
||||
|
||||
- **Strict**: Host is the king, by default the host own each properties, only him can grant modification rights.
|
||||
- **Common**: Each properties are under common rights by default, on selection, a property is only modifiable by the owner.
|
||||
|
||||
_On each strategy, when a user is the owner he can choose to pass his rights to someone else._
|
||||
|
||||
**Properties frequency gird** allow to set a custom replication frequency for each type of data-block:
|
||||
- **Refresh**: pushed data update rate
|
||||
- **Apply**: pulled data update rate
|
||||
|
||||
*Note: Per-data type settings will soon be revamped for simplification purposes*
|
||||
|
||||
Session Management
|
||||
==================
|
||||
|
||||
---------------
|
||||
Connected users
|
||||
---------------
|
||||
|
||||
.. image:: img/quickstart_users.png
|
||||
|
||||
This panel displays all connected users, including you.
|
||||
The **camera button** allow you to focus on a user (Press `ESC` to stop focus).
|
||||
|
||||
---------------------
|
||||
Replicated properties
|
||||
---------------------
|
||||
|
||||
.. image:: img/quickstart_properties.png
|
||||
|
||||
The **replicated properties** panel shows all replicated properties status and associated actions.
|
||||
Since the replication architecture is based on commit/push/pull mechanisms, a replicated properties can be pushed/pull or even committed manually from this panel.
|
||||
|
||||
+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
|
||||
| icon | Action | Description |
|
||||
+=======================================+===================+====================================================================================+
|
||||
| .. image:: img/quickstart_push.png | **Push** | push data-block to other clients |
|
||||
+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
|
||||
| .. image:: img/quickstart_pull.png | **Pull** | pull last version into blender |
|
||||
+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
|
||||
| .. image:: img/quickstart_refresh.png | **Reset** | Reset local change to the server version |
|
||||
+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
|
||||
| .. image:: img/quickstart_unlock.png | **Lock/Unlock** | If locked, does nothing. If unlocked, grant modification rights to another user. |
|
||||
+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
|
||||
| .. image:: img/quickstart_remove.png | **Delete** | Remove the data-block from network replication |
|
||||
+---------------------------------------+-------------------+------------------------------------------------------------------------------------+
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|