Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.cometchat.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Beta Release — The CometChat Unreal SDK is currently in beta. APIs and features may change, and you may encounter stability issues.
This guide walks you through integrating CometChat into an Unreal Engine 5 project. The SDK ships as a native UE5 plugin with full Blueprint and C++ support — so whether you’re wiring up a quick prototype in the visual graph or building a production multiplayer title in code, you’re covered.
Before you begin, we recommend reading the Key Concepts page to understand the architecture.

​
Supported Platforms

PlatformStatus
Windows (Win64)✅ Supported
macOS✅ Supported
iOS✅ Supported
Android✅ Supported

​
Minimum Requirements

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

​
Quick Start

Get up and running in five steps:
1

Get your Application Keys

Sign up for CometChat, create a new app, and note your App ID, Auth Key, and Region.
2

Install the Plugin

Copy the CometChat plugin into your project’s Plugins/ directory. See Setup for details.
3

Configure the SDK

Call Configure on the CometChatSubsystem with your App ID and Region.
4

Log In

Use the Login Async node with a user UID and Auth Key.
5

Send a Message

Use the Send Message Async node to send your first message.

​
Architecture

The plugin has three layers:
  • UCometChatSubsystem — A UGameInstanceSubsystem that owns the SDK lifecycle. Access it from any Actor or Widget.
  • Latent Async Nodes — Blueprint-friendly async actions with Success and Failure output pins.
  • Real-Time Delegates — Multicast delegates on the Subsystem for push events. All fire on the Game Thread.

​
How It Works in Blueprints

  1. Get the Subsystem — Get Game Instance → Get Subsystem → CometChatSubsystem
  2. Configure — Pass your App ID and Region once
  3. Bind Delegates — Wire up OnMessageReceived and other events before Login
  4. Async Nodes — Every operation has On Success and On Failure exec pins
  5. Real-Time Events — Incoming messages and presence updates arrive automatically via delegates
All callbacks fire on the Game Thread — safe to update UI directly.

​
What’s Included

CategoryCapabilities
AuthenticationLogin with Auth Key, Login with Auth Token, Logout, session check
MessagingSend & receive text messages (1:1 and group), message history with pagination
UsersFetch user profiles, real-time presence
GroupsCreate, join, leave groups, group messaging
Real-Time EventsMessage received, presence changed, typing indicators, read receipts, connection state

​
Sample Users

CometChat provides 5 pre-created users for testing:
UIDName
cometchat-uid-1Andrew Joseph
cometchat-uid-2George Alan
cometchat-uid-3Nancy Grace
cometchat-uid-4Susan Marie
cometchat-uid-5Peter Reed

​
Next Steps

Setup

Install the plugin and configure your project.

Key Concepts

Understand the Subsystem, async nodes, and event model.

Authentication

Log users in and manage sessions.

Send a Message

Send your first text message.