From 7e2a9a34ff5f3646661fe78e4c72503ced8ff6c3 Mon Sep 17 00:00:00 2001 From: Sijmen Date: Sun, 30 Aug 2020 01:25:46 +0200 Subject: [PATCH 1/2] Update getting started to better explain that unreal engine is optional --- docs/getting-started.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index fcfe0817..60ba886c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -35,17 +35,18 @@ A window with a car should popup! Try driving the car around using the arrowkeys. ## From source using the Unreal Engine Editor - +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. If you want to run the unreal engine project from source you will need [unreal engine and visual studio 2019](software-install-instructions.md). -On Ubuntu you can skip the visual studio 2019 part. +On Ubuntu you can skip the visual studio 2019 part, but you still need Unreal Engine. -### Get the repository +### 1. Get the repository -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. +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**. 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! -### Compiling the AirSim plugin +### 2. Compiling the AirSim plugin The Unreal Engine project requires the AirSim plugin. We have to compile this plugin first. 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`. The first time this takes quite a while. Go walk around a bit, maybe start playing [factoryidle](https://factoryidle.com/). -### Working with the Unreal Engine project +### 3. Working with the Unreal Engine project Launch Unreal Engine, press Browse and open the FSDS project in `~/Driverless-Competition-Simulator/UE4Project/FSOnline.uproject`. The project should now open correctly. @@ -93,7 +94,7 @@ If you make changes to the plugin code or AirLib, you only have to recompile the This can be done from within the Unreal Editor. go to to `Window` -> `Developer tools` -> `Modules`. Search for `AirSim` and click `Recompile`. -### Launching the game +### 4. Launching the game To run the game, click the big Play button. 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. At the moment there are two integration methods: * [Use the ROS bridge](getting-started-with-ros.md) to connect your ROS autonomous system to the bridge. -* [Use the Python client](getting-started-with-python.md) to interact with the simulator. \ No newline at end of file +* [Use the Python client](getting-started-with-python.md) to interact with the simulator. From 6913ae523ac725663b3b33c4e7737662183c4086 Mon Sep 17 00:00:00 2001 From: Sijmen Date: Sun, 30 Aug 2020 12:02:15 +0200 Subject: [PATCH 2/2] Fix broken alias in docs --- docs/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 60ba886c..5d4cdf73 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -78,7 +78,7 @@ If it does not, make sure of the following: * within `~/Driverless-Competition-Simulator/AirSim/`, you have run `build.cmd` on Windows and `./setup.sh && ./build.sh` on Ubuntu. On Ubuntu, we recommend adding the following alias to your ~/.bashrc to speed up the process of opening the repository in the future: -`alias ue='~/UnrealEngine/Engine/Binaries/Linux/UE4Editor ~/Driverless-Competition-Simulator/UE4Project/FSOnline.uproject'` +`alias ue='~/UnrealEngine/Engine/Binaries/Linux/UE4Editor ~/Formula-Student-Driverless-Simulator/UE4Project/FSOnline.uproject'` 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`.