Game project setup

Installation notes

Instructions below are written for pre-compiled version usage.

If you want to build the plugin from source code, and have no experience about it, please check the official Plugins documentation or An Introduction to UE4 Plugins wiki article.

Install binaries

1. Download the plugin binaries for the latest release.
2. Copy Plugins folder from binaries archive exactly to your project directory.
3. Copy Binaries folder from binaries archive to your engine's installation folder (f.e. D:\Unreal Engine\4.2\Engine\) to be sure that Qt dependencies (Qt5Core.dll) and UE4Editor.exe are located in the same folder.

Binaries archive contains source code too - it's required to package projects

Turn on the plugin

1. Open DefaultEngine.ini
2. In [/Script/Engine.Engine] section add: GameViewportClientClassName=/Script/VaQuoleUIPlugin.VaQuoleUIViewportClient
3. In [Plugins] section add: +EnabledPlugins=VaQuoleUI

VaQuoleUI plugin requires usage of its own GameViewportClient class. I assume if you have your own custom game viewport class you should know how to handle the collision. (f.e. you can inherit UVaQuoleUIViewportClient)

Add to dependencies

To force the plugin be linked to your project on shipping build you should add it to the PrivateDependencyModuleNames section of YourProject.Build.cs.

Enjoy the plugin

That's all, you've got the power. Now you can use the VaQuoleUI components in your project!