p71924506
/
carla
mirror of https://github.com/carla-simulator/carla.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated mentions to VS 2017 -> 2019 and UE2.24 -> 4.26 in windows build and FAQ

This commit is contained in:
corkyw10 2021-07-14 15:31:26 +02:00 committed by bernat
parent d74495c7ff
commit 21358e8b42
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Docs/build_faq.md
View File

@ -93,9 +93,9 @@ CARLA forum</a>
> Many different issues can be dragged out during the build installation and will manifest themselves like this. Here is a list of the most likely reasons why: > Many different issues can be dragged out during the build installation and will manifest themselves like this. Here is a list of the most likely reasons why:
> >
> * __Run Unreal Engine 4.24.__ Something may have failed when building Unreal Engine. Try running UE editor on its own and check that it is the 4.24 release. > * __Run Unreal Engine 4.26.__ Something may have failed when building Unreal Engine. Try running UE editor on its own and check that it is the 4.26 release.
> * __Download the assets.__ The server will not be able to run without the visual content. This step is mandatory. > * __Download the assets.__ The server will not be able to run without the visual content. This step is mandatory.
> * __UE4_ROOT is not defined.__ The environment variable is not set. Remember to make it persistent session-wide by adding it to the `~/.bashrc` or `~/.profile`. Otherwise it will need to be set for every new shell. Run `export UE4_ROOT=~/UnrealEngine_4.24` to set the variable this time. > * __UE4_ROOT is not defined.__ The environment variable is not set. Remember to make it persistent session-wide by adding it to the `~/.bashrc` or `~/.profile`. Otherwise it will need to be set for every new shell. Run `export UE4_ROOT=<path_to_unreal_4-26>` to set the variable this time.
> * __Check dependencies.__ Make sure that everything was installed properly. Maybe one of the commands was skipped, unsuccessful or the dependencies were not suitable for the system. > * __Check dependencies.__ Make sure that everything was installed properly. Maybe one of the commands was skipped, unsuccessful or the dependencies were not suitable for the system.
> * __Delete CARLA and clone it again.__ Just in case something went wrong. Delete CARLA and clone or download it again. > * __Delete CARLA and clone it again.__ Just in case something went wrong. Delete CARLA and clone or download it again.
> * __Meet system requirements.__ Ubuntu version should be 16.04 or later. CARLA needs around 170GB of disk space and a dedicated GPU (or at least one with 6GB) to run. > * __Meet system requirements.__ Ubuntu version should be 16.04 or later. CARLA needs around 170GB of disk space and a dedicated GPU (or at least one with 6GB) to run.
@ -202,7 +202,7 @@ CARLA forum</a>
> >
> __1.__ Go to `carla/Unreal/CarlaUE4` and right-click the `CarlaUE4.uproject`. > __1.__ Go to `carla/Unreal/CarlaUE4` and right-click the `CarlaUE4.uproject`.
> __2.__ Click on __Generate Visual Studio project files__. > __2.__ Click on __Generate Visual Studio project files__.
> __3.__ Open the file generated with Visual Studio 2017. > __3.__ Open the file generated with Visual Studio 2019.
> __4.__ Compile the project with Visual Studio. The shortcut is F7. The build will fail, but the issues found will be shown below. > __4.__ Compile the project with Visual Studio. The shortcut is F7. The build will fail, but the issues found will be shown below.
> >
> Different issues may result in this specific error message. The user [@tamakoji](https://github.com/tamakoji) solved a recurrent case where the source code hadn't been cloned properly and the CARLA version could not be set (when downloading this as a .zip from git). > Different issues may result in this specific error message. The user [@tamakoji](https://github.com/tamakoji) solved a recurrent case where the source code hadn't been cloned properly and the CARLA version could not be set (when downloading this as a .zip from git).
@ -229,13 +229,13 @@ CARLA forum</a>
> This issue occurs when trying to use the _make_ command either to build the server or the client. Even if CMake is installed, updated and added to the environment path. There may be a conflict between Visual Studio versions. > This issue occurs when trying to use the _make_ command either to build the server or the client. Even if CMake is installed, updated and added to the environment path. There may be a conflict between Visual Studio versions.
> >
> Leave only VS2017 and completely erase the rest. > Leave only VS2019 and completely erase the rest.
<!-- ======================================================================= --> <!-- ======================================================================= -->
###### Error C2440, C2672: compiler version. ###### Error C2440, C2672: compiler version.
> The build is not using the 2017 compiler due to conflicts with other Visual Studio or Microsoft Compiler versions. Uninstall these and rebuild again. > The build is not using the 2019 compiler due to conflicts with other Visual Studio or Microsoft Compiler versions. Uninstall these and rebuild again.
> >
> Visual Studio is not good at getting rid of itself. To completely clean Visual Studio from the computer go to `Program Files (x86)\Microsoft Visual Studio\Installer\resources\app\layout` and run `.\InstallCleanup.exe -full`. This may need admin permissions. > Visual Studio is not good at getting rid of itself. To completely clean Visual Studio from the computer go to `Program Files (x86)\Microsoft Visual Studio\Installer\resources\app\layout` and run `.\InstallCleanup.exe -full`. This may need admin permissions.
> >
@ -243,13 +243,13 @@ CARLA forum</a>
> >
> ``` > ```
> <VCProjectFileGenerator> > <VCProjectFileGenerator>
> <Version>VisualStudio2017</Version> > <Version>VisualStudio2019</Version>
> </VCProjectFileGenerator> > </VCProjectFileGenerator>
> ``` > ```
> >
> ``` > ```
> <WindowsPlatform> > <WindowsPlatform>
> <Compiler>VisualStudio2017</Compiler> > <Compiler>VisualStudio2019</Compiler>
> </WindowsPlatform> > </WindowsPlatform>
> ``` > ```
@ -260,9 +260,9 @@ CARLA forum</a>
> Many different issues can be dragged out during the build installation and manifest themselves like this. Here is a list of the most likely reasons why: > Many different issues can be dragged out during the build installation and manifest themselves like this. Here is a list of the most likely reasons why:
> >
> * __Restart the computer.__ There is a lot going on during the Windows build. Restart and make sure that everything is updated properly. > * __Restart the computer.__ There is a lot going on during the Windows build. Restart and make sure that everything is updated properly.
> * __Run Unreal Engine 4.24.__ Something may have failed when building Unreal Engine. Run the Editor and check that version 4.24 is being used. > * __Run Unreal Engine 4.26.__ Something may have failed when building Unreal Engine. Run the Editor and check that version 4.26 is being used.
> * __Download the assets.__ The server will not be able to run without the visual content. This step is mandatory. > * __Download the assets.__ The server will not be able to run without the visual content. This step is mandatory.
> * __Visual Studio 2017.__ If there are other versions of Visual Studio installed or recently uninstalled, conflicts may arise. To completely clean Visual Studio from the computer go to `Program Files (x86)\Microsoft Visual Studio\Installer\resources\app\layout` and run `.\InstallCleanup.exe -full`. > * __Visual Studio 2019.__ If there are other versions of Visual Studio installed or recently uninstalled, conflicts may arise. To completely clean Visual Studio from the computer go to `Program Files (x86)\Microsoft Visual Studio\Installer\resources\app\layout` and run `.\InstallCleanup.exe -full`.
> * __Delete CARLA and clone it again.__ Just in case something went wrong. Delete CARLA and clone or download it again. > * __Delete CARLA and clone it again.__ Just in case something went wrong. Delete CARLA and clone or download it again.
> * __Meet system requirements.__ CARLA needs around 170GB of disk space and a dedicated GPU (or at least one with 6GB) to run. > * __Meet system requirements.__ CARLA needs around 170GB of disk space and a dedicated GPU (or at least one with 6GB) to run.
> >

14
Docs/build_windows.md
View File

@ -12,7 +12,7 @@ If you come across errors or difficulties then have a look at the **[F.A.Q.](bui
- [Minor installations](#minor-installations) - [Minor installations](#minor-installations)
- [Python dependencies](#python-dependencies) - [Python dependencies](#python-dependencies)
- [Major installations](#major-installations) - [Major installations](#major-installations)
- [Visual Studio 2017](#visual-studio-2017) - [Visual Studio 2019](#visual-studio-2019)
- [Unreal Engine](#unreal-engine) - [Unreal Engine](#unreal-engine)
- [__Part Two: Build CARLA__](#part-two-build-carla) - [__Part Two: Build CARLA__](#part-two-build-carla)
- [Clone the CARLA repository](#clone-the-carla-repository) - [Clone the CARLA repository](#clone-the-carla-repository)
@ -53,9 +53,9 @@ Run the following command to install the dependencies for the Python API client:
pip3 install --user setuptools pip3 install --user setuptools
#### Major installations #### Major installations
##### Visual Studio 2017 ##### Visual Studio 2019
Get the 2017 version of Visual Studio from [here](https://developerinsider.co/download-visual-studio-2017-web-installer-iso-community-professional-enterprise/). Choose __Community__ for the free version. Use the _Visual Studio Installer_ to install three additional elements: Get the 2019 version of Visual Studio from [here](https://developerinsider.co/download-visual-studio-2019-web-installer-iso-community-professional-enterprise/). Choose __Community__ for the free version. Use the _Visual Studio Installer_ to install three additional elements:
* __Windows 8.1 SDK.__ Select it in the _Installation details_ section on the right or go to the _Indivdual Components_ tab and look under the _SDKs, libraries, and frameworks_ heading. * __Windows 8.1 SDK.__ Select it in the _Installation details_ section on the right or go to the _Indivdual Components_ tab and look under the _SDKs, libraries, and frameworks_ heading.
* __x64 Visual C++ Toolset.__ In the _Workloads_ section, choose __Desktop development with C++__. This will enable a x64 command prompt that will be used for the build. Check that it has been installed correctly by pressing the `Windows` button and searching for `x64`. Be careful __not to open a `x86_x64` prompt__. * __x64 Visual C++ Toolset.__ In the _Workloads_ section, choose __Desktop development with C++__. This will enable a x64 command prompt that will be used for the build. Check that it has been installed correctly by pressing the `Windows` button and searching for `x64`. Be careful __not to open a `x86_x64` prompt__.
@ -90,7 +90,7 @@ __2.__ Run the configuration scripts:
__3.__ Compile the modified engine: __3.__ Compile the modified engine:
>1. Open the `UE4.sln` file inside the source folder with Visual Studio 2017. >1. Open the `UE4.sln` file inside the source folder with Visual Studio 2019.
>2. In the build bar ensure that you have selected 'Development Editor', 'Win64' and 'UnrealBuildTool' options. Check [this guide](https://docs.unrealengine.com/en-US/ProductionPipelines/DevelopmentSetup/BuildingUnrealEngine/index.html) if you need any help. >2. In the build bar ensure that you have selected 'Development Editor', 'Win64' and 'UnrealBuildTool' options. Check [this guide](https://docs.unrealengine.com/en-US/ProductionPipelines/DevelopmentSetup/BuildingUnrealEngine/index.html) if you need any help.
@ -162,7 +162,7 @@ To set the environment variable:
This section outlines the commands to build CARLA. This section outlines the commands to build CARLA.
- All commands should be run in the root CARLA folder. - All commands should be run in the root CARLA folder.
- Commands should be executed via the __x64 Native Tools Command Prompt for VS 2017__. Open this by clicking the `Windows` key and searching for `x64`. - Commands should be executed via the __x64 Native Tools Command Prompt for VS 2019__. Open this by clicking the `Windows` key and searching for `x64`.
There are two parts to the build process for CARLA, compiling the client and compiling the server. There are two parts to the build process for CARLA, compiling the client and compiling the server.
@ -254,7 +254,7 @@ Below is a summary of the requirements and commands needed to build CARLA on Win
# Make # Make
# Python3 x64 # Python3 x64
# Modified Unreal Engine 4.24 # Modified Unreal Engine 4.24
# Visual Studio 2017 with Windows 8.1 SDK, x64 Visual C++ Toolset and .NET framework 4.6.2 # Visual Studio 2019 with Windows 8.1 SDK, x64 Visual C++ Toolset and .NET framework 4.6.2
# Set environment variables for the software # Set environment variables for the software
@ -265,7 +265,7 @@ git clone https://github.com/carla-simulator/carla
# Set UE4_ROOT environment variable # Set UE4_ROOT environment variable
# make the CARLA client and the CARLA server # make the CARLA client and the CARLA server
# open the x64 Native Tools Command Prompt for VS 2017 to execute the following commands # open the x64 Native Tools Command Prompt for VS 2019 to execute the following commands
make PythonAPI make PythonAPI
make launch make launch