Grail and Game Engines

Grail comes with plugins for Unity and Unreal Engine that allow you to use it in those engines with minimal setup required.

Grail and Unity

To make use Grail in Unity, simply import the provided unitypackage file to your project. See Unity documentation for details.

Grail and Unity
Figure 1. A directory structure in a sample Unity project using Grail.

The detailed documentation for Unity plugin can be found here.

Grail and Unreal Engine

Unreal integration is slightly more convoluted, but still manageable.

  1. First, place Grail plugin contents in the Plugins directory.

  2. Open the Source/YourProjectName/YourProjectName.Build.cs file

  3. Modify it in the following way:

    using UnrealBuildTool;
    using System.IO;
    
    public class YourProjectName : ModuleRules
    {
      public YourProjectName(ReadOnlyTargetRules Target) : base(Target)
      {
        ///... your standard UE build system settings ...
        //Add this line
            PublicDependencyModuleNames.Add("Grail");
      }
    }
  4. Generate Visual Studio project files and voila!

The detailed documentation for Unreal plugin can be found here.