Skip to content

Commit f979d06

Browse files
chore:
-Removed Linux from supported platforms -Changed minimum requirement from UE 5.3 to UE 5.5.4 or 5.7.2 -Changed "C++17 compatible compiler" to "C++ development tools for your platform" -Added Login with Auth Token to the Authentication capabilities table
1 parent cf9edde commit f979d06

2 files changed

Lines changed: 85 additions & 29 deletions

File tree

sdk/unreal/overview.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,15 @@ Before you begin, we recommend reading the [Key Concepts](/sdk/unreal/key-concep
2525
| -------- | ------ |
2626
| Windows (Win64) | ✅ Supported |
2727
| macOS | ✅ Supported |
28-
| Linux | ✅ Supported |
2928
| iOS | ✅ Supported |
3029
| Android | ✅ Supported |
3130

3231
---
3332

3433
## Minimum Requirements
3534

36-
- Unreal Engine **5.3** or higher
37-
- C++17 compatible compiler
35+
- Unreal Engine **5.5.4** or **5.7.2**
36+
- C++ development tools for your platform
3837
- [CometChat account](https://app.cometchat.com) with **App ID**, **Region**, and **Auth Key**
3938

4039
---
@@ -137,7 +136,7 @@ All callbacks fire on the **Game Thread** — safe to update UI directly.
137136

138137
| Category | Capabilities |
139138
| -------- | ------------ |
140-
| **Authentication** | Login, Logout, session check |
139+
| **Authentication** | Login with Auth Key, Login with Auth Token, Logout, session check |
141140
| **Messaging** | Send & receive text messages (1:1 and group), message history with pagination |
142141
| **Users** | Fetch user profiles, real-time presence |
143142
| **Groups** | Create, join, leave groups, group messaging |

sdk/unreal/setup.mdx

Lines changed: 82 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,78 @@ description: "Install the CometChat plugin in your Unreal Engine project."
1010
1. Create a new app
1111
2. Head over to the **API & Auth Keys** section and note the **Auth Key**, **App ID**, and **Region**
1212

13+
---
14+
15+
## Prerequisites
16+
1317
<Tip>
1418
**Minimum Requirements**
1519

16-
- Unreal Engine **5.3** or higher
17-
- C++17 compatible compiler
18-
- Windows (Win64), macOS, Linux, iOS, or Android target
20+
- Unreal Engine **5.5.4** or **5.7.2**
21+
- C++ development tools for your platform
22+
- CometChat account with App ID, Auth Key, and Region
1923
</Tip>
2024

25+
### Supported Platforms
26+
27+
| Engine Version | Platforms |
28+
| -------------- | --------- |
29+
| UE 5.5.4 | Mac, Windows |
30+
| UE 5.7.2 | Mac |
31+
2132
---
2233

2334
## Install the Plugin
2435

25-
### Option 1: Pre-built Plugin (Recommended)
36+
### Option 1: Use Precompiled Binaries (No Build Required)
2637

27-
Copy the `CometChat` plugin folder into your project's `Plugins/` directory:
38+
<Steps>
39+
<Step title="Copy the plugin source">
40+
Copy `Plugins/CometChatSdk/` from the [SDK repository](https://github.com/cometchat/chat-sdk-unreal/tree/v1) into your project's `Plugins/CometChat/` directory.
41+
</Step>
42+
43+
<Step title="Download precompiled binaries">
44+
Download the precompiled binaries for your engine version:
45+
46+
<Tabs>
47+
<Tab title="UE 5.5.4 (Mac + Windows)">
48+
```bash
49+
curl -1sLf -O 'https://dl.cloudsmith.io/public/cometchat/cometchat/raw/versions/v1.0.0-beta.1/CometChat-UE5.5.4-precompiled.zip'
50+
```
51+
</Tab>
52+
<Tab title="UE 5.7.2 (Mac)">
53+
```bash
54+
curl -1sLf -O 'https://dl.cloudsmith.io/public/cometchat/cometchat/raw/versions/v1.0.0-beta.1/CometChat-UE5.7.2-precompiled.zip'
55+
```
56+
</Tab>
57+
</Tabs>
58+
</Step>
59+
60+
<Step title="Extract into your plugin directory">
61+
Extract the zip contents into your project's `Plugins/CometChat/` directory (merging with existing files).
62+
</Step>
63+
64+
<Step title="Enable the plugin">
65+
Add the plugin to your `.uproject` file:
66+
67+
```json
68+
{
69+
"Plugins": [
70+
{
71+
"Name": "CometChat",
72+
"Enabled": true
73+
}
74+
]
75+
}
76+
```
77+
</Step>
78+
79+
<Step title="Open your project">
80+
Open your project in Unreal Editor — no compilation needed.
81+
</Step>
82+
</Steps>
83+
84+
Your project structure should look like this:
2885

2986
```
3087
YourProject/
@@ -33,29 +90,17 @@ YourProject/
3390
│ ├── CometChat.uplugin
3491
│ ├── Source/
3592
│ ├── Config/
36-
│ └── ThirdParty/
93+
│ └── ThirdParty/chatsdk/ ← Prebuilt static libraries (all platforms)
3794
├── Source/
3895
└── YourProject.uproject
3996
```
4097

41-
Then regenerate your project files:
98+
---
4299

43-
<Tabs>
44-
<Tab title="macOS">
45-
```bash
46-
# From your project root
47-
/Users/Shared/Epic\ Games/UE_5.4/Engine/Build/BatchFiles/Mac/GenerateProjectFiles.sh \
48-
-project="$(pwd)/YourProject.uproject" -game -engine
49-
```
50-
</Tab>
51-
<Tab title="Windows">
52-
```powershell
53-
# From your project root
54-
& "C:\Program Files\Epic Games\UE_5.4\Engine\Build\BatchFiles\GenerateProjectFiles.bat" ^
55-
-project="%cd%\YourProject.uproject" -game -engine
56-
```
57-
</Tab>
58-
</Tabs>
100+
### Option 2: Build from Source
101+
102+
1. Copy `Plugins/CometChatSdk/` from the [SDK repository](https://github.com/cometchat/chat-sdk-unreal/tree/v1) into your project's `Plugins/CometChat/` directory
103+
2. Regenerate project files and build
59104

60105
---
61106

@@ -87,11 +132,11 @@ public class YourGame : ModuleRules
87132

88133
## Verify the Plugin
89134

90-
After regenerating project files and building:
135+
After installation:
91136

92137
1. Open your project in the Unreal Editor
93138
2. Go to **Edit → Plugins**
94-
3. Search for **CometChat** — it should appear under the **Networking** category and be enabled
139+
3. Search for **CometChat** — it should appear and be enabled
95140

96141
<Info>
97142
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**.
136181

137182
---
138183

184+
## Plugin Architecture
185+
186+
The plugin provides:
187+
188+
- **`UCometChatSubsystem`** — Game instance subsystem for CometChat operations
189+
- **Async Blueprint actions** — for login, logout, send message, fetch messages, groups
190+
- **`CometChatEventBridge`** — Real-time event callbacks
191+
- **`CometChatGroupChatBox`** — Ready-to-use group chat UI widget
192+
- **Native C++ chat SDK** via `ThirdParty/chatsdk/` (prebuilt static libraries)
193+
194+
---
195+
139196
## Next Steps
140197

141198
Now that the plugin is installed and configured, head to [Authentication](/sdk/unreal/authentication) to log in your first user.

0 commit comments

Comments
 (0)