Merge pull request #299 from mateusz-lichota/add_ads_dv

Add the ADS-DV vehicle model

docs/getting-started.md

@@ -21,7 +21,9 @@ The simulator will load settings from the file `Formula-Student-Driverless-Simul
 This file is required for the simulator to work and contains the sensor configuration of the car.
 If you clone the repo you will already have this file in place.
 If not, copy-paste the contents of the [settings.json file at the root of this repository](https://github.com/FS-Driverless/Formula-Student-Driverless-Simulator/blob/master/settings.json) into the `~/Formula-Student-Driverless-Simulator`.
-This should get you started with the default sensor configuration, feel free to try your own custom sensor suite.
+This should get you started with the default vehicle and sensor configuration, but feel free to try your own custom sensor suite.
+The default vehicle is the Technion Formula Student racing car, but teams participating in the UK edition of FS-AI might want
+to simulate the ADS-DV vehicle. To do so, change the value of the `PawnBP` field in `settings.json` to `"Class'/AirSim/VehicleAdv/Cars/AdsDv/AdsDv_Pawn.AdsDv_Pawn_C'"`.
 
 ## Installation 
 

docs/import-car-3d-model.md

@@ -37,7 +37,7 @@ Export any textures to image format.
 Before we export the model, check that all deltra transforms have been applied and [all scales are set to 1](https://blender.stackexchange.com/questions/31769/how-to-set-the-current-scale-to-1/31771).
 Also don't forget to [recalculate normals](https://blender.stackexchange.com/a/153695/100133)
 
-Export the 3d model to FBX format using all default settings.
+Export the 3d model to FBX format. Make sure to select 'Z up' and 'X forward' options.
 Ensure you are only exporting meshes and armature.
 
 ## 2. Importing the model into unreal engine
@@ -94,7 +94,12 @@ Now make it look like this:
 
 ![](images/ue-anim.png)
 
-# 6. Create a pawn
+# 6. Create the wheel assets
+Make a copy of `AirSim/Content/VehicleAdv/WheelData/FormulaBackWheel` and `FormulaFrontWheel`, name it however you want, and adjust the radius and steering angle parameters to 
+match the wheels of your car. If your car's wheels are significantly different than those of the default vehicle, skipping this step can prevent the vehice 
+from moving at all.
+
+# 7. Create a pawn
 Go into your car folder and create create a new Blueprint Class with base class CarPawn.
 This will be the actual pawn that will be controlled by the autonomous system.
 
@@ -106,19 +111,23 @@ In the components browser, select 'VehicleMovement'
 Next, in the details pane:
 
 * Set `Mass` to `255,0`
-* In the `Wheel Setups` set the first two `Wheel Class` to `FormulaFrontWheel` and the last two `Wheel Class` to `FormulaBackWheel`
+* In the `Wheel Setups` set the first two `Wheel Class` to the front wheel asset created in step 6, and the last two `Wheel Class` to the back wheel asset.
 * In `Wheel Setups` set the `Bone Name` of each wheel to the corresponding bone name as found in the skeleton. From top to bottom they are front left, front right, back left, back right
 * From Drag Coefficient onwards all settings should be exactly equal to the settings in `SuvCarPawn`. Have fun copy-pasting.
 
-# 7. Selecting a car
+# 8. Selecting a car
 Update your settings.json `PawnPaths -> DefaultCar -> PawnBP` field in the `settings.json` to point at the newly created pawn. 
 Currently the following values are supported:
 
 * `Class'/AirSim/VehicleAdv/Cars/TechnionCar/TechnionCarPawn.TechnionCarPawn_C'`
-* `Class'/AirSim/VehicleAdv/Cars/SuvCar/SuvCarPawn.SuvCarPawn_C'` 
+* `Class'/AirSim/VehicleAdv/Cars/SuvCar/SuvCarPawn.SuvCarPawn_C'`
+* `Class'/AirSim/VehicleAdv/Cars/AdsDv/AdsDv_Pawn.AdsDv_Pawn_C'`
+
+To make it point to your car use the following format:
 
+`Class'/AirSim/VehicleAdv/Cars/<your car folder>/<your car pawn asset name>.<your car pawn asset name>_C'`
 
-# 8. Sharing your vehicle with the world!
+# 9. Sharing your vehicle with the world!
 
 Wouldn't it be amazing if other people could enjoy your team's vehicle 3d model as well?
 You are welcome to create a pull request with your vehicle and it might be added to the base project repository!

docs/vehicle_model.md

@@ -59,6 +59,24 @@ Within the _Vehicle Layout Overview_ picture the red dot represents the center o
 
 ![SUVCarPawn](images/vehicle_dynamic_model.png)
 
+## Available Vehicles
+
+### TechnionCar
+
+![TechnionCar](images/technion_car.png)
+
+This is the default vehicle described above, used for the FSOnline 2020 competition.
+
+To select this vehicle set the PawnBP field in `~/Formula-Student-Driverless-Simulator/settings.json` to `Class'/AirSim/VehicleAdv/Cars/TechnionCar/TechnionCarPawn.TechnionCarPawn_C'`
+
+### AdsDv
+
+![AdsDv](images/ads_dv.png)
+
+This is an autonomous vehicle provided to teams by IMeche for the Formula Student AI competition in the UK. Contributed by Mateusz Lichota from [Imperial Drivelrless](https://driverless.imperial.ac.uk/) 
+
+To select this vehicle set the PawnBP field in `~/Formula-Student-Driverless-Simulator/settings.json` to `Class'/AirSim/VehicleAdv/Cars/AdsDv/AdsDv_Pawn.AdsDv_Pawn_C'`
+
 # How to configure vehicle properties?
 
 All vehicle proprties are set in the unreal vehicle pawn classes.