Skip to content

Commit

Permalink
Move compilation steps to step 2 (build AirSim)
Browse files Browse the repository at this point in the history
  • Loading branch information
wouter-heerwegh committed Oct 22, 2024
1 parent 3f320a6 commit d6025b7
Showing 1 changed file with 30 additions and 38 deletions.
68 changes: 30 additions & 38 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,43 +51,6 @@ If all that works, you can continue to [the ROS interface](getting-started-with-
### Building from source using the Unreal Engine Editor and Ubuntu 20.04,22.04+
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.

**Written by Roy Amoyal, Head of the Autonomous Division at BGRacing 2024 (Formula Student Driverless Project at Ben Gurion University)**

#### Build AirSim
##### For Ubuntu 20.04

cd /home/$USER/Formula-Student-Driverless-Simulator/AirSim
./setup.sh && ./build.sh

##### For Ubuntu 22.04+
First, install Docker on your Ubuntu system.

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.

cd /home/$USER/Formula-Student-Driverless-Simulator/AirSim/docker_build

1. Build the Docker Image:

docker build -t formula-simulator .

2. Run the Docker Container: After the build completes, mount your local folder into the container:

docker run --rm -it -v $PWD/../..:/home/airsim/Formula-Student-Driverless-Simulator formula-simulator

3. Run the Setup and Build:

./setup.sh && ./build.sh

4. Exit the Docker Container: Press Ctrl + D in the terminal to exit.

5. Build the final project, use the following command (this process may take some time):

~/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

Congratulations! You have successfully built the project from source. You can now open and edit the project by running:

./home/$USER/Formula-Student-Driverless-Simulator/UE4Project/FSOnline.uproject

### Building from source using the Unreal Engine Editor for earlier versions of Ubuntu (e.g., Ubuntu 18.04)
Instead of running the simulator from release binaries, you can compile it manually using unreal engine.
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.
Expand Down Expand Up @@ -117,7 +80,36 @@ On Windows, open the _Developer Command Prompt for VS 2019_, go to `Formula-Stud
build.cmd
```

On Ubuntu, go to folder `AirSim` and run `setup.sh` and `build.sh`.
On Ubuntu 18.04 and 20.04, go to folder `AirSim` and run `setup.sh` and `build.sh`.

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

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.

cd /home/$USER/Formula-Student-Driverless-Simulator/AirSim/docker_build

1. Build the Docker Image:

docker build -t formula-simulator .

2. Run the Docker Container: After the build completes, mount your local folder into the container:

docker run --rm -it -v $PWD/../..:/home/airsim/Formula-Student-Driverless-Simulator formula-simulator

3. Run the Setup and Build:

./setup.sh && ./build.sh

4. Exit the Docker Container: Press Ctrl + D in the terminal to exit.

5. Build the final project, use the following command (this process may take some time):

~/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

Congratulations! You have successfully built the project from source. You can now continue with Unreal Engine.


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

0 comments on commit d6025b7

Please sign in to comment.