You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-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
Copy file name to clipboardExpand all lines: sdk/unreal/setup.mdx
+82-25Lines changed: 82 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,21 +10,78 @@ description: "Install the CometChat plugin in your Unreal Engine project."
10
10
1. Create a new app
11
11
2. Head over to the **API & Auth Keys** section and note the **Auth Key**, **App ID**, and **Region**
12
12
13
+
---
14
+
15
+
## Prerequisites
16
+
13
17
<Tip>
14
18
**Minimum Requirements**
15
19
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
19
23
</Tip>
20
24
25
+
### Supported Platforms
26
+
27
+
| Engine Version | Platforms |
28
+
| -------------- | --------- |
29
+
| UE 5.5.4 | Mac, Windows |
30
+
| UE 5.7.2 | Mac |
31
+
21
32
---
22
33
23
34
## Install the Plugin
24
35
25
-
### Option 1: Pre-built Plugin (Recommended)
36
+
### Option 1: Use Precompiled Binaries (No Build Required)
26
37
27
-
Copy the `CometChat` plugin folder into your project's `Plugins/` directory:
38
+
<Steps>
39
+
<Steptitle="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
+
<Steptitle="Download precompiled binaries">
44
+
Download the precompiled binaries for your engine version:
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
59
104
60
105
---
61
106
@@ -87,11 +132,11 @@ public class YourGame : ModuleRules
87
132
88
133
## Verify the Plugin
89
134
90
-
After regenerating project files and building:
135
+
After installation:
91
136
92
137
1. Open your project in the Unreal Editor
93
138
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
95
140
96
141
<Info>
97
142
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**.
136
181
137
182
---
138
183
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
0 commit comments