You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,17 +35,18 @@ A window with a car should popup!
35
35
Try driving the car around using the arrowkeys.
36
36
37
37
## From source using the Unreal Engine Editor
38
-
38
+
Instead of running the simulator from release binaries, you can compile it manually using unreal engine.
39
+
This is usefull if you want to get the latest changes or if you want to make changes to the maps or the simulation itself.
39
40
If you want to run the unreal engine project from source you will need [unreal engine and visual studio 2019](software-install-instructions.md).
40
-
On Ubuntu you can skip the visual studio 2019 part.
41
+
On Ubuntu you can skip the visual studio 2019 part, but you still need Unreal Engine.
41
42
42
-
### Get the repository
43
+
### 1. Get the repository
43
44
44
-
You can either download the repo using the big green download button on the [github page of this project](https://github.com/FS-Driverless/Formula-Student-Driverless-Simulator) or clone the repository. For cloning, checkout the documentation on this further down this page.
45
+
You can either download the repo using the big green download button on the [github page of this project](https://github.com/FS-Driverless/Formula-Student-Driverless-Simulator) or clone the repository. For cloning, checkout the documentation on this further down this page. Make sure you clone the repository in your **home directory**.
45
46
46
47
When downloading or cloning, by default you get the latest, unreleased version. This is probably not the version that you want. Make sure you select the version that you need!
47
48
48
-
### Compiling the AirSim plugin
49
+
### 2. Compiling the AirSim plugin
49
50
The Unreal Engine project requires the AirSim plugin.
50
51
We have to compile this plugin first.
51
52
The AirSim plugin is made up of AirLib (/AirSim/AirLib) and the plugin code (/UE4Project/Plugins/AirSim/Source).
@@ -66,7 +67,7 @@ On Ubuntu, go to folder `AirSim` and run `setup.sh` and `build.sh`.
66
67
67
68
The first time this takes quite a while. Go walk around a bit, maybe start playing [factoryidle](https://factoryidle.com/).
68
69
69
-
### Working with the Unreal Engine project
70
+
### 3. Working with the Unreal Engine project
70
71
71
72
Launch Unreal Engine, press Browse and open the FSDS project in `~/Driverless-Competition-Simulator/UE4Project/FSOnline.uproject`.
72
73
The project should now open correctly.
@@ -77,7 +78,7 @@ If it does not, make sure of the following:
77
78
* within `~/Driverless-Competition-Simulator/AirSim/`, you have run `build.cmd` on Windows and `./setup.sh && ./build.sh` on Ubuntu.
78
79
79
80
On Ubuntu, we recommend adding the following alias to your ~/.bashrc to speed up the process of opening the repository in the future:
It might show an error like 'This project was made with a different version of the Unreal Engine'. In that case select `more options` and `skip conversion`.
83
84
@@ -93,7 +94,7 @@ If you make changes to the plugin code or AirLib, you only have to recompile the
93
94
This can be done from within the Unreal Editor. go to to `Window` -> `Developer tools` -> `Modules`.
94
95
Search for `AirSim` and click `Recompile`.
95
96
96
-
### Launching the game
97
+
### 4. Launching the game
97
98
98
99
To run the game, click the big Play button.
99
100
If you want to run it like it would run when packaged, choose 'Run as standalone game'.
@@ -103,4 +104,4 @@ Now you are ready to connect your autonomous system.
103
104
At the moment there are two integration methods:
104
105
105
106
*[Use the ROS bridge](getting-started-with-ros.md) to connect your ROS autonomous system to the bridge.
106
-
*[Use the Python client](getting-started-with-python.md) to interact with the simulator.
107
+
*[Use the Python client](getting-started-with-python.md) to interact with the simulator.
0 commit comments