Flightmare documentation
Welcome to Flightmare’s documentation!
This home page contains an index with a brief description of the different sections in the documentation. Feel free to read in whatever order you prefer. In any case, here are a few suggestions for newcomers.
Getting started
Introduction — What to expect from Flightmare.
Quick start — Get the latest Flightmare releases.
F.A.Q. — Some of the most frequent installation issues.
Building Flightmare binary
Standalone build — Make the build in Unity.
F.A.Q. — Some of the most frequent building issues.
First steps
Core concepts — Overview of the basic concepts in Flightmare.
Server and client — Manage and access the simulation.
Quadrotor and Objects — Learn about quadrotors and objects and how to handle them.
Environments and navigation — Discover the different maps and how to navigate through waypoints.
Sensors and data — Retrieve simulation data using sensors.
Point Cloud - Retrieve the point cloud from the scene.
F.A.Q. — Some of the most frequent usage issues.
Advanced steps
Advanced concepts — Overview of all advanced steps
Motion planning — Learn about connecting OMPL and Flightmare
Tutorials — General
Pilot Tutorial — Use Gazebo dynamics with Flightmare.
Racing Tutorial — Navigate through gates.
Retrieve simulation data — A step by step guide to properly gather data.
Tutorials — Assets
[Todo] Add a new environment — Create and add a new environment to Flightmare.
[Todo] Add a new vehicle — Prepare a vehicle to be used in Flightmare.
[Todo] Add new objects — Import additional props into Flightmare.
[Todo] Map customization — Edit an existing map.
[Todo] Material customization — Edit vehicle and building materials.
Tutorials — Developers
[Todo] Create a sensor — Develop a new sensor to be used in Flightmare.
[Todo] Make a release — For developers who want to publish a release.
[Todo] Generate detailed colliders — Create detailed colliders for meshes.
C++ References
Quadrotor references — All functions of quadrotor.
Camera references — All functions of camera.
Gate references — All functions of gate.
Quadrotor Environment — All OpenAIGym environments function.
Python References
Wrapper — Wrapper functions of QuadrotorEnv.
Contributing
[Todo] Contribution guidelines — The different ways to contribute to Flightmare.
[Todo] Code of conduct — Standard rights and duties for contributors.
[Todo] Coding standard — Guidelines to write proper code.
[Todo] Documentation standard — Guidelines to write proper documentation.