Kinetix Documentation
Website
  • đŸ–ī¸Welcome
  • đŸ•ēAbout Kinetix
  • đŸ–Œī¸User-Generated Emote
    • 🤖Video-to-animation AI
    • 🤸Kinetix Emote Standards
    • đŸĻ´Retargeting
    • 🏂Kinanim (Emote streaming)
    • đŸ–Šī¸Try the User-Generated Emote feature
  • INTEGRATION
    • 🤷SDK or API: what to choose
    • 🤩Kinetix SDK
      • âš™ī¸SDK - Core Package
      • 🧩SDK - Sample scene
      • 🧑‍đŸ’ģTested & approved Game Engines for the SDK
      • đŸ’ģSDK Integration in Unity
        • âŦ‡ī¸Set-up Unity & Import the SDK
          • 🔑Get your Game authentification API Key
          • âš™ī¸Setup your Unity environment
          • 🔧Install the Kinetix SDK in Unity
          • âŒ¨ī¸SDK Initialization - Unity
        • ⚡Quickstart - Unity SDK
        • đŸĻ‹SDK Core Modules activation - Unity
          • 🔐Account Management in Unity
          • 💃Animation System - Unity
            • đŸŽĸUnity's Animator System
            • 🎨Custom Animation System
            • đŸŒŗRoot Motion
              • RootMotion + NavMeshAgent
            • đŸŽžī¸Frame Controller
            • đŸ’ĒIK Controller
            • đŸĢĨAvatar Mask
          • đŸ“ļNetwork - Unity SDK
            • Photon PUN
            • Photon Fusion
        • đŸ•ēUser-Generated Emote integration (Unity)
          • Embedding the PWA in your Unity application
          • Validation / Retake
        • 🚧How to update Kinetix SDK in Unity?
        • 📕SDK API Reference - Unity
          • KinetixCore
          • KinetixCore.Account
          • KinetixCore.Animation
          • KinetixCore.Metadata
          • KinetixCore.Network
          • KinetixCore.UGC
        • 📂Unity SDK Changelog
      • đŸ•šī¸SDK Integration in Unreal Engine
        • âŦ‡ī¸Set-up Unreal Engine & Download the SDK
          • 🔑Get your Game authentification API Key
          • âš™ī¸Set up your Unreal Engine environment
          • 🔧Install the Kinetix SDK in Unreal
          • âŒ¨ī¸UE SDK Core Package Initialization
        • ⚡Quick Start
        • đŸĻ‹SDK Core Modules activation - Unreal
          • 🔐Account Management - UE
          • 💃Animation System - UE
            • Local player system in Unreal Engine
            • Avatar system in Unreal Engine
            • Without uploading an avatar (deprecated)
              • Animation in a Third Person Template
              • Animation in an existing project
          • đŸ“ļNetwork - UE SDK
        • đŸ•ēUser-Generated Emote integration (UE)
        • 📕SDK API Reference - UE
          • KinetixCore
          • KinetixCore.Account
          • KinetixCore.Animation
          • KinetixCore.Metadata
          • KinetixCore.Network
        • âŦ†ī¸Updating from 0.3 to 0.4
        • 📂UE SDK Changelog
    • 😍Kinetix API
      • 🔑Get your Authentification API key
      • 🔌API routes
      • đŸĒAPI Webhooks
      • 🏓Possible Return Codes
  • Management
    • đŸšĒDeveloper Portal
      • đŸ‘ŊAvatar Upload
      • 👮UGC Moderation
    • đŸ–Œī¸UGE: Guides & Best Practices
      • 📐User-Generated Emote specifications
      • 👌Video recording best practices
      • đŸ‘ģUser-Generate Emote Use Cases
  • SUPPORT
    • đŸ“ŦBugs reports & features requests
    • ❓FAQ
      • FAQ: General questions
      • FAQ: Unity SDK
      • FAQ: Unreal Engine SDK
    • 🤕Troubleshooting
    • 📚Glossary of terms
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. INTEGRATION
  2. Kinetix SDK
  3. SDK Integration in Unreal Engine
  4. Set-up Unreal Engine & Download the SDK

UE SDK Core Package Initialization

Initialize the Kinetix Unreal SDK

PreviousInstall the Kinetix SDK in UnrealNextQuick Start

Last updated 3 months ago

Was this helpful?

The initialization of the Kinetix SDK should only be done ONCE when the app starts.

You can initialize the SDK with parameters in the KinetixCoreConfiguration available in Edit -> Project Settings -> Game -> Kinetix Settings.

  • EnableAnalytics => true if you want to help us improve our SDK by sharing usage data.

  • ShowLogs => true if you want to log the behavior of the SDK for debug purposes.

  • Cached Emotes => Number of emotes to save on disk for bandwidth saving. Value must be higher than 0 (we recommend 255)

  • Game API Key => Here is the field where you insert the Game API Key you got from .

Make sure to set the cached emote setting above 0

You can use this circuit to initialize the SDK, before proceeding to the next steps to connect a user and register a player component. To start mapping, click on Content Drawer > Blueprints > BP_ThirdPerson Character.

USampleObject::USampleObject()
{
	UKinetixCoreSubsystem* KinetixCore =
		GetWorld()->GetGameInstance()->GetSubsystem<UKinetixCoreSubsystem>();

	FKinetixCoreInitializedDelegate Callback;
	Callback.BindDynamic(this, &USampleObject::OnKinetixCoreInitialized);
	KinetixCore->RegisterOrCallOnInitialized(Callback);

	FKinetixCoreConfiguration CoreConfiguration;
	UKinetixDeveloperSettings::GetCoreConfiguration(CoreConfiguration);
	KinetixCore->Setup(CoreConfiguration);
}

// This callback is used for the actions made after the SDK is initialized
// Such as initializing the UI and Registering our LocalPlayer's AnimInstance
void USampleObject::OnKinetixCoreInitialized()
{
	UKinetixCoreSubsystem* KinetixCore =
		GetWorld()->GetGameInstance()->GetSubsystem<UKinetixCoreSubsystem>();

	// Register local player to receive animation
	// See "Animation System" documentation
	KinetixCore->KinetixAnimation->RegisterLocalPlayerAnimInstance(MyAnimInstance);

	// Now, we connect the current user's account to get his emotes
	// The userID is chosen by you, and must be unique to each user
	// See "Account Management" documentation
	KinetixCore->KinetixAccount->OnConnectedAccount.AddDynamic(this, USampleObject::OnKinetixAccountConnected);
	KinetixCore->KinetixAccount->ConnectAccount(MyUserID);
}

void USampleObject::OnKinetixAccountConnected()
{
	UE_LOG(LogTemp, Log, TEXT("Account connected !"));
}
🤩
đŸ•šī¸
âŦ‡ī¸
âŒ¨ī¸
Developer Portal