Setup

Get your Application Keys

Create a new app
Head over to the API & Auth Keys section and note the Auth Key, App ID, and Region

Prerequisites

Minimum Requirements

Unreal Engine 5.5.4 or 5.7.2
C++ development tools for your platform
CometChat account with App ID, Auth Key, and Region

Supported Platforms

Engine Version	Platforms
UE 5.5.4	Mac, Windows
UE 5.7.2	Mac

Install the Plugin

Option 1: Use Precompiled Binaries (No Build Required)

Copy the plugin source

Copy Plugins/CometChatSdk/ from the SDK repository into your project’s Plugins/CometChat/ directory.

Download precompiled binaries

Download the precompiled binaries for your engine version:

UE 5.5.4 (Mac + Windows)
UE 5.7.2 (Mac)

curl -1sLf -O 'https://dl.cloudsmith.io/public/cometchat/cometchat/raw/versions/v1.0.0-beta.1/CometChat-UE5.5.4-precompiled.zip'

curl -1sLf -O 'https://dl.cloudsmith.io/public/cometchat/cometchat/raw/versions/v1.0.0-beta.1/CometChat-UE5.7.2-precompiled.zip'

Extract into your plugin directory

Extract the zip contents into your project’s Plugins/CometChat/ directory (merging with existing files).

Enable the plugin

Add the plugin to your .uproject file:

{
  "Plugins": [
    {
      "Name": "CometChat",
      "Enabled": true
    }
  ]
}

Open your project

Open your project in Unreal Editor — no compilation needed.

Your project structure should look like this:

YourProject/
├── Plugins/
│   └── CometChat/
│       ├── CometChat.uplugin
│       ├── Source/
│       ├── Config/
│       └── ThirdParty/chatsdk/    ← Prebuilt static libraries (all platforms)
├── Source/
└── YourProject.uproject

Option 2: Build from Source

Copy Plugins/CometChatSdk/ from the SDK repository into your project’s Plugins/CometChat/ directory
Regenerate project files and build

Add Module Dependency

In your game module’s .Build.cs file, add the CometChat module as a dependency:

using UnrealBuildTool;

public class YourGame : ModuleRules
{
    public YourGame(ReadOnlyTargetRules Target) : base(Target)
    {
        PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;

        PublicDependencyModuleNames.AddRange(new string[]
        {
            "Core",
            "CoreUObject",
            "Engine",
            "CometChat"   // Add this line
        });
    }
}

Verify the Plugin

After installation:

Open your project in the Unreal Editor
Go to Edit → Plugins
Search for CometChat — it should appear and be enabled

The plugin loads at the PreDefault phase, so it’s available before your game module initializes.

Initialize CometChat

The CometChatSubsystem is a UGameInstanceSubsystem — it’s created automatically when your game starts. You just need to call Configure with your App ID and Region before using any other SDK methods.

Blueprint
C++

In any Blueprint, get a reference to the CometChat Subsystem via Get Game Instance → Get Subsystem → select CometChatSubsystem
Call the Configure node with your App ID and Region

Parameter	Type	Description
App Id	`FString`	Your CometChat App ID
Region	`FString`	Your app region (`us` or `eu`)

#include "CometChatSubsystem.h"

void AMyActor::BeginPlay()
{
    Super::BeginPlay();

    UCometChatSubsystem* Chat = GetGameInstance()->GetSubsystem<UCometChatSubsystem>();
    Chat->Configure(TEXT("YOUR_APP_ID"), TEXT("us"));
}

Configure must be called before Login. Calling Login without configuring first will result in a failure callback.

Make sure you replace YOUR_APP_ID with your actual CometChat App ID.

Plugin Architecture

The plugin provides:

UCometChatSubsystem — Game instance subsystem for CometChat operations
Async Blueprint actions — for login, logout, send message, fetch messages, groups
CometChatEventBridge — Real-time event callbacks
CometChatGroupChatBox — Ready-to-use group chat UI widget
Native C++ chat SDK via ThirdParty/chatsdk/ (prebuilt static libraries)

Next Steps

Now that the plugin is installed and configured, head to Authentication to log in your first user.

Authentication

Messaging

Users & Groups

Reference

Get your Application Keys

Prerequisites

Supported Platforms

Install the Plugin

Option 1: Use Precompiled Binaries (No Build Required)

Option 2: Build from Source

Add Module Dependency

Verify the Plugin

Initialize CometChat

Plugin Architecture

Next Steps

​Get your Application Keys

​Prerequisites

​Supported Platforms

​Install the Plugin

​Option 1: Use Precompiled Binaries (No Build Required)

​Option 2: Build from Source

​Add Module Dependency

​Verify the Plugin

​Initialize CometChat

​Plugin Architecture

​Next Steps

Get your Application Keys

Prerequisites

Supported Platforms

Install the Plugin

Option 1: Use Precompiled Binaries (No Build Required)

Option 2: Build from Source

Add Module Dependency

Verify the Plugin

Initialize CometChat

Plugin Architecture

Next Steps