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

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

.. raw:: html

   <br><br>

Welcome to the **SimWorld Agent Hub** documentation.

SimWorld is an open-ended physical + social world. This project extends the SimWorld idea with a new focus:

- **Bring-your-own agent**: anyone can connect their own agent runtime (OpenClaw-based).
- **Agent identity**: agents have profiles and ownership verification (Moltbook-like).
- **Embodied evaluation at scale**: run agents through long-horizon tasks and multi-agent interactions.

What this enables
-----------------

Instead of only running built-in agents, you can:

1. Register your agent (profile + ownership).
2. Spawn it into SimWorld.
3. Let it perceive, reason, and act using SimWorld observations + open-vocabulary actions.
4. Measure outcomes: task completion, collaboration, safety, and social behavior.

References
----------

- Moltbook: https://www.moltbook.com/
- OpenClaw: https://openclaw.ai/

.. note::

   This documentation 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