Clone wiki

VRExpansionPlugin / How to add the plugin to a blueprint only project - Step by Step

Thanks to kusogaki77 for the installation wiki pages

Note: for non blueprint projects that already have source skip to step 4, also you can clone the repository instead of downloading a zip file if you wish.

This how-to was verified to work with UE4 engine version 4.15 on Windows 7 and 10.

It'll walk you through the process of determining your project version and getting the right plugin working for it.

If you're not using the pre-built plugin, you will have to build/compile the plugin yourself. And to do that you will need to install Visual Studio 2015/2017 and set it up for UE4.

If you are working off of the Example Template then skip to step 10!

STEP 1

  • Install Visual Studio 2015 for UE4 version 4.12 to 4.19, or Visual Studio 2017 for UE4 version 4.20 or later.

(Either version must have C++ Programming Language support enabled.)

Visual Studio 2017 is the latest, and therefore default, version. Get it here.

  • Then set it up to work with UE4.

How to get VS2015

If you don't already have a paid Visual Studio subscription, you'll need to Join the free Visual Studio Dev Essentials program (bottom-left).

Then download VS2015 update 3.

Choose Custom installation and make sure Programming languages > C++ is checked. (Default installation installs C#, not C++)

How to set up Visual Studio 2015/2017 for UE4

This set up guide will show you how to do it.

(You can stop the set up guide after you finish the Intellisense, Live Errors, and Squiggles step.)

STEP 2

  • Launch the Epic Games Launcher and sign in.
  • Then verify the engine version of the project you want to add the plugin to.

(If you're creating a new project, make sure it's a Blueprint project, not a C++ one. It doesn't matter if you use a template or an empty project template.)

version.png

STEP 3

  • Launch the project.

(If it's a new project, it'll launch automatically after you follow the steps in the screenshot for Step 2)

  • Once it's open, create a new C++ class.

newclass.png

none.png

create.png

  • When it's done, save the project and close it.

(If there are errors, it's likely because C++ components were not installed in Visual Studio. You have to rebuild the solution anyway though, so just make sure you install C++ before you try to continue from Step 10)

STEP 4

  • Create a Plugins folder in the project folder (i.e., part of Header File path in red in Step 3 screenshot.

(By default, Unreal Engine saves projects at Users/Username/Documents/Unreal Projects. Go there and open up your project folder.)

pluginfolder.png

STEP 5

Download the zip file for the version of the plugin that is compatible with your project.

(Refer to the Download Specific VRExpansion Plugin or VRExpansion Template for instructions on how to get a specific version of the plugin, like after a specific commit.)

This link will take you directly to the branches page.

zip.png

  • On the VRExpansion Plugin site, Click on Download > Branches > zip

Click on "zip" for the plugin that matches your project.

(Since I'm adding the plugin to a 4.15.2 project I will click "zip" for 4.15-Locked. ("Locked" just means it's the latest/final version of the plugin for that engine version.)

STEP 7

  • After clicking "zip", Save File.

savezip.png

  • Extract the zip file wherever you want, with whatever software you got.

(I will extract it to the default, "Downloads", folder; the same folder the zip is in.)

extractto.png

STEP 8

(Once it's done extracting, the extracted contents should be displayed.)

  • Click on the main folder.

extractedfolder.png

  • And change the name of the folder in the main folder to VRExpansionPlugin

(Make sure you change the name to VRExpansionPlugin exactly).

ChangetoVREP.png

STEP 9

  • Drag/Copy the VRExpansionPlugin folder and drop/paste it into the Plugins folder (the one created in Step 4)

drag.png

Optional Step

Some users of this plugin were receiving build errors caused by the conflicts with the content in the Intermediate folder.

  • Delete the Intermediate folder in your main project folder (This may make the initialize build and project launch times longer...)

intermediate.png

STEP 10

Right-click on the .uproject file and select Generate

generatesln.png

If you receive errors make sure to check the following:

  • Project Engine version matches the plugin version
  • C++ Programming language is installed

On Windows 10 I received errors about Windows SDK 8.0/8.1 not being installed. After running their respective exes, I was able to create the solution (sln).

Here are links to those downloads:

You will need an sln to continue with Step 11!

STEP 11

  • Double-click the generated sln to make it open in whichever VS version you had set up in Step 1.

dcsln.png

STEP 12

  • Make sure that the build target (drop down box next to win64 in the SS) is set to Development Editor.
  • Click on Build > Build Solution.
  • Wait for it to finish. (Should take anywhere from 20m to an hour.)

build.png

If it finishes with no errors, it'll look like this:

success.png

STEP 13

Launch the project and use the VRExpansion Plugin.

Updated