Skip to content

Commit a823958

Browse files
Move compilation steps to step 2 (build AirSim)
1 parent 3f320a6 commit a823958

File tree

1 file changed

+29
-40
lines changed

1 file changed

+29
-40
lines changed

docs/getting-started.md

Lines changed: 29 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -48,18 +48,39 @@ If you get a black screen with some buttons, make sure the folder with the binar
4848

4949
If all that works, you can continue to [the ROS interface](getting-started-with-ros.md) or [the python interface](getting-started-with-python.md).
5050

51-
### Building from source using the Unreal Engine Editor and Ubuntu 20.04,22.04+
52-
This guide outlines the steps for building the project from source on Ubuntu 20.04 and 22.04. It should also work for Ubuntu 24.04+, although this has not yet been tested.
51+
### From source using the Unreal Engine Editor
52+
Instead of running the simulator from release binaries, you can compile it manually using unreal engine.
53+
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.
54+
If you want to run the unreal engine project from source you will need [unreal engine and visual studio 2019](software-install-instructions.md).
55+
On Ubuntu you can skip the visual studio 2019 part, but you still need Unreal Engine.
5356

54-
**Written by Roy Amoyal, Head of the Autonomous Division at BGRacing 2024 (Formula Student Driverless Project at Ben Gurion University)**
57+
#### 1. Get the repository
58+
59+
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** and git **submodules** are included:
60+
61+
```
62+
git clone https://github.com/FS-Driverless/Formula-Student-Driverless-Simulator.git --recurse-submodules
63+
```
64+
65+
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!
5566

56-
#### Build AirSim
57-
##### For Ubuntu 20.04
67+
#### 2. Compiling the AirSim plugin
68+
The Unreal Engine project requires the AirSim plugin.
69+
We have to compile this plugin first.
70+
The AirSim plugin is made up of AirLib (/AirSim/AirLib) and the plugin code (/UE4Project/Plugins/AirSim/Source).
71+
AirLib is the shared code between the ros wrapper and the AirSim Unreal Engine plugin.
72+
73+
First build the AirLib code.
5874

59-
cd /home/$USER/Formula-Student-Driverless-Simulator/AirSim
60-
./setup.sh && ./build.sh
75+
On Windows, open the _Developer Command Prompt for VS 2019_, go to `Formula-Student-Driverless-Simulator/AirSim` and run
76+
```
77+
build.cmd
78+
```
79+
80+
On Ubuntu 18.04 and 20.04, go to folder `AirSim` and run `setup.sh` and `build.sh`.
6181

6282
##### For Ubuntu 22.04+
83+
**Written by Roy Amoyal, Head of the Autonomous Division at BGRacing 2024 (Formula Student Driverless Project at Ben Gurion University)**
6384
First, install Docker on your Ubuntu system.
6485

6586
Change to the Docker Build Directory: Note that this directory is within the AirSim folder, not the root of the Formula-Student-Driverless-Simulator repository.
@@ -84,40 +105,8 @@ Change to the Docker Build Directory: Note that this directory is within the Air
84105

85106
~/UnrealEngine/Engine/Binaries/ThirdParty/Mono/Linux/bin/mono ~/UnrealEngine/Engine/Binaries/DotNET/UnrealBuildTool.exe Development Linux -Project=/home/$uSER/Formula-Student-Driverless-Simulator/UE4Project/FSOnline.uproject -TargetType=Editor -Progress
86107

87-
Congratulations! You have successfully built the project from source. You can now open and edit the project by running:
88-
89-
./home/$USER/Formula-Student-Driverless-Simulator/UE4Project/FSOnline.uproject
90-
91-
### Building from source using the Unreal Engine Editor for earlier versions of Ubuntu (e.g., Ubuntu 18.04)
92-
Instead of running the simulator from release binaries, you can compile it manually using unreal engine.
93-
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.
94-
If you want to run the unreal engine project from source you will need [unreal engine and visual studio 2019](software-install-instructions.md).
95-
On Ubuntu you can skip the visual studio 2019 part, but you still need Unreal Engine.
96-
97-
#### 1. Get the repository
98-
99-
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** and git **submodules** are included:
100-
101-
```
102-
git clone https://github.com/FS-Driverless/Formula-Student-Driverless-Simulator.git --recurse-submodules
103-
```
104-
105-
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!
106-
107-
#### 2. Compiling the AirSim plugin
108-
The Unreal Engine project requires the AirSim plugin.
109-
We have to compile this plugin first.
110-
The AirSim plugin is made up of AirLib (/AirSim/AirLib) and the plugin code (/UE4Project/Plugins/AirSim/Source).
111-
AirLib is the shared code between the ros wrapper and the AirSim Unreal Engine plugin.
112-
113-
First build the AirLib code.
114-
115-
On Windows, open the _Developer Command Prompt for VS 2019_, go to `Formula-Student-Driverless-Simulator/AirSim` and run
116-
```
117-
build.cmd
118-
```
108+
Congratulations! You have successfully built the project from source. You can now continue with Unreal Engine.
119109

120-
On Ubuntu, go to folder `AirSim` and run `setup.sh` and `build.sh`.
121110

122111
> So what does build.cmd or setup.sh+build.sh do?
123112
It downloads any nessesary libraries and compiles AirLib.

0 commit comments

Comments
 (0)