SimWorld Documentation
====================================

.. image:: assets/simworld_overview.png
   :alt: SimWorld Overview
   :width: 800px
   :align: center

.. raw:: html

   <br><br>
 
Welcome to the **SimWorld** Documentation!

Realistic, open-ended, and natively LLM/VLM-compatible simulators are essential for advancing agent development in complex physical and social environments. However, most existing simulators focus on indoor or task-specific domains (e.g., household robotics or autonomous driving), limiting research into large-scale, open-ended scenarios with realistic physical and social dynamics.

SimWorld addresses these limitations by providing a comprehensive platform that combines: 

1. Realistic, Open-Ended World Simulation. 

2. Rich Interface for LLM/VLM Agents. 

3. Diverse Physical and Social Reasoning Scenarios.

With SimWorld, researchers can explore embodied intelligence at scale, enabling agents to perceive, reason, and act in complex, dynamic worlds that closely mirror real-world scenarios.

.. note::

   This project is under active development.


.. toctree::
   :maxdepth: 2
   :caption: GETTING STARTED

   getting_started/introduction
   getting_started/installation
   getting_started/configuration
   getting_started/minimal_example
   getting_started/base_environments
   getting_started/additional_environments

.. toctree::
   :maxdepth: 2
   :caption: CUSTOMIZATION

   customization/make_your_own_pak

.. toctree::
   :maxdepth: 1
   :caption: NEXT STEPS

   next_steps/next_step

.. toctree::
   :maxdepth: 2
   :caption: SIMWORLD MODULES

   components/overview
   components/ue_detail
   components/citygen
   components/waypoint_system
   components/traffic_system
   components/agent_system
   components/unrealcv+

.. toctree::
   :maxdepth: 2
   :caption: ADDITIONAL CONFIGURATION

   additional_configuration/configuration

.. toctree::
   :maxdepth: 2
   :caption: PYTHON API REFERENCE

   resources/modules

.. toctree::
   :maxdepth: 2
   :caption: SIMWORLD ROBOTICS

   simworld-robotics/simworld_robotics