Build AirSim on macOS#

Only macOS Catalina (10.15) has currently been tested. Theoretically, AirSim should work on higher macOS versions and Apple Silicon hardware, but this path is not offically supported.

We've two options - you can either build inside docker containers or your host machine.

Docker#

Please see instructions here

Host machine#

Pre-build Setup#

Download Unreal Engine#

  1. Download the Epic Games Launcher. While the Unreal Engine is open source and free to download, registration is still required.
  2. Run the Epic Games Launcher, open the Library tab on the left pane. Click on the Add Versions which should show the option to download Unreal 4.27 as shown below. If you have multiple versions of Unreal installed then make sure 4.27 is set to current by clicking down arrow next to the Launch button for the version.

Note: AirSim also works with UE >= 4.24, however, we recommend 4.27. Note: If you have UE 4.16 or older projects, please see the upgrade guide to upgrade your projects.

Build AirSim#

  • Clone AirSim and build it:
# go to the folder where you clone GitHub projects
git clone https://github.com/Microsoft/AirSim.git
cd AirSim

By default AirSim uses clang 8 to build for compatibility with UE 4.25. The setup script will install the right version of cmake, llvm, and eigen.

CMake 3.19.2 is required for building on Apple Silicon.

./setup.sh
./build.sh
# use ./build.sh --debug to build in debug mode

Build Unreal Environment#

Finally, you will need an Unreal project that hosts the environment for your vehicles. AirSim comes with a built-in "Blocks Environment" which you can use, or you can create your own. Please see setting up Unreal Environment if you'd like to setup your own environment.

How to Use AirSim#

  • Browse to AirSim/Unreal/Environments/Blocks.
  • Run ./GenerateProjectFiles.sh <UE_PATH> from the terminal, where UE_PATH is the path to the Unreal installation folder. (By default, this is /Users/Shared/Epic\ Games/UE_4.27/) The script creates an XCode workspace by the name Blocks.xcworkspace.
  • Open the XCode workspace, and press the Build and run button in the top left.
  • After Unreal Editor loads, press Play button.

See Using APIs and settings.json for various options available for AirSim usage.

Tip

Go to 'Edit->Editor Preferences', in the 'Search' box type 'CPU' and ensure that the 'Use Less CPU when in Background' is unchecked.

[Optional] Setup Remote Control (Multirotor Only)#

A remote control is required if you want to fly manually. See the remote control setup for more details.

Alternatively, you can use APIs for programmatic control or use the so-called Computer Vision mode to move around using the keyboard.