From ab4c0bb243229899d9a321b43459890d550863b4 Mon Sep 17 00:00:00 2001 From: Rajat Singhal Date: Sun, 16 May 2021 09:27:28 +0530 Subject: [PATCH] Docs: Update use_precompiled.md --- docs/use_precompiled.md | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/docs/use_precompiled.md b/docs/use_precompiled.md index ecd451e5f4..4ad2d0ed15 100644 --- a/docs/use_precompiled.md +++ b/docs/use_precompiled.md @@ -4,25 +4,48 @@ You can simply download precompiled binaries and run to get started immediately. ### Unreal Engine -**Windows, Linux**: Download the binaries for the environment of your choice from the [latest release](https://github.com/Microsoft/AirSim/releases). 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. You may need to concatenate both files to unzip them. +**Windows, Linux**: Download the binaries for the environment of your choice from the [latest release](https://github.com/Microsoft/AirSim/releases). + +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](https://www.7-zip.org/download.html) 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](build_linux.md) ### Unity (Experimental) + A free environment called Windridge City is available at [Unity Asset Store](https://assetstore.unity.com/) as an experimental release of AirSim on Unity. **Note**: This is an old release, and many of the features and APIs might not work. ## Controlling Vehicles -Most of our users typically use [APIs](apis.md) to control the vehicles. However if you can also control vehicles manually. You can drive the car using keyboard, gamepad or [steering wheel](steering_wheel_installation.md). To fly drone manually, you will need either XBox controller or a remote control (feel free to [contribute](CONTRIBUTING.md) keyboard support). Please see [remote control setup](remote_control.md) for more details. Alternatively you can use [APIs](apis.md) for programmatic control or use so-called [Computer Vision mode](image_apis.md) to move around in environment using the keyboard. + +Most of our users typically use [APIs](apis.md) to control the vehicles. However you can also control vehicles manually. You can drive the car using keyboard, gamepad or [steering wheel](steering_wheel_installation.md). To fly drone manually, you will need either XBox controller or a remote control (feel free to [contribute](CONTRIBUTING.md) keyboard support). Please see [remote control setup](remote_control.md) for more details. Alternatively you can use [APIs](apis.md) for programmatic control or use so-called [Computer Vision mode](image_apis.md) to move around in environment using the keyboard. ## Don't Have Good GPU? -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 on Windows like this: -``` + +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: + +```batch start CityEnviron -ResX=640 -ResY=480 -windowed ``` For Linux binaries, use the `Blocks.sh` or corresponding shell script as follows - -``` + +```shell ./Blocks.sh -ResX=640 -ResY=480 -windowed ``` +Check out all the other [command-line options](https://docs.unrealengine.com/en-US/ProductionPipelines/CommandLineArguments/index.html) + 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- + +```python +>>> 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 +```