kagura — Unreal Engine Integration

Applies kagura obfuscation to UE native code (C++) for Android and iOS shipping builds.

Prerequisites

• Unreal Engine 5.1 or later
• kagura built: run bash build.sh from the repo root
• Build targets: Android or iOS (Shipping configuration)

Installation

1. Add the UBT toolchain

Copy KaguraToolchain.cs to your project or engine:

YourProject/
  Source/
    Programs/
      UnrealBuildTool/
        KaguraToolchain.cs   ← here

Or for an engine-wide install:

Engine/Source/Programs/UnrealBuildTool/Platform/Android/KaguraToolchain.cs

2. Add the module build rules (optional, for runtime linking)

Copy KaguraObfuscation.Build.cs to your project's Source/ThirdParty/ directory and add the module to your game module's .Build.cs:

// YourGame.Build.cs
PublicDependencyModuleNames.AddRange(new string[] {
    "Core", "CoreUObject", "Engine",
    "KaguraObfuscation"   // ← add this
});

3. Set environment variables

export KAGURA_PLUGIN_PATH=/path/to/build/lib/Transforms/KaguraObfuscator.dylib
export KAGURA_RUNTIME_LIB=/path/to/build/runtime/libkagura_runtime.a

Or edit the defaults in KaguraConfig inside KaguraToolchain.cs.

4. Activate in your Target.cs

// YourGameTarget.cs
public class YourGameTarget : TargetRules
{
    public YourGameTarget(TargetInfo Target) : base(Target)
    {
        Type = TargetType.Game;
        // kagura toolchain is activated automatically for Android/iOS Shipping
        // when KaguraToolchain.cs is present in the UBT search path.
    }
}

Configuration

Edit KaguraConfig in KaguraToolchain.cs, or point to a JSON config file:

public static class KaguraConfig
{
    public static string ConfigFile    = "";        // path to kagura.json (optional)
    public static string Profile       = "BALANCED"; // FAST | BALANCED | STRONG
    public static bool   EnableStr     = true;
    public static bool   EnableWstr    = true;
    public static bool   EnableFla     = true;
    public static bool   EnableBcf     = true;
    public static bool   EnableSub     = true;
    public static bool   EnableGenc    = false;
    public static bool   EnableMvo     = false;
    public static bool   EnableHoney   = false;
    public static bool   EnableTamper  = true;
    public static bool   EnableSymMap  = false;
    public static bool   ShippingOnly  = true;   // only apply for Shipping builds
    public static int    BcfProb       = 30;
    public static int    BcfIter       = 1;
    // ... see file for full list
}

JSON config (recommended for team projects):

{ "profile": "STRONG" }

Point to the config file via KAGURA_CONFIG_PATH environment variable or by setting KaguraConfig.ConfigFile before build start.

Game Value Protection

For C++ gameplay code, use game_protect.h to protect values from memory scanners and freeze tools:

#include "kagura/game_protect.h"

UCLASS()
class AMyCharacter : public ACharacter
{
    kagura::Protected<int>   HP{100};
    kagura::Protected<float> MoveSpeed{600.f};
};

Pass reference

See the Passes reference for the full pass list and options.

Build verification

After building, run:

nm -D YourGame.so | grep "your_sensitive_symbol"

With -kagura-sv enabled, internal symbols should not appear in the dynamic symbol table.