Skip to content

TencentCloud/chat-plugin-ue5

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

腾讯云IM UE5 Plugin集成

注意
  1. 引入插件且编译成功后再加入API调用测试代码
  2. 此插件只能在ue 模块中集成
步骤一 在腾讯云IM 控制台创建应用

登录到腾讯云IM控制台,如图所示创建IM应用:

image-20220912133828217

在应用基础信息页面,记录应用sdkappid和密钥,在后续使用初始化登录接口时会用到。

步骤二 安装UE5,并创建新项目

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

image-20220912134459287

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

其中项目默认设置中蓝图和C++、目标平台的配置,可根据业务方自己的需求进行配置,腾讯云IM UE5 Plugin对此没有限制。

创建好后应用后,项目目录如图所示:

image-20220912135806412

步骤三 下载Plugin
// 将插件从GitHub下来
git clone https://github.com/TencentCloud/chat-plugin-ue5.git
步骤四 Plugin引入

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

image-20230228143510351

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

步骤五 头文件引入

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

步骤六 测试验证

验证代码如图所示:

image-20230228143650915

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

在UE5控制台中见到如下日志,代表plugin集成成功:

image-20220912143743846

image-20220912143819779

相关文档

API文档

UE5官方文档

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

Releases

No releases published

Packages

No packages published