5.4 testing

CHANGELOG.md

@@ -1,5 +1,8 @@
 ### June 2024
-* Updated Unreal to 5.3.2. Note this breaks debug rendering! Disable it to avoid issues in editor. [Fixed in 5.4](https://issues.unrealengine.com/issue/UE-199454)
+* Updated Unreal to 5.4.2. 
+* Updated Unreal to 5.3.2. 
+    * Note that 5.3.2 breaks debug rendering! Disable it to avoid issues in editor. [Fixed in 5.4](https://issues.unrealengine.com/issue/UE-199454)
+    * Note that 5.3.2 requires _r.DetailMode 2_ console command or scalability settings to be set to Epic to avoid issues with rendering the RGB scene camera sensor.
 
 ### May 2024
 * Added [multi-layer annotation](docs/annotation.md) with RGB, greyscale and texture options. Extensive API integration and available for camera and GPU-LiDAR sensors.

README.md

@@ -5,12 +5,6 @@ Our goal is to develop Cosys-AirSim as a platform for AI research to experiment
 
 This fork is based on last public AirSim release from Microsoft's GitHub.
 
-**Note that Unreal 5.3 breaks debug rendering when editor aspect ratio is not perfect! Disable it to avoid issues in editor.
-This means things like _DrawSensor_ and  _DrawDebugPoints_ should be disabled. [This does not happen in 5.2 and is fixed in 5.4](https://issues.unrealengine.com/issue/UE-199454).**
-
-
-**Note that Unreal 5.3 breaks camera scene rendering when Effects is not set to the Epic scalability preset. You can use the console command r.DetailMode 2 to fix this at runtime!**
-
 ## Cosys-Lab Modifications
 
 Cosys-Lab made extensive modifications to the AirSim platform to support multiple projects and research goals. 
@@ -74,7 +68,7 @@ A manually maintained fork of this repository is available to the public: https:
 * Added [Matlab API Client](docs/matlab.md) implementation as an easy to install Matlab toolbox.
 * Added various [random but deterministic dynamic object types and world configuration options](docs/dynamic_objects.md).
 * Added BoxCar vehicle model to the Car SimMode to have a smaller vehicle to use in indoor spaces.
-* Updated Unreal to 5.3.2.
+* Updated Unreal to 5.4.2.
 * Updated [ComputerVision mode](docs/image_apis.md#computer-vision-mode-1): Now has full API and Simulation just like other vehicle types. It mostly means it can now have sensors attached (outside of IMU). Improved handling and camera operation.
 * Updated [LIDAR sensor type](docs/lidar.md): Fixed not tracing correctly, added ground truth (point labels) generation, added range-noise generation. Improved API pointcloud delivery to be full scan instead of being frame-rate dependent and partial.
 * Updated the camera, Echo and (GPU-)LiDAR sensors to be uncoupled from the vehicle and be placed as external world sensors.

Unreal/Environments/Blocks/Blocks.uproject

@@ -1,6 +1,6 @@
 {
 	"FileVersion": 3,
-	"EngineAssociation": "5.3",
+	"EngineAssociation": "5.4",
 	"Category": "",
 	"Description": "",
 	"Modules": [

Unreal/Environments/Blocks/package.bat

@@ -7,7 +7,7 @@ set OutPath=%1
 set ToolPath=%2
 set UEVer=%3
 
-if "%UEVer%"=="" set "UEVer=5.3.2"
+if "%UEVer%"=="" set "UEVer=5.4.2"
 
 set "_ToolPath=%PROGRAMFILES%\Epic Games\UE_%UEVer%\Engine\Build\BatchFiles"
 if "%ToolPath%"=="" set ToolPath=%_ToolPath%

build.cmd

@@ -15,7 +15,7 @@ if "%VisualStudioVersion%" == "" (
 )
 if "%VisualStudioVersion%" lss "17.0" (
     echo(
-    echo Hello there! We just upgraded AirSim to Unreal Engine 5.3.2 and Visual Studio 2022.
+    echo Hello there! We just upgraded AirSim to Unreal Engine 5.4.2 and Visual Studio 2022.
     echo Here are few easy steps for upgrade so everything is new and shiny:
     echo https://cosysgit.uantwerpen.be/sensorsimulation/airsim/-/tree/master/docs/unreal_upgrade.md
     goto :buildfailed_nomsg

docs/build_linux.md

@@ -6,10 +6,10 @@ The current recommended and tested environment is **Ubuntu 20.04 LTS**. Theoreti
 
 ### 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.3.2 at present.
+- Clone Unreal in your favorite folder and build it (this may take a while!). **Note**: We only support Unreal 5.4.2 at present.
 ```bash
 # go to the folder where you clone GitHub projects
-git clone -b 5.3 [email protected]:EpicGames/UnrealEngine.git
+git clone -b 5.4 [email protected]:EpicGames/UnrealEngine.git
 cd UnrealEngine
 ./Setup.sh
 ./GenerateProjectFiles.sh

docs/build_windows.md

@@ -3,7 +3,7 @@
 ## Install Unreal Engine
 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.3.2**. 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.
+Click on the `Install` button on the top right, which should show the option to download **Unreal Engine 5.4.2**. 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)
 

docs/ros_python.md

@@ -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, UE 5.3.2 and latest AirSim release.
+These instructions are for Ubuntu 20.04, ROS Noetic, UE 5.4.2 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'.**

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 5.3.2 is installed as described in [build instructions](build_windows.md).
+1. Make sure AirSim is built and Unreal 5.4.2 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)
@@ -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 5.3.2 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.4.2 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`.