Skip to content

Commit

Permalink
update references to old UE and VS versions
Browse files Browse the repository at this point in the history
  • Loading branch information
zimmy87 committed May 27, 2022
1 parent 2473807 commit 0aa1f7c
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
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.24 and Visual Studio 2022.
echo Hello there! We just upgraded AirSim to Unreal Engine 4.27 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/master/docs/unreal_upgrade.md
goto :buildfailed_nomsg
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.25 is installed as described in [build instructions](build_windows.md).
1. Make sure AirSim is built and Unreal 4.27 is installed as described in [build instructions](build_windows.md).
1. 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.25 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 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.

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.24",
"EngineAssociation": "4.27",
"Category": "Samples",
"Description": "",
"Modules": [
Expand Down
18 changes: 9 additions & 9 deletions docs/unreal_upgrade.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Upgrading to Unreal Engine 4.24
# Upgrading to Unreal Engine 4.27

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).
These instructions apply if you are already using AirSim on Unreal Engine 4.25. If you have never installed AirSim, please see [How to get it](https://github.com/microsoft/airsim#how-to-get-it).

**Caution:** The below steps will delete any of your unsaved work in AirSim or Unreal folder.

## Do this first

### For Windows Users
1. Install Visual Studio 2019 with VC++, Python and C#.
2. Install UE 4.24 through Epic Games Launcher.
3. Start `x64 Native Tools Command Prompt for VS 2019` and navigate to AirSim repo.
1. Install Visual Studio 2022 with VC++, Python and C#.
2. Install UE 4.27 through Epic Games Launcher.
3. Start `x64 Native Tools Command Prompt for VS 2022` and navigate to AirSim repo.
4. Run `clean_rebuild.bat` to remove all unchecked/extra stuff and rebuild everything.
5. See also [Build AirSim on Windows](build_windows.md) for more information.

### 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.24](build_linux.md).
3. Follow step 1 and 2 to [install Unreal Engine 4.27](build_linux.md).
4. See also [Build AirSim on Linux](build_linux.md) for more information.

## 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.24. 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.27. To do this,

1. Open .uproject file and look for the line `"EngineAssociation"` and make sure it reads like `"EngineAssociation": "4.24"`.
1. Open .uproject file and look for the line `"EngineAssociation"` and make sure it reads like `"EngineAssociation": "4.27"`.
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.
Expand All @@ -33,7 +33,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.24 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.27 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).
Expand Down

0 comments on commit 0aa1f7c

Please sign in to comment.