有奖捉虫:云通信与企业服务文档专题,速来> HOT
本文旨在介绍如何快速将腾讯云即时通信 IM 服务集成进 Unreal Engine 5(虚幻引擎 5,简称 UE5)平台的应用或游戏中。

步骤1:创建应用

说明:
如果您已有应用,请记录其 SDKAppID 和密钥信息, 直接跳到步骤2:安装 UE5 并创建新项目
单个腾讯云账号最多可创建300个应用。若已有300个应用,您可以先 停用并删除 不再使用的应用后,再创建新的应用。应用删除后,该 SDKAppID 对应的所有数据和服务不可恢复,请谨慎操作。
2. 应用管理页面,单击创建新应用,在弹出的对话框中输入应用名称,选择合适的数据中心,单击确定



3. 创建完成后,可在应用管理页面查看、搜索、管理应用。请记录 SDKAppID 和密钥信息,在后续使用初始化登录接口时将会用到。


注意:
密钥信息为敏感信息,为防止他人盗用,请妥善保管,谨防泄露。

步骤2:安装 UE5 并创建新项目

1. 安装 Epic Games Luncher,并且通过 Epic 安装 Unreal Engine 5.0.0+版本,安装好如图所示:


2. 启动 UE5,创建 UE5 应用,如图所示:

其中项目默认设置中蓝图和 C++、目标平台的配置,可根据业务方自己的需求进行配置,腾讯云 IM UE5 Plugin 对此没有限制。
3. 创建好应用后,项目目录如图所示:




步骤3:下载 Plugin

// 将插件从GitHub下来
git clone https://github.com/TencentCloud/chat-plugin-ue5.git

步骤4: Plugin 引入

在项目根目录创建插件目录,命名问 Plugins,将步骤三中下载的插件包(Plugins/下的 TencentCoudChat 文件夹)引入其中,引入后可在 UE5 Editor 的编辑 > 插件模块查看到如图所示插件安装:


插件引入后,在项目主模块中的 Build.cs 文件中,引入插件模块,如图所示:



步骤5:头文件引入

在业务 CPP 文件中引入 TencentCloudChat.h 后,开始使用腾讯云 IM UE5 Plugin 提供的能力。

步骤6:测试验证

验证代码如图所示:



其中初始化用到的 SDKAppID 在步骤一中获得,登录使用到的 UserSig,可在 控制台辅助工具 生成。在生产环境, UserSig 由业务侧后台生成。本篇入门教程只演示了初始化、登录、注册消息监听事件的 API 调用,完整的 API 文档可以查看 此处。UE5 各个平台均集成的是 C++ SDK,且所有接口一致。
在 UE5 控制台中见到如下日志,代表 plugin 集成成功:







可选操作:开通内容审核功能

在消息发送、资料修改场景中,很有可能会扩散不合适的内容,特别是与敏感事件/人物相关、黄色不良内容等令人反感的内容,不仅严重损害了用户们的身心健康,更很有可能违法并导致业务被监管部门查封。
即时通信 IM 支持内容审核(反垃圾信息)功能,可针对不安全、不适宜的内容进行自动识别、处理,为您的产品体验和业务安全保驾护航。可以通过 云端审核 方式来实现。

相关文档

常见问题

1. 在 mac 调试环境,如遇到提示文件已经损坏,可执行如下命令修复:
sudo xattr -r -d com.apple.quarantine $pathToframgeWork
2. 初始化传入的日志和 db 目录,需要应用有读写权限。
3. 插件暂不支持 win32 和 Mac M1 进行调试和编译。

联系我们

点此进入 IM 社群,享有专业工程师的支持,帮助解决您的难题。