diff --git a/sdk/unreal/overview.mdx b/sdk/unreal/overview.mdx index a3dc2b800..269f7d238 100644 --- a/sdk/unreal/overview.mdx +++ b/sdk/unreal/overview.mdx @@ -25,7 +25,6 @@ Before you begin, we recommend reading the [Key Concepts](/sdk/unreal/key-concep | -------- | ------ | | Windows (Win64) | ✅ Supported | | macOS | ✅ Supported | -| Linux | ✅ Supported | | iOS | ✅ Supported | | Android | ✅ Supported | @@ -33,8 +32,8 @@ Before you begin, we recommend reading the [Key Concepts](/sdk/unreal/key-concep ## Minimum Requirements -- Unreal Engine **5.3** or higher -- C++17 compatible compiler +- Unreal Engine **5.5.4** or **5.7.2** +- C++ development tools for your platform - [CometChat account](https://app.cometchat.com) with **App ID**, **Region**, and **Auth Key** --- @@ -137,7 +136,7 @@ All callbacks fire on the **Game Thread** — safe to update UI directly. | Category | Capabilities | | -------- | ------------ | -| **Authentication** | Login, Logout, session check | +| **Authentication** | Login with Auth Key, Login with Auth Token, Logout, session check | | **Messaging** | Send & receive text messages (1:1 and group), message history with pagination | | **Users** | Fetch user profiles, real-time presence | | **Groups** | Create, join, leave groups, group messaging | diff --git a/sdk/unreal/setup.mdx b/sdk/unreal/setup.mdx index 12168bc56..bb9e774ec 100644 --- a/sdk/unreal/setup.mdx +++ b/sdk/unreal/setup.mdx @@ -10,21 +10,78 @@ description: "Install the CometChat plugin in your Unreal Engine project." 1. Create a new app 2. Head over to the **API & Auth Keys** section and note the **Auth Key**, **App ID**, and **Region** +--- + +## Prerequisites + **Minimum Requirements** -- Unreal Engine **5.3** or higher -- C++17 compatible compiler -- Windows (Win64), macOS, Linux, iOS, or Android target +- 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: Pre-built Plugin (Recommended) +### Option 1: Use Precompiled Binaries (No Build Required) -Copy the `CometChat` plugin folder into your project's `Plugins/` directory: + + +Copy `Plugins/CometChatSdk/` from the [SDK repository](https://github.com/cometchat/chat-sdk-unreal/tree/v1) into your project's `Plugins/CometChat/` directory. + + + +Download the precompiled binaries for your engine version: + + + +```bash +curl -1sLf -O 'https://dl.cloudsmith.io/public/cometchat/cometchat/raw/versions/v1.0.0-beta.1/CometChat-UE5.5.4-precompiled.zip' +``` + + +```bash +curl -1sLf -O 'https://dl.cloudsmith.io/public/cometchat/cometchat/raw/versions/v1.0.0-beta.1/CometChat-UE5.7.2-precompiled.zip' +``` + + + + + +Extract the zip contents into your project's `Plugins/CometChat/` directory (merging with existing files). + + + +Add the plugin to your `.uproject` file: + +```json +{ + "Plugins": [ + { + "Name": "CometChat", + "Enabled": true + } + ] +} +``` + + + +Open your project in Unreal Editor — no compilation needed. + + + +Your project structure should look like this: ``` YourProject/ @@ -33,29 +90,17 @@ YourProject/ │ ├── CometChat.uplugin │ ├── Source/ │ ├── Config/ -│ └── ThirdParty/ +│ └── ThirdParty/chatsdk/ ← Prebuilt static libraries (all platforms) ├── Source/ └── YourProject.uproject ``` -Then regenerate your project files: +--- - - -```bash -# From your project root -/Users/Shared/Epic\ Games/UE_5.4/Engine/Build/BatchFiles/Mac/GenerateProjectFiles.sh \ - -project="$(pwd)/YourProject.uproject" -game -engine -``` - - -```powershell -# From your project root -& "C:\Program Files\Epic Games\UE_5.4\Engine\Build\BatchFiles\GenerateProjectFiles.bat" ^ - -project="%cd%\YourProject.uproject" -game -engine -``` - - +### Option 2: Build from Source + +1. Copy `Plugins/CometChatSdk/` from the [SDK repository](https://github.com/cometchat/chat-sdk-unreal/tree/v1) into your project's `Plugins/CometChat/` directory +2. Regenerate project files and build --- @@ -87,11 +132,11 @@ public class YourGame : ModuleRules ## Verify the Plugin -After regenerating project files and building: +After installation: 1. Open your project in the Unreal Editor 2. Go to **Edit → Plugins** -3. Search for **CometChat** — it should appear under the **Networking** category and be enabled +3. 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. @@ -136,6 +181,18 @@ 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](/sdk/unreal/authentication) to log in your first user.