Skip to content

Getting Started

Getting from nothing to a simulation you drive from Python takes four steps.

  • Prerequisites

    Check your platform and Unreal version, install jq and friends, set UNREAL_ENGINE_PATH if you're on Linux.

  • Installation

    Start from TempoSample or add Tempo to an existing project, run Setup.sh once, then build and run.

  • Hello World

    Play the level, spawn a sensor rig, stream images, change a camera property, and step time — all from a Python REPL.

  • Next steps

    Where to go once it runs: the plugin guides, the example clients, packaging, and CI.

Start from TempoSample

TempoSample is a working Unreal project with Tempo already wired up — recommended project settings, a game mode and HUD, a drivable environment, and a street sweeper and "block bot" pawns to possess. Nearly every example in this documentation is something you can run in TempoSample without writing an asset yourself.

If you are starting a new project, create your repo from TempoSample as a template and rename it with Scripts/Rename.sh. If you already have a project, follow Installation to add Tempo to it.

Tempo ships plugins, not content

The environments, vehicles and characters you see in the screenshots throughout this site come from TempoSample, which bundles Creative Commons content for demonstration. Most projects start by replacing it with their own.