From 7ee61fe9d1d01c4cd63b42b98236b5ff442b360a Mon Sep 17 00:00:00 2001 From: madratman Date: Tue, 31 Mar 2020 12:19:52 -0700 Subject: [PATCH] [docs] upgrade to ue 4.24; update pip package to 1.2.6 --- CHANGELOG.md | 3 +++ PythonClient/imitation_learning/README.md | 2 +- PythonClient/setup.py | 4 ++-- Unreal/Environments/Blocks/package.bat | 2 +- build.cmd | 2 +- build.sh | 2 +- docs/build_linux.md | 4 ++-- docs/build_windows.md | 3 ++- docs/ros.md | 2 +- docs/unreal_custenv.md | 4 ++-- docs/unreal_upgrade.md | 12 ++++++------ install_run_all.sh | 2 +- install_unreal.sh | 2 +- setup.sh | 2 +- 14 files changed, 25 insertions(+), 21 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 49208967ee..b226285409 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ Below is summarized list of important changes. This does not include minor/less important changes or bug fixes or documentation update. This list updated every few months. For complete detailed changes, please review [commit history](https://github.com/Microsoft/AirSim/commits/master). +### March 2020 +* Upgraded to Unreal Engine 4.24 + ### November, 2018 * Added Weather Effects and [APIs](docs/apis.md#weather-apis) * Added [Time of Day API](docs/apis.md#time-of-day-api) diff --git a/PythonClient/imitation_learning/README.md b/PythonClient/imitation_learning/README.md index 7f7c966949..df0c563a31 100644 --- a/PythonClient/imitation_learning/README.md +++ b/PythonClient/imitation_learning/README.md @@ -6,7 +6,7 @@ The code in this section is based on the [Autonomous Driving Cookbook](https://g ## Prerequisites * Operating system: Windows 10 * GPU: Nvidia GTX 1080 or higher (recommended) -* Software: Unreal Engine 4.18 and Visual Studio 2017 (see [upgrade instructions](../../docs/unreal_upgrade.md)) +* Software: Unreal Engine 4.24 and Visual Studio 2017 (see [upgrade instructions](../../docs/unreal_upgrade.md)) * Development: CUDA 9.0 and python 3.5. * Python libraries: Keras 2.1.2, TensorFlow 1.6.0. * Note: Newer versions of keras or tensorflow are recommended but can cause syntax errors. diff --git a/PythonClient/setup.py b/PythonClient/setup.py index fa134471c3..b27a10db78 100644 --- a/PythonClient/setup.py +++ b/PythonClient/setup.py @@ -5,7 +5,7 @@ setuptools.setup( name="airsim", - version="1.2.4", + version="1.2.6", author="Shital Shah", author_email="shitals@microsoft.com", description="Open source simulator based on Unreal Engine for autonomous vehicles from Microsoft AI & Research", @@ -22,4 +22,4 @@ install_requires=[ 'msgpack-rpc-python', 'numpy', 'opencv-contrib-python' ] -) \ No newline at end of file +) diff --git a/Unreal/Environments/Blocks/package.bat b/Unreal/Environments/Blocks/package.bat index 80f53ac63a..7969e76627 100644 --- a/Unreal/Environments/Blocks/package.bat +++ b/Unreal/Environments/Blocks/package.bat @@ -7,7 +7,7 @@ set OutPath=%1 set ToolPath=%2 set UEVer=%3 -if "%UEVer%"=="" set "UEVer=4.18" +if "%UEVer%"=="" set "UEVer=4.24" set "_ToolPath=%PROGRAMFILES%\Epic Games\UE_%UEVer%\Engine\Build\BatchFiles" if "%ToolPath%"=="" set ToolPath=%_ToolPath% diff --git a/build.cmd b/build.cmd index 7abe9cd4fa..5efd49a837 100644 --- a/build.cmd +++ b/build.cmd @@ -15,7 +15,7 @@ if "%VisualStudioVersion%"=="" ( ) if "%VisualStudioVersion%"=="14.0" ( echo( - echo Hello there! We just upgraded AirSim to Unreal Engine 4.18 and Visual Studio 2017. + echo Hello there! We just upgraded AirSim to Unreal Engine 4.24 and Visual Studio 2017. echo Here are few easy steps for upgrade so everything is new and shiny: echo https://github.com/Microsoft/AirSim/blob/master/docs/unreal_upgrade.md goto :buildfailed_nomsg diff --git a/build.sh b/build.sh index 33aa00565c..5c3275085e 100755 --- a/build.sh +++ b/build.sh @@ -65,7 +65,7 @@ else #check for correct verion of llvm if [[ ! -d "llvm-source-50" ]]; then if [[ -d "llvm-source-39" ]]; then - echo "Hello there! We just upgraded AirSim to Unreal Engine 4.18." + echo "Hello there! We just upgraded AirSim to Unreal Engine 4.24." echo "Here are few easy steps for upgrade so everything is new and shiny :)" echo "https://github.com/Microsoft/AirSim/blob/master/docs/unreal_upgrade.md" exit 1 diff --git a/docs/build_linux.md b/docs/build_linux.md index 17feaeb988..58cebbc57f 100644 --- a/docs/build_linux.md +++ b/docs/build_linux.md @@ -12,10 +12,10 @@ Please see instructions [here](https://github.com/Microsoft/AirSim/blob/master/d ### Build Unreal Engine and Airsim - Make sure you are [registered with Epic Games](https://docs.unrealengine.com/latest/INT/Platforms/Linux/BeginnerLinuxDeveloper/SettingUpAnUnrealWorkflow/1/index.html). This is required to get source code access for Unreal Engine. -- Clone Unreal in your favorite folder and build it (this may take a while!). **Note**: We only support Unreal 4.18 at present. +- Clone Unreal in your favorite folder and build it (this may take a while!). **Note**: We only support >= Unreal 4.22 at present. We recommend using 4.24. ```bash # go to the folder where you clone GitHub projects - git clone -b 4.18 https://github.com/EpicGames/UnrealEngine.git + git clone -b 4.24 https://github.com/EpicGames/UnrealEngine.git cd UnrealEngine ./Setup.sh ./GenerateProjectFiles.sh diff --git a/docs/build_windows.md b/docs/build_windows.md index ed672bea3f..98281207ec 100644 --- a/docs/build_windows.md +++ b/docs/build_windows.md @@ -4,8 +4,9 @@ 1. [Download](https://www.unrealengine.com/download) the Epic Games Launcher. While the Unreal Engine is open source and free to download, registration is still required. 2. Run the Epic Games Launcher, open the `Library` tab on the left pane. -Click on the `Add Versions` which should show the option to download **Unreal 4.18** as shown below. If you have multiple versions of Unreal installed then **make sure 4.18 is set to `current`** by clicking down arrow next to the Launch button for the version. +Click on the `Add Versions` which should show the option to download **Unreal 4.24** as shown below. If you have multiple versions of Unreal installed then **make sure 4.24 is set to `current`** by clicking down arrow next to the Launch button for the version. + **Note**: AirSim also works with UE >= 4.22, however, we recommend you update to 4.24. **Note**: If you have UE 4.16 or older projects, please see the [upgrade guide](unreal_upgrade.md) to upgrade your projects. ## Build AirSim diff --git a/docs/ros.md b/docs/ros.md index dfc143496b..690e4ef317 100644 --- a/docs/ros.md +++ b/docs/ros.md @@ -6,7 +6,7 @@ AirSim and ROS can be integrated using C++ or Python. Some example ROS nodes ar ## Prerequisites -These instructions are for Ubuntu 16.04, ROS Kinetic, UE4 4.18 or higher, and latest AirSim release. +These instructions are for Ubuntu 16.04, ROS Kinetic, UE4 4.22 or higher, and latest AirSim release. You should have these components installed and working before proceeding ## Setup diff --git a/docs/unreal_custenv.md b/docs/unreal_custenv.md index 37da8cd233..d327b0b83d 100644 --- a/docs/unreal_custenv.md +++ b/docs/unreal_custenv.md @@ -8,7 +8,7 @@ There is no `Epic Games Launcher` for Linux which means that if you need to crea ## Step by Step Instructions -1. Make sure AirSim is built and Unreal 4.18 is installed as described in [build instructions](build_windows.md). +1. Make sure AirSim is built and Unreal 4.24 is installed as described in [build instructions](build_windows.md). 2. In `Epic Games Launcher` click the Learn tab then scroll down and find `Landscape Mountains`. Click the `Create Project` and download this content (~2GB download). ![current version](images/landscape_mountains.png) @@ -26,7 +26,7 @@ There is no `Epic Games Launcher` for Linux which means that if you need to crea ``` { "FileVersion": 3, - "EngineAssociation": "4.18", + "EngineAssociation": "4.24", "Category": "Samples", "Description": "", "Modules": [ diff --git a/docs/unreal_upgrade.md b/docs/unreal_upgrade.md index 28599ddcf1..ae478cb9d4 100644 --- a/docs/unreal_upgrade.md +++ b/docs/unreal_upgrade.md @@ -1,4 +1,4 @@ -# Upgrading to Unreal Engine 4.18 +# Upgrading to Unreal Engine 4.24 These instructions apply if you are already using AirSim on Unreal Engine 4.16. If you have never installed AirSim, please see [How to get it](https://github.com/microsoft/airsim#how-to-get-it). @@ -8,19 +8,19 @@ These instructions apply if you are already using AirSim on Unreal Engine 4.16. ### For Windows Users 1. Install Visual Studio 2017 with VC++, Python and C#. -2. Install UE 4.18 through Epic Games Launcher. +2. Install UE 4.24 through Epic Games Launcher. 3. Start `x64 Native Tools Command Prompt for VS 2017` and navigate to AirSim repo. 4. Run `clean_rebuild.bat` to remove all unchecked/extra stuff and rebuild everything. ### For Linux Users 1. From your AirSim repo folder, run 'clean_rebuild.sh`. 2. Rename or delete your existing folder for Unreal Engine. -3. Follow step 1 and 2 to [install Unreal Engine 4.18](https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md#install-and-build). +3. Follow step 1 and 2 to [install Unreal Engine 4.24](https://github.com/Microsoft/AirSim/blob/master/docs/build_linux.md#install-and-build). ## Upgrading Your Custom Unreal Project -If you have your own Unreal project created in an older version of Unreal Engine then you need to upgrade your project to Unreal 4.18. To do this, +If you have your own Unreal project created in an older version of Unreal Engine then you need to upgrade your project to Unreal 4.24. To do this, -1. Open .uproject file and look for the line `"EngineAssociation"` and make sure it reads like `"EngineAssociation": "4.18"`. +1. Open .uproject file and look for the line `"EngineAssociation"` and make sure it reads like `"EngineAssociation": "4.24"`. 2. Delete `Plugins/AirSim` folder in your Unreal project's folder. 3. Go to your AirSim repo folder and copy `Unreal\Plugins` folder to your Unreal project's folder. 4. Copy *.bat (or *.sh for Linux) from `Unreal\Environments\Blocks` to your project's folder. @@ -31,7 +31,7 @@ If you have your own Unreal project created in an older version of Unreal Engine ### I have an Unreal project that is older than 4.16. How do I upgrade it? #### Option 1: Just Recreate Project -If your project doesn't have any code or assets other than environment you downloaded then you can also simply [recreate the project in Unreal 4.18 Editor](unreal_custenv.md) and then copy Plugins folder from `AirSim/Unreal/Plugins`. +If your project doesn't have any code or assets other than environment you downloaded then you can also simply [recreate the project in Unreal 4.24 Editor](unreal_custenv.md) and then copy Plugins folder from `AirSim/Unreal/Plugins`. #### Option 2: Modify Few Files Unreal versions newer than Unreal 4.15 has breaking changes. So you need to modify your *.Build.cs and *.Target.cs which you can find in the `Source` folder of your Unreal project. So what are those changes? Below is the gist of it but you should really refer to [Unreal's official 4.16 transition post](https://forums.unrealengine.com/showthread.php?145757-C-4-16-Transition-Guide). diff --git a/install_run_all.sh b/install_run_all.sh index 4293bf4d94..45ee0c1c89 100755 --- a/install_run_all.sh +++ b/install_run_all.sh @@ -23,7 +23,7 @@ fi #install unreal if [[ !(-d "$UnrealDir") ]]; then - git clone -b 4.18 https://github.com/EpicGames/UnrealEngine.git "$UnrealDir" + git clone -b 4.24 https://github.com/EpicGames/UnrealEngine.git "$UnrealDir" pushd "$UnrealDir" >/dev/null ./Setup.sh diff --git a/install_unreal.sh b/install_unreal.sh index 41e145486c..3a765c6004 100755 --- a/install_unreal.sh +++ b/install_unreal.sh @@ -23,7 +23,7 @@ fi #install unreal if [[ !(-d "$UnrealDir") ]]; then - git clone -b 4.18 https://github.com/EpicGames/UnrealEngine.git "$UnrealDir" + git clone -b 4.24 https://github.com/EpicGames/UnrealEngine.git "$UnrealDir" pushd "$UnrealDir" >/dev/null ./Setup.sh diff --git a/setup.sh b/setup.sh index f9bd0f50d2..e767188e63 100755 --- a/setup.sh +++ b/setup.sh @@ -1,7 +1,7 @@ #! /bin/bash if [[ -d "llvm-source-39" ]]; then - echo "Hello there! We just upgraded AirSim to Unreal Engine 4.18." + echo "Hello there! We just upgraded AirSim to Unreal Engine 4.24." echo "Here are few easy steps for upgrade so everything is new and shiny :)" echo "https://github.com/Microsoft/AirSim/blob/master/docs/unreal_upgrade.md" exit 1