要启动并运行Epic在线服务(EOS),请将EOS SDK与你的游戏集成,以便你的游戏可以访问EOS服务。为此,你需要执行以下操作:
- 在开发人员门户中设置Epic Games账号和组织。
- 下载EOS SDK(C和C#语言版本可用)。
- 将平台接口集成到你的游戏中。
本文档将指导你如何执行此操作并介绍SDK下载包附带的示例代码。
Epic Games随附SDK下载包提供了示例代码。此处列示的介绍资料包含Epic开发人员资源和Epic在线服务(EOS)的概述、介绍博客、常见问题解答,以及虚幻引擎和Unity的EOS游戏引擎插件的部分相关信息。请参阅简介资源页面,了解更多信息。
入门步骤
开始之前 - 系统要求
请参阅系统要求页面,了解对你的开发环境和游戏客户端运行时环境的系统要求。
第1步 - 设置Epic Games账号和组织
你需要使用开发人员门户(dev.epicgames.com/portal)设置你的游戏,以使用EOS服务、配置服务以及访问SDK下载。
在开发人员门户中,你需要将自己的Epic Games账号与某个“组织”关联,该组织是你所属的公司或企业。每个游戏都称为一个“产品”。一个组织可以有多个产品。
每个游戏(开发人员门户中的 产品 )都有:
- 一个产品ID ——你的游戏的唯一标识符。
- 一个或多个沙盒ID ——与你的游戏的实现对应的不同具名环境。 使用示例:你有三个不同的沙盒,用于隔开游戏实现的开发、测试和生产版本。
每个沙盒都有:
- 一个或多个部署ID ——沙盒内你的游戏实现的不同迭代。 使用示例:你的测试沙盒中的每个部署都是Beta测试版本或发布候选版本,而你的生产沙盒中的每个部署都是发布版本。
EOS SDK会使用它们向EOS服务表明游戏的身份。
请参阅有关产品、沙盒和部署ID的文档,详细了解如何在设置账号时使用产品管理工具。
第2步 - 下载EOS SDK
在开发人员门户中设置你的组织和产品后,就可以从开发人员门户下载EOS SDK。
要获得SDK下载包,请在开发人员门户主页上点击 下载SDK(Download SDK) 。
EOS SDK下载类型
根据运行你的游戏客户端的平台,有不同类型的SDK下载包可供使用:
- Windows、macOS、Linux ——C语言版本EOS SDK和C#语言版本EOS SDK。
- 移动端(Mobile) ——iOS版EOS SDK和Android版EOS SDK。
- 主机端(Consoles) ——这些是适用于游戏主机的C语言和C#语言版本EOS SDK下载包。
主机端的SDK下载仅提供给那些通过平台持有者和Epic Games批准的开发人员。
平台持有者是指:微软(Xbox One、Xbox Series X)、索尼(PlayStation 4、PlayStation 5)、任天堂(Switch)。
如需下载主机版本的SDK并获得相关文档:- 前往开发者门户网站dev.epicgames.com/portal,点击 SDK & RELEASE NOTES,然后在底部点击 申请权限(Request access),获取平台所有者发布的有关申请控制台开发者访问权限的指南。
- 获得平台持有者批准后,你可以使用 Epic在线服务主机开发人员申请 表格向Epic Games提交申请,该表格位于eoshelp.epicgames.com。
EOS SDK下载包的内容
EOS SDK下载包具有以下目录:
目录 | 内容 | ||
/Samples | 演示EOS SDK工作方式的示例实现。 | ||
/SDK | 你在游戏代码中用于将EOS SDK与游戏集成以便游戏可以使用EOS服务的库和头文件。 | ||
/ThirdPartyNotices | 有关支持库的法律信息。 |
示例
我们建议查看示例目录,该目录演示了平台的一些功能。请参阅以下文档,了解有关这些示例的更多信息:
- 身份验证和好友示例
- 会话匹配示例
- 大厅示例
- P2P NAT示例
- 玩家数据存储示例
- 作品存储示例
- 排行榜示例
- 商城示例
- Mod示例
- 使用Android SDK示例
- 使用C# SDK示例
- 使用iOS SDK示例
EOS SDK更多信息
可在以下文档中找到有关使用EOS SDK的更多信息:
- 如需了解接口句柄、命名规范和错误处理以及其他关键信息,请参阅:EOS SDK关键信息。
- C#语言版本EOS SDK与C语言版本EOS SDK在实现上存在一些差异。如果你使用的是C#语言版本并使用Unity进行游戏开发,另请参阅:C#版本EOS SDK。
第3步 - 集成平台接口
要在你的游戏中使用EOS服务,你需要集成接口。每个服务都有一个接口。
你集成到游戏中的第一个接口是平台接口。它容纳你访问所有其他接口并使它们保持运行所需的句柄:当你的游戏启动时,你需要初始化SDK并获得平台接口的句柄。
在平台接口文档中了解这方面的更多信息。
**注意:**平台接口与运行你的游戏客户端的游戏平台不同。文档将这些游戏平台称为“EOS的平台实现”。
支持
你可以使用Epic开发人员资源支持社区eoshelp.epicgames.com提出问题、获得支持并成为Epic开发人员资源社区的一员。
支持覆盖以下范围:
- 开发人员门户
- Epic Games商城
- Epic在线服务(EOS)
- 儿童网络服务(KWS)
新功能
参阅以下文档,即时了解新功能:
你可以访问trello.com/~/eos-public-roadmap,了解EOS路线图上正在开发的功能。