Unreal Engine 4 Genvid Installation¶
The Genvid Integration for Unreal Engine 4 is composed of 3 components:
- The low-level Genvid Plugin.
- The high-level Genvid Module.
- Some Blueprints to interface with them.
We also include a script to help install them along with the rest of the SDK files.
All these elements are optional to integrate with Genvid. You can avoid using the Blueprint if you prefer direct C++ programming with Genvid Module by using the low-level integration with the Genvid Plugin or writing your own integration of the Genvid SDK. These are just there to help you do the groundwork and get you started integrating Genvid more quickly.
In This Section
Before You Begin¶
The Genvid SDK currently supports Unreal Engine 4.15.3 to 4.22.0.
For Unreal Engine 4.15.0 to 4.19.x, make sure you have the latest version of the Visual Studio 2015 toolchain. (Visual Studio 2015 build tools are available from the Microsoft download site.)
For Unreal Engine 4.20.0 to 4.22.0, make sure you have the latest version of the Visual Studio 2017 toolchain. (Visual Studio 2017 build tools are available through Microsoft Visual Studio Essentials download. You need at least a free account to log in.)
Installation into the game folder¶
To install the plugin, copy them into your game
directory. (For example, UE4ROOT/MyGame
.) The Genvid Plugin
goes under UE4ROOT/MyGame/Plugins
and the Genvid Module goes
under UE4ROOT/MyGame/Source
. You can put them in the Engine directory,
but we don’t recommend it for a faster recompiling (the Unreal Engine doesn’t use it directly).
You also need to copy the Genvid Native API files to the same location:
GenvidPlugin/ThirdParty/GenvidSDK/include/genvid.h
- The header file of the Genvid Native SDK which declares all of the functions and types.
GenvidPlugin/ThirdParty/GenvidSDK/lib/Win64/Genvid.lib
- The 64-bit import library used when linking.
Requires associated
Genvid.dll
at runtime. GenvidPlugin/ThirdParty/GenvidSDK/lib/Win64/Genvid.dll
- The 64-bit shared library used at runtime.
GenvidPlugin/ThirdParty/GenvidSDK/lib/Win32/Genvid.lib
- The 32-bit import library used when linking.
Requires associated
Genvid.dll
at runtime. GenvidPlugin/ThirdParty/GenvidSDK/lib/Win32/Genvid.dll
- The 32-bit shared library used at runtime.
We provide a Python script that copies the required files easily. Run the following to copy all files at once:
py copy-ue4-plugin.py checkout {UE4ROOT}/MyGame
It will create a manifest file that will be updated with the copied files.
If a previous manifest file is detected, the files in its content will be cleaned before new ones are copied.
You can use the --dry-run
option to see what the script will do before
running it. See copy-ue4-plugin.py for more information.
Once you’ve copied all the files, you need to modify your game’s build script
to use the plugin. Add the following lines to your game’s build script. (For
example, UE4_PROJ_ROOT/MyGame/Source/MyGame/MyGame.Build.cs
.)
// GENVID - Adding GenvidPlugin - Begin
Once finished, run GenerateProjectFiles.bat
again and you should
have access to the Genvid Module.