Skip to content

Commit

Permalink
cleanup for 5.2.1 upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
WouterJansen committed Apr 22, 2024
1 parent d48c94d commit 3bbfd80
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 115 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### May 2024
* Merge of [Colosseum by Codex Laboratories LLC](https://github.com/CodexLabsLLC/Colosseum).
* Updated Unreal to 5.2.1

### April 2024
* Merge of Cosys-Lab fork with last Public Microsoft AirSim branch version
* Updated Unreal to 4.27 (custom fork: [https://github.com/WouterJansen/UnrealEngine/tree/4.27-cosys](https://github.com/WouterJansen/UnrealEngine/tree/4.27-cosys))
Expand Down
2 changes: 1 addition & 1 deletion PythonClient/imitation_learning/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.27.3 (Cosys-lab fork) and Visual Studio 2022
* Software: Unreal Engine 5.2.1 and Visual Studio 2022
* 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.
Expand Down
2 changes: 1 addition & 1 deletion Unreal/Environments/Blocks/package.bat
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ set OutPath=%1
set ToolPath=%2
set UEVer=%3

if "%UEVer%"=="" set "UEVer=4.27.3"
if "%UEVer%"=="" set "UEVer=5.2.1"

set "_ToolPath=%PROGRAMFILES%\Epic Games\UE_%UEVer%\Engine\Build\BatchFiles"
if "%ToolPath%"=="" set ToolPath=%_ToolPath%
Expand Down
2 changes: 1 addition & 1 deletion build.cmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ if "%VisualStudioVersion%" == "" (
)
if "%VisualStudioVersion%" lss "17.0" (
echo(
echo Hello there! We just upgraded AirSim to Unreal Engine 4.27 and Visual Studio 2022.
echo Hello there! We just upgraded AirSim to Unreal Engine 5.2.1 and Visual Studio 2022.
echo Here are few easy steps for upgrade so everything is new and shiny:
echo https://github.com/Microsoft/AirSim/blob/main/docs/unreal_upgrade.md
goto :buildfailed_nomsg
Expand Down
29 changes: 14 additions & 15 deletions docs/build_linux.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# Build AirSim on Linux

The current recommended and tested environment is **Ubuntu 18.04 LTS**. Theoretically, you can build on other distros as well, but we haven't tested it.
The current recommended and tested environment is **Ubuntu 20.04 LTS**. Theoretically, you can build on other distros as well, but we haven't tested it.

## Host machine

### Build Unreal Engine and Airsim
This branch uses a custom version of the Unreal Engine!
- Make sure you are [registered with Epic Games and have linked your Epic Games account with your GitHub account](https://www.unrealengine.com/en-US/ue-on-github). 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.27.3 (Cosys-Lab) at present.
```bash
# go to the folder where you clone GitHub projects
git clone https://github.com/WouterJansen/UnrealEngine.git
cd UnrealEngine
./Setup.sh
./GenerateProjectFiles.sh
make
```

### Build Unreal Engine
- Make sure you are [registered with Epic Games](https://docs.unrealengine.com/en-US/SharingAndReleasing/Linux/BeginnerLinuxDeveloper/SettingUpAnUnrealWorkflow/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 5.2.1 at present.
```bash
# go to the folder where you clone GitHub projects
git clone -b 5.2 [email protected]:EpicGames/UnrealEngine.git
cd UnrealEngine
./Setup.sh
./GenerateProjectFiles.sh
make
```

### Build Airsim
- Clone AirSim and build it:
```bash
# go to the folder where you clone GitHub projects
Expand Down
23 changes: 5 additions & 18 deletions docs/build_windows.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,11 @@
# Build AirSim on Windows

## Install Unreal Engine
This branch uses a custom version of the Unreal Engine!
- Make sure you are [registered with Epic Games and have linked your Epic Games account with your GitHub account](https://www.unrealengine.com/en-US/ue-on-github). 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.27.3 (Cosys-Lab fork) at present.
```bash
# go to the folder where you clone GitHub projects
git clone https://github.com/WouterJansen/UnrealEngine.git
cd UnrealEngine
```
-Visual Studio 2012 is required for building.
- To install the correct components for UE4 development, check the "Game Development with C++" workload and the “.net 4.6.2”, "Unreal Engine Installer" and "Nuget Package Manager" optional individual components.
- run `Setup.bat`
- run `GenerateProjectFiles.bat ` as administrator

## Build UnrealEngine
- Open the generated Visual Studio project `UE4.sln` in the root of the repository. Once it is open you need to set it to build the _Development Editor_ configuration for _Win64_.
- Once that is set, you can right click the UE4 target in the Solution Explorer on the right side of the window and press build. This will take a while.
- please run `Engine\Binaries\Win64\UnrealVersionSelector-Win64-Shipping.exe` once so it is detectable by your system.
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 `Unreal Engine` tab on the left pane.
Click on the `Install` button on the top right, which should show the option to download **Unreal Engine 5.2.1**. Chose the install location to suit your needs, as shown in the images below. If you have multiple versions of Unreal installed then **make sure the version you are using is set to `current`** by clicking down arrow next to the Launch button for the version.
![Unreal Engine Tab UI Screenshot](images/ue_install.png)
![Unreal Engine Install Location UI Screenshot](images/ue_install_location.png)

## Build AirSim
* Start `x64 Native Tools Command Prompt for VS 2022`.
Expand Down
2 changes: 1 addition & 1 deletion docs/matlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ AirSim and Matlab can be integrated using Python. an example Matlab client is pr

## Prerequisites

These instructions are for Matlab 2023b (with toolboxes for the client: Computer Vision, Aerospace, Signal Processing Toolbox) UE4 4.24.4 and latest AirSim release.
These instructions are for Matlab 2023b (with toolboxes for the client: Computer Vision, Aerospace, Signal Processing Toolbox) UE 5.2.1 and latest AirSim release.
It also requires the AirSim python package to be installed.
For this go into the _PythonClient_ folder and use pip to install it to your python environment that is also used in Matlab with `pip install .`
You can find out in Matlab what Python version is used with
Expand Down
2 changes: 1 addition & 1 deletion docs/ros_python.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ AirSim and ROS can be integrated using Python. Some example ROS node are provide

## Prerequisites

These instructions are for Ubuntu 20.04, ROS Noetic, UE4 4.24.4 and latest AirSim release.
These instructions are for Ubuntu 20.04, ROS Noetic, UE 5.2.1 and latest AirSim release.
You should have these components installed and working before proceeding.

**Note that you need to install the Python module first for this to work. More information [here](apis.md) in the section 'Installing AirSim Package'.**
Expand Down
6 changes: 3 additions & 3 deletions docs/unreal_custenv.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.27.3 (Cosys-Lab fork) is installed as described in [build instructions](build_windows.md).
1. Make sure AirSim is built and Unreal 5.2.1 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)
Expand All @@ -19,7 +19,7 @@ There is no `Epic Games Launcher` for Linux which means that if you need to crea

!!!note

The Landscape Mountains project is supported up to Unreal Engine version 4.24. If you do not have 4.24 installed, you should see a dialog titled `Select Unreal Engine Version` with a dropdown to select from installed versions. Select 4.27 or greater to migrate the project to a supported engine version. If you have 4.24 installed, you can manually migrate the project by navigating to the corresponding .uproject file in Windows Explorer, right-clicking it, and selecting the `Switch Unreal Engine version...` option.
The Landscape Mountains project is supported up to Unreal Engine version 4.24. If you do not have 4.24 installed, you should see a dialog titled `Select Unreal Engine Version` with a dropdown to select from installed versions. Select 5.2.1 to migrate the project to a supported engine version. If you have 4.24 installed, you can manually migrate the project by navigating to the corresponding .uproject file in Windows Explorer, right-clicking it, and selecting the `Switch Unreal Engine version...` option.

1. From the `File menu` select `New C++ class`, leave default `None` on the type of class, click `Next`, leave default name `MyClass`, and click `Create Class`. We need to do this because Unreal requires at least one source file in project. It should trigger compile and open up Visual Studio solution `LandscapeMountains.sln`.

Expand All @@ -34,7 +34,7 @@ There is no `Epic Games Launcher` for Linux which means that if you need to crea
```json
{
"FileVersion": 3,
"EngineAssociation": "4.27",
"EngineAssociation": "",
"Category": "Samples",
"Description": "",
"Modules": [
Expand Down
74 changes: 0 additions & 74 deletions tools/build_all_ue_projects.bat

This file was deleted.

0 comments on commit 3bbfd80

Please sign in to comment.