Skip to content

Commit 96efeba

Browse files
2 parents 6ddfbce + 6913ae5 commit 96efeba

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

docs/getting-started.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,18 @@ A window with a car should popup!
3535
Try driving the car around using the arrowkeys.
3636

3737
## 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.
3940
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.
4142

42-
### Get the repository
43+
### 1. Get the repository
4344

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**.
4546

4647
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!
4748

48-
### Compiling the AirSim plugin
49+
### 2. Compiling the AirSim plugin
4950
The Unreal Engine project requires the AirSim plugin.
5051
We have to compile this plugin first.
5152
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`.
6667

6768
The first time this takes quite a while. Go walk around a bit, maybe start playing [factoryidle](https://factoryidle.com/).
6869

69-
### Working with the Unreal Engine project
70+
### 3. Working with the Unreal Engine project
7071

7172
Launch Unreal Engine, press Browse and open the FSDS project in `~/Driverless-Competition-Simulator/UE4Project/FSOnline.uproject`.
7273
The project should now open correctly.
@@ -77,7 +78,7 @@ If it does not, make sure of the following:
7778
* within `~/Driverless-Competition-Simulator/AirSim/`, you have run `build.cmd` on Windows and `./setup.sh && ./build.sh` on Ubuntu.
7879

7980
On Ubuntu, we recommend adding the following alias to your ~/.bashrc to speed up the process of opening the repository in the future:
80-
`alias ue='~/UnrealEngine/Engine/Binaries/Linux/UE4Editor ~/Driverless-Competition-Simulator/UE4Project/FSOnline.uproject'`
81+
`alias ue='~/UnrealEngine/Engine/Binaries/Linux/UE4Editor ~/Formula-Student-Driverless-Simulator/UE4Project/FSOnline.uproject'`
8182

8283
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`.
8384

@@ -93,7 +94,7 @@ If you make changes to the plugin code or AirLib, you only have to recompile the
9394
This can be done from within the Unreal Editor. go to to `Window` -> `Developer tools` -> `Modules`.
9495
Search for `AirSim` and click `Recompile`.
9596

96-
### Launching the game
97+
### 4. Launching the game
9798

9899
To run the game, click the big Play button.
99100
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.
103104
At the moment there are two integration methods:
104105

105106
* [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

Comments
 (0)