Unreal Engine 4/5 Integration Guide

This guide was written as a quick reference step by step guide for first time installation. For Updating to a newer version or more in depth information on each step please check the documentation at https://www.genvidtech.com/for-developers/sdk-latest/

Installation Prerequisites

1. Visual Studio requirements

   • For Unreal Engine 4.15 to 4.19 Download Visual Studio 2015 toolchain from the build tools

   • For Unreal Engine 4.20 to 4.27 Download Visual Studio 2017 toolchain from the build tools

   • For Unreal Engine 4.25 onwards Download Visual Studio Essentials 2019

   • All of the above can be downloaded from the microsoft store

     • https://visualstudio.microsoft.com/downloads/

2. Download Genvid SDK

   • Download from https://www.genvidtech.com/

3. Open a command shell within your Genvid SDK install folder and run the following command: py install-toolbox.py --user

   • Close the command shell for changes to take effect.

Create Project and Copy Genvid files

1. Create a C++ Unreal Project. Note the location and version.

   • It is recommended the project is placed one folder layer deeper. This will give you a place to put Genvid related web and build code later.

2. Open a powershell in your Genvid SDK folder. Navigate to engine-integration/ue4

3. Use the command ‘py copy-ue4-plugin.py checkout {YourProjectRoot}’

4. Open your uproject file and add the following to “Modules”:

5.         {
         
               "LoadingPhase": "Default",
               "Name": "Genvid",
               "Type": "Runtime"
           }

6. Make sure to add a comma after the previous entry in Modules

7. Open your .Build.cs file. Add the following:

8. PrivateDependencyModuleNames.Add("Genvid");
   if (Target.Type == TargetRules.TargetType.Editor)
   {
       PrivateDependencyModuleNames.Add("GenvidSDKSelector");
   }

9. This can be found under {YourProjectRoot}/<YourProject>/Source/<YourProject>/<YourProject>.Build.cs

10. Run your project. In the project settings make sure that “Default RHI” is not set to DirectX12. If it is set it to 11

Genvid Plugin

1. Under Edit/Plugins in the unreal project enable the Genvid Plugin

2. In Window/Genvid SDK in the unreal project you will be able to select your SDK version if you have multiple installed