Skip to content

Latest commit

 

History

History
56 lines (45 loc) · 1.54 KB

index.rst

File metadata and controls

56 lines (45 loc) · 1.54 KB

Welcome to Flatland's documentation!

Flatland is a performance centric 2D robot simulator started at Avidbots Corp.. It is intended for use as a light weight alternative to Gazebo Simulator for ground robots on a flat surface. Flatland uses Box2D for physics simulation and it is built to integrate directly with ROS. Flatland loads its simulation environment from YAML files and provide a plugin system for extending its functionalities.

The code is open source and available on Github, BSD3 License.

Class APIs are documented here.

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

   overview
   quick_start

.. toctree::
   :maxdepth: 2
   :caption: Flatland Tutorials

   flatland_tutorials/create_plugin.rst
   flatland_tutorials/create_model.rst
   flatland_tutorials/spawn_model.rst
   flatland_tutorials/custom_robot.rst

.. toctree::
   :maxdepth: 2
   :caption: Core Functionalities

   core_functions/ros_launch
   core_functions/world
   core_functions/layers
   core_functions/models
   core_functions/yaml_preprocessor
   core_functions/ros_services
   core_functions/model_plugins
   core_functions/joystick


.. toctree::
   :maxdepth: 2
   :caption: Built-in Plugins

   included_plugins/bumper
   included_plugins/bool_sensor
   included_plugins/diff_drive
   included_plugins/tricycle_drive
   included_plugins/laser
   included_plugins/model_tf_publisher
   included_plugins/tween
   included_plugins/gps