From 187fe49bbdc53b832cc828e48be2cce8c95f1311 Mon Sep 17 00:00:00 2001 From: sergi-e Date: Fri, 12 Jun 2020 09:55:13 +0200 Subject: [PATCH] Idle patch. Link needs to be changed --- Docs/build_linux.md | 39 +++++++++++++++++++++++++-------------- README.md | 18 ++++++++++++------ 2 files changed, 37 insertions(+), 20 deletions(-) diff --git a/Docs/build_linux.md b/Docs/build_linux.md index 27652ce2e..9280154fd 100644 --- a/Docs/build_linux.md +++ b/Docs/build_linux.md @@ -2,20 +2,15 @@ * [__Linux build command summary__](#linux-build-command-summary) * [__Requirements__](#requirements) - * System specifics - * Dependencies + * [System specifics](#system-specifics) + * [Dependencies](#dependencies) * [__GitHub__](#github) - * Create a GitHub account - * Install git - * Link GitHub and Unreal Engine * [__Unreal Engine__](#unreal-engine) - * Download UE4.24 - * Build UE4.24 * [__CARLA build__](#carla-build) - * Clone repository - * Get assets - * Set the environment variable - * make CARLA + * [Clone repository](#clone-repository) + * [Get assets](#get-assets) + * [Set the environment variable](#set-the-environment-variable) + * [make CARLA](#make-carla) The build process can be quite long and tedious. The **[F.A.Q.](build_faq.md)** section contains the most common issues and solutions that appear during the installation. However, the CARLA forum is open for anybody to post unexpected issues, doubts or suggestions. There is a specific section for installation issues on Linux. Feel free to login and become part of the community. @@ -60,9 +55,15 @@ sudo update-alternatives --install /usr/bin/clang clang /usr/lib/llvm-8/bin/clan # Get a GitHub and a UE account, and link both. # Install git. -# Build Unreal Engine 4.24. +# Download Unreal Engine 4.24. git clone --depth=1 -b 4.24 https://github.com/EpicGames/UnrealEngine.git ~/UnrealEngine_4.24 cd ~/UnrealEngine_4.24 + +# Download and install the UE patch +wget url://... ~Download//430667-13636743-patch.txt +patch --strip=4 < ~/Downloads/430667-13636743-patch.txt + +# Build UE ./Setup.sh && ./GenerateProjectFiles.sh && make # Open the UE Editor to check everything works properly. @@ -158,12 +159,22 @@ Get into said folder. Remember, this is the path where UE4.24 has been cloned. ```sh cd ~/UnrealEngine_4.24 ``` -Make the build. + +Get a patch for Unreal Engine. The patch fixes some Vulkan visualization issues that may occur when changing the map. Download and install it with the following commands. +```sh +wget url://... ~Download//430667-13636743-patch.txt +patch --strip=4 < ~/Downloads/430667-13636743-patch.txt +``` + +Make the build. ```sh ./Setup.sh && ./GenerateProjectFiles.sh && make ``` -Unreal Engine should be installed in the system. Run `Engine/Binaries/Linux/UE4Editor.sh` to open the Editor and check it out. +!!! Warning + If UE has already been built, install the patch and make the build again. + +Unreal Engine should be installed in the system. Run `Engine/Binaries/Linux/UE4Editor.sh` to open the Editor and check it out. ```sh cd ~/UnrealEngine_4.24/Engine/Binaries/Linux && ./UE4Editor ``` diff --git a/README.md b/README.md index 9397019ed..8e8d89dfb 100644 --- a/README.md +++ b/README.md @@ -63,15 +63,21 @@ Felipe Codevilla, Antonio Lopez, Vladlen Koltun; PMLR 78:1-16 Building CARLA -------------- -Use `git clone` or download the project from this page. Note that the master -branch contains the latest fixes and features, for the latest stable code may be +Use `git clone` or download the project from this page. Note that the master branch contains the latest fixes and features, for the latest stable code may be best to switch to the `stable` branch. -Then follow the instruction at [How to build on Linux][buildlinuxlink] or -[How to build on Windows][buildwindowslink]. +Then follow the instruction at [How to build on Linux][buildlinuxlink] or [How to build on Windows][buildwindowslink]. +The Linux build needs for an UE patch to solve some visualization issues regarding Vulkan. Those already working with a Linux build should install the patch and make the UE build again using the following commands. +```sh +# Download and install the UE patch +cd ~/UnrealEngine_4.24 +wget url://... ~Download//430667-13636743-patch.txt +patch --strip=4 < ~/Downloads/430667-13636743-patch.txt +# Build UE +./Setup.sh && ./GenerateProjectFiles.sh && make +``` -Unfortunately we don't have official instructions to build on Mac yet, please -check the progress at [issue #150][issue150]. +Unfortunately we don't have official instructions to build on Mac yet, please check the progress at [issue #150][issue150]. [buildlinuxlink]: https://carla.readthedocs.io/en/latest/build_linux/ [buildwindowslink]: https://carla.readthedocs.io/en/latest/build_windows/