.. VirtualHome documentation master file, created by
   sphinx-quickstart on Sun Dec  6 12:25:09 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

VirtualHome Documentation
=========================
Welcome to VirtualHome's Documentation! This page will guide you through the basic steps to install VirtualHome and run it to generate videos or train agents.

Check out `virtual-home.org <http://virtual-home.org/>`_ for more information. 

You can also join our `Discord channel <https://discord.gg/JmzDYF3>`_ for questions about bugs, features or collaborations


Index
=====



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

   get_started/get_started

.. toctree::
   :maxdepth: 2
   :caption: Knowledge Base

   kb/environments
   kb/procedural_generation
   kb/objects
   kb/agents
   kb/actions

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

   api/interaction

.. toctree::
   :maxdepth: 2
   :caption: Developer

   developer/developer.rst

.. toctree::
   :maxdepth: 2
   :caption: Team

   team/team.rst
   team/wishlist.rst
   team/discord.rst

.. toctree::
   :maxdepth: 2
   :caption: Downloads

   downloads/downloads