Skip to content

command_line_switches.md

Latest commit

 

History

History
43 lines (31 loc) · 2.8 KB

command_line_switches.md

File metadata and controls

43 lines (31 loc) · 2.8 KB

Command Line Switches

Project AirSim supports the following command line switches. Since Project AirSim environments are built as Unreal executables, there are some Unreal command line switch options that can be useful:

Switch Description
‑RenderOffScreen Enable headless rendering (same for both Windows and Linux)
‑nullrhi Disable rendering completely
‑log For Windows, this switch will launch an additional command prompt that displays the log output as stdout (default behavior in Linux)
‑vulkan Force Vulkan rendering instead of DirectX for Windows (Vulkan is already default for Linux)
‑ResX=640 ‑ResY=480 Set the main viewport rendering resolution (ex. 640x480)
‑windowed Run in windowed mode
‑fullscreen Run in full-screen mode
‑NoVSync Disable VSync to prevent capping FPS at the monitor's refresh rate
‑nosound Disable any sound output
‑benchmark Enabled Unreal's benchmark mode that seems to remove any sleeps in between rendering/tick loops to run without limiting to any real-time execution rate FPS target (this mode needs further testing to confirm any side-effects and how it could be used properly)
‑gltfDir=dir/containing/tiles/ If you'll be using a GIS scene, you can specify the directory to read the tiles from. Alternatively, if you're trying CesiumForUnreal you can provide the root tileset json file.
‑clientauthpubkey=public_key Specify a client authorization public key to require clients to present a client authorization token before being allowed to use the client API. Overrides the key set by the PROJECTAIRSIM_CLIENT_AUTH_PUBKEY environment variable.

The below simulation parameters can also be changed through the comand line:

Switch Value Default Description
‑topicsport integer 8989 TCP port for pub-sub client connection (e.g. ‑topicsport=8989)
‑servicesport integer 8990 TCP port for req-resp client connection (e.g. ‑servicesport=8990)

Note: The port values must be different from one another.

Environment Variables

Project AirSim supports the following environment variables:

Environment Variable Description
PROJECTAIRSIM_CLIENT_AUTH_PUBKEY Client authorization token public key

Copyright (C) Microsoft Corporation.
Copyright (C) 2025 IAMAI CONSULTING CORP

MIT License. All rights reserved.