diff --git a/docs/conf.py b/docs/conf.py index 5ff0a0f..141bf4d 100644 --- a/docs/conf.py +++ b/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': ''' +

Page Not Found

+

Sorry, we couldn't find that page.

+

Try using the search box or go to the homepage.

+''', +} \ No newline at end of file diff --git a/docs/img/quickstart_advanced.png b/docs/img/quickstart_advanced.png new file mode 100644 index 0000000..3cb0ad8 Binary files /dev/null and b/docs/img/quickstart_advanced.png differ diff --git a/docs/img/quickstart_host.png b/docs/img/quickstart_host.png new file mode 100644 index 0000000..34bc7b4 Binary files /dev/null and b/docs/img/quickstart_host.png differ diff --git a/docs/img/quickstart_join.png b/docs/img/quickstart_join.png new file mode 100644 index 0000000..f8a0124 Binary files /dev/null and b/docs/img/quickstart_join.png differ diff --git a/docs/img/quickstart_properties.png b/docs/img/quickstart_properties.png new file mode 100644 index 0000000..3d27c28 Binary files /dev/null and b/docs/img/quickstart_properties.png differ diff --git a/docs/img/quickstart_pull.png b/docs/img/quickstart_pull.png new file mode 100644 index 0000000..14f7f3b Binary files /dev/null and b/docs/img/quickstart_pull.png differ diff --git a/docs/img/quickstart_push.png b/docs/img/quickstart_push.png new file mode 100644 index 0000000..f7e3dc7 Binary files /dev/null and b/docs/img/quickstart_push.png differ diff --git a/docs/img/quickstart_refresh.png b/docs/img/quickstart_refresh.png new file mode 100644 index 0000000..f4555d8 Binary files /dev/null and b/docs/img/quickstart_refresh.png differ diff --git a/docs/img/quickstart_remove.png b/docs/img/quickstart_remove.png new file mode 100644 index 0000000..ff0f5f0 Binary files /dev/null and b/docs/img/quickstart_remove.png differ diff --git a/docs/img/quickstart_unlock.png b/docs/img/quickstart_unlock.png new file mode 100644 index 0000000..b07287f Binary files /dev/null and b/docs/img/quickstart_unlock.png differ diff --git a/docs/img/quickstart_user_infos.png b/docs/img/quickstart_user_infos.png new file mode 100644 index 0000000..1a1a942 Binary files /dev/null and b/docs/img/quickstart_user_infos.png differ diff --git a/docs/img/quickstart_users.png b/docs/img/quickstart_users.png new file mode 100644 index 0000000..01b0c4f Binary files /dev/null and b/docs/img/quickstart_users.png differ diff --git a/docs/index.rst b/docs/index.rst index fa3085e..2b3e14b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,9 +7,9 @@ Welcome to multi-user's documentation! ====================================== .. toctree:: - :maxdepth: 2 - + install + quickstart diff --git a/docs/install.rst b/docs/install.rst index 8372ea3..cce8a0d 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -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 `_. +2. Run blender as administrator (to allow python dependencies auto-installation). 3. Install last_version.zip from your addon preferences. \ No newline at end of file diff --git a/docs/quickstart.rst b/docs/quickstart.rst new file mode 100644 index 0000000..eee942e --- /dev/null +++ b/docs/quickstart.rst @@ -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 | ++---------------------------------------+-------------------+------------------------------------------------------------------------------------+ + + + + + + + + + +