You can simply download precompiled binaries and run to get started immediately. If you want to set up your own Unreal environment then please see these instructions.
Windows, Linux: Download the binaries for the environment of your choice from the latest release.
Some pre-compiled environment binaries may include multiple files (i.e. City.zip.001, City.zip.002). Make sure to download both files before starting the environment.
Use 7zip to unzip these files. On Linux, pass the first zip file name as argument and it should detect all the other parts as well - 7zz x TrapCamera.zip.001
macOS: You will need to build it yourself
A free environment called Windridge City is available at Unity Asset Store as an experimental release of AirSim on Unity. Note: This is an old release, and many of the features and APIs might not work.
Most of our users typically use APIs to control the vehicles. However you can also control vehicles manually. You can drive the car using keyboard, gamepad or steering wheel. To fly drone manually, you will need either XBox controller or a remote control (feel free to contribute keyboard support). Please see remote control setup for more details. Alternatively you can use APIs for programmatic control or use so-called Computer Vision mode to move around in environment using the keyboard.
The AirSim binaries, like CityEnviron, requires a beefy GPU to run smoothly. You can run them in low resolution mode by editing the run.bat
file (if it doesn't exist, create it with the following content) on Windows like this:
start CityEnviron -ResX=640 -ResY=480 -windowed
For Linux binaries, use the Blocks.sh
or corresponding shell script as follows -
./Blocks.sh -ResX=640 -ResY=480 -windowed
Check out all the other command-line options
UE 4.24 uses Vulkan drivers by default, but they can consume more GPU memory. If you get memory allocation errors, then you can try switching to OpenGL using -opengl
You can also limit the maximum FPS using the simRunConsoleCommand()
API as follows-
>>> import airsim
>>> client = airsim.VehicleClient()
>>> client.confirmConnection()
Connected!
Client Ver:1 (Min Req: 1), Server Ver:1 (Min Req: 1)
>>> client.simRunConsoleCommand("t.MaxFPS 10")
True