multi-user/docs/index.rst

.. _index-manual:

=====================================
Multi-user 0.5.0 Reference Manual
=====================================

Welcome to the manual of the Multi-user, a free and open source blender addon. It tool aims to bring multiple users to work on the same .blend over the network.

.. image:: img/homepage_ban.png

.. warning::  Under development, use it at your own risks.


Getting started
===============

.. only:: builder_html and (not singlehtml)

    .. container:: tocdescr

        .. container:: descr

            :doc:`about/introduction`

        .. container:: descr
   
            :doc:`getting_started/install`

        .. container:: descr
       
            :doc:`getting_started/quickstart`
        
        .. container:: descr
       
            :doc:`getting_started/troubleshooting`


Sections
=========

.. only:: builder_html and (not singlehtml)

   .. container:: tocdescr

      .. container:: descr

         .. figure:: /img/index_ui.png
            :target: ui/index.html

         :doc:`/ui/index`
            An introduction to Multi-User's interface.

      .. container:: descr

         .. figure:: /img/index_advanced.png
            :target: advanced/index.html

         :doc:`/advanced/index`
            Overview of the advanced settings.

      .. container:: descr

         .. figure:: /img/index_hosting_internet.png
            :target: hosting_internet/index.html

         :doc:`/hosting_internet/index`
            A tutorial to host a collaborative Multi-User session on the internet.

      .. container:: descr

         .. figure:: /img/index_workflow.png
            :target: workflow/index.html

         :doc:`/workflow/index`
            A guide to understand collaborative workflow in 3D.


.. only:: latex or epub or singlehtml

    .. toctree::
        :maxdepth: 1
    
        getting_started/index.rst
        ui/index.rst
        advanced/index.rst
        hosting_internet/index.rst
        workflow/index.rst


.. Main Features
.. =============

.. - Collaborative workflow in blender
.. - Viewport users presence (active selection, POV)
.. - Datablocks right managment
.. - Tested under Windows 

.. Community
.. =========

.. A `discord server <https://discord.gg/aBPvGws>`_ have been created to provide help for new users and 
.. organize collaborative creation sessions.

.. Status
.. ======

.. .. image:: img/homepage_roadmap.png


.. Follow the `roadmap <https://gitlab.com/slumber/multi-user/-/boards/929107>`_ to be aware of last news.

.. Documentation is organized into the following sections:

.. .. toctree::
..     :maxdepth: 1
..     :caption: About
..     :name: sec-about

..     about/introduction

.. .. toctree::
..     :maxdepth: 1
..     :caption: Getting started
..     :name: sec-learn
    
..     getting_started/install
..     getting_started/quickstart
..     getting_started/glossary
..     getting_started/troubleshooting

.. .. toctree::
..    :maxdepth: 1
..    :caption: Tutorials
..    :name: sec-tutorials

..    tutorials/hosting_guide

.. .. toctree::
..     :maxdepth: 1
..     :caption: Community
..     :name: sec-community
    
..     ways_to_contribute