.. AvatarReady documentation master file, created by
   sphinx-quickstart on Thu Jun  6 15:52:11 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to AvatarReady's documentation!
=======================================


Avatar Ready is a Unity package for easy implementation of user avatars for VR applications.

This guide will show you how to obtain the package and set up a user avatar.

This guide also includes information for developers who want to extend the package.


:ref:`Getting Started`
_______________________

| Download, install and get everything ready.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started
   :hidden:

   /Start/GettingAvatarReady
   /Start/GettingStarted
   /Start/AvatarReadySettings


:ref:`ComponentIntroduction`
____________________________

| The main components in Avatar Ready.

.. toctree::
   :maxdepth: 1
   :caption: Components
   :hidden:

   /Components/Introduction
   /Components/AvatarReadySetup
   /Components/AvatarRuntimelink
   /Components/AvatarReadyComponent

:ref:`AnimationType`
_______________________

| The animation types included in Avatar Ready.

.. toctree::
   :maxdepth: 2
   :caption: Animation Types & Systems
   :hidden:

   /AnimationType/Introduction
   /AnimationType/IK
   /AnimationType/Mocap
   /AnimationType/Replay
   /AnimationType/Creation

:ref:`IntroductionConfig`
__________________________

| Configurations for the animation systems.

.. toctree::
   :maxdepth: 2
   :caption: Configurations
   :hidden:

   /Configs/Introduction
   /Configs/Creation

:ref:`FeatureIntroduction`
__________________________

| Avatar Ready Features.

.. toctree::
   :maxdepth: 2
   :caption: Features
   :hidden:

   /Features/Introduction
   /Features/Basic
   /Features/Creation

:ref:`BasicTools`

| Tools to help using Avatar Ready

.. toctree::
   :maxdepth: 2
   :caption: Tools
   :hidden:

   /Tools/Basic

.. toctree::
   :maxdepth: 2
   :caption: Avatar Gallery
   :hidden:

   /AvatarGallery/AvatarGalleryIntro

.. toctree::
   :maxdepth: 2
   :caption: API
   :hidden:

   /API