CARLA Unreal Engine 5 Documentation
Note
There are currently two different flavors of the CARLA simulator in active development, one based on Unreal Engine 4 and this version based on Unreal Engine 5. Due to the differences in features and functionality between the two versions, you must refer to the correct version of the documentation. If you are using the Unreal Engine 4 version of CARLA please refer to the correct documentation for that version.
Welcome to the CARLA Unreal Engine 5 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 preferred. In any case, here are a few suggestions for newcomers.
- Install CARLA: Either follow the Quick Start Installation to get a CARLA release or build CARLA from source for a desired platform.
- Start using CARLA: The Foundations section is an introduction to the most important concepts in CARLA and the First Steps tutorial shows you how to get started creating simulations.
- Check the API: there is a handy Python API reference to look up the classes and methods available.
The CARLA forums are available to connect with other CARLA community members for support.
Getting started
Introduction — What to expect from CARLA.
Quick start package installation — Install the CARLA package and get started.
First steps — Taking the first steps in CARLA with the Python API.
Building CARLA — How to build CARLA from source in Linux and Windows.
CARLA components
Foundations — Overview of the fundamental building blocks of CARLA.
Actors — Learn about actors and how to handle them.
Maps — Discover the different maps and how do vehicles move around.
Sensors and data — Retrieve simulation data using sensors.
Traffic — An overview of the different options available to populate your scenes with traffic.
Resources
Python API — Classes and methods in the Python API.
Catalogue — Catalogue of CARLA's available maps, vehicles, pedestrians and props.
Blueprint library — Blueprints provided to spawn actors.
Tutorials — Tutorials covering CARLA's important functionality.
C++ reference — Classes and methods in CARLA C++.
CARLA ecosystem
MathWorks — Overview of creating a map in RoadRunner.
ASM OpenDrive — Details of the OpenDrive support in CARLA.
ROS2 — Details of how to use the native ROS2 interface.
Scenic — How to use Scenic with CARLA to generate scenarios.
SYNKROTRON — Details about SYNKROTRON's CARLA-based simulation products.
Inverted AI — Details about Inverted AI's generative AI based traffic simulation products.
Contributing to CARLA
Guidelines — Guidelines on contributing to the development of the CARLA simulator and its ecosystem.
Coding standards — Details on the best coding practices when contributing to CARLA development.
Documentation standard — Details on the documentation standards for CARLA docs.