Skip to main content

Overview

The TikToolLive Unreal Engine plugin brings real-time TikTok Live events directly into your UE5 project. Build interactive games controlled by live stream viewers — chat-driven gameplay, gift-triggered effects, battle minigames, and more.

Installation

  1. Download the plugin from the TikTool Dashboard
  2. Extract to your project’s Plugins/ directory
  3. Enable the plugin in your .uproject file or via Edit → Plugins

Quick Start (C++)

#include "TikToolLiveSubsystem.h"

void AMyChatActor::BeginPlay()
{
    Super::BeginPlay();
    auto* TikTool = GetGameInstance()->GetSubsystem<UTikToolLiveSubsystem>();
    if (!TikTool) return;

    // Bind to chat events
    TikTool->OnChatEvent.AddDynamic(this, &AMyChatActor::HandleChat);
    TikTool->OnGiftEvent.AddDynamic(this, &AMyChatActor::HandleGift);

    // Connect (uses DefaultUniqueId from Project Settings)
    TikTool->Connect();
}

void AMyChatActor::HandleChat(const FTikToolChatEvent& Event)
{
    UE_LOG(LogTemp, Log, TEXT("%s: %s"),
        *Event.User.Nickname, *Event.Comment);
}

void AMyChatActor::HandleGift(const FTikToolGiftEvent& Event)
{
    UE_LOG(LogTemp, Log, TEXT("%s sent %s x%d"),
        *Event.User.Nickname, *Event.GiftName, Event.RepeatCount);
}

Available Delegates

DelegateEvent StructDescription
OnChatEventFTikToolChatEventChat messages
OnGiftEventFTikToolGiftEventVirtual gifts
OnLikeEventFTikToolLikeEventLikes
OnMemberEventFTikToolMemberEventViewer joins
OnFollowEventFTikToolFollowEventNew followers
OnViewerCountEventFTikToolViewerCountEventViewer count updates
OnBattleEventFTikToolBattleEventBattle status updates
OnConnectedConnection established
OnDisconnectedConnection lost

Project Settings

Configure the plugin in Project Settings → TikToolLive:
SettingDescription
API KeyYour TikTool API key
Default UniqueIdTikTok username to connect to by default
Auto ConnectConnect automatically on game start
Auto ReconnectReconnect on disconnection

Use Cases

  • Chat-driven games — Viewers vote or control game elements via chat commands
  • Gift effects — Trigger visual effects, spawn items, or buff players when gifts are sent
  • Battle minigames — Create competitive games synced with TikTok’s battle system
  • Leaderboards — Display top gifters and most active viewers in-game
  • Crowd control — Let viewers influence the game world in real-time