You need to enable JavaScript to run this app.
导航
控制台指南
最近更新时间:2024.07.16 20:02:23首次发布时间:2022.09.23 14:17:49

本章节为您介绍在控制台配置管理云游戏端游业务的主要操作。进行控制台操作前,需先完成云游戏服务开通

概览

进入火山引擎云游戏控制台,可通过概览页面查看业务的运行数据、计费详情,生成鉴权密钥等。

数据统计

概览页面展示的运行数据包括:

  • 前一日业务维度的用户游戏总时长、请求总数、用户总数、在线并发峰值,以及较上一周的同比数据;

  • 业务维度的资源订购总量和资源订购走势(包括预付费、后付费和免费资源的数据);

  • 最近一周的带宽用量数据,包括当日带宽峰值和当月带宽 95 峰值。

说明

更多业务运行详细数据,可通过云游戏端游模块下的数据监控看板查询。

计费详情

在概览页面可查看当前账号的计费状态,通过链接打开火山引擎费用中心查看账户总览、管理预付费资源订单或查看后付费资源账单详情。

鉴权密钥

在概览页面可生成临时鉴权密钥,对接入云游戏服务的用户进行鉴权。

说明

在测试接入阶段,可生成临时鉴权密钥体验接入;正式接入云游戏服务时,需要通过调用服务端接口生成正式鉴权密钥。

参考以下步骤生成临时鉴权密钥:

  1. 单击临时鉴权密钥,在弹窗中输入临时鉴权密钥的生效时长,输入火山引擎账号的 Access Key 和 Secret Access Key(可通过火山引擎控制台页面右上角 用户信息 > API访问密钥 获取)。

  2. 单击生成临时密钥,保存生成的临时密钥信息,包括密钥的创建时间、失效时间、临时 Access Key ID、Secret Access Key 和 Session Token。

  3. 下载云游戏客户端 Quick Start 示例文件。在示例代码中,填入生成的临时鉴权密钥参数,即可快速体验云游戏服务。Web/H5 客户端需要填入鉴权密钥的示例代码如下(config.js 文件)。

    // 实例化 veGameSDK 的参数
    const initConfig = {
    userId: '', // 必填参数,开发者可进行自定义,用于标识游戏玩家或账号等
    accountId:'', // 必填参数,火山引擎账号ID,可通过火山引擎官网页面右上角 用户 > 账号管理 > 主账号信息 获取
    mode: window.veGameSDK.MODE.CLOUD_PC, // 如果需要控制云游戏手游,请传 MODE.CLOUD_PHONE_GAME
    isPC: true, // 在桌面应用程序运行SDK
    };
    
    // 调用 veGameSDK.start 的参数
    const startConfig = {
    gameId: '7112633605523xxxxxx', // 游戏ID
    token: {
    	CurrentTime: '2023-10-12T15:37:43+08:00',    // Token创建时间
    	ExpiredTime: '2023-10-19T15:37:43+08:00',    // Token过期时间
    	SessionToken: 'STS2ey......MifQ==',   // 用于鉴权的临时Token
    	AccessKeyID: 'AKTPN......NWE',    // 用于鉴权的临时AccessKey
    	SecretAccessKey: 'vKtZO......P7K' // 用于鉴权的临时SecretKey
    },
    roundId: '', //必填参数,开发者可进行自定义,用于标识当次游戏会话
    rotation: 'landscape', // landscape:横屏启动; portrait:竖屏启动
    };
    
    window.initConfig = initConfig;
    window.startConfig = startConfig;
    
业务管理

进入火山引擎云游戏控制台,在左侧导航栏中选择云端游 > 业务管理。业务为用户在云游戏控制台内购买资源、开展业务的标识。

新建业务

  1. 业务管理页面,单击新建业务,输入业务名称等基本信息,单击确定

  2. 业务创建成功后,新建的业务将显示在业务管理页面。业务卡片展示该业务已订购的资源数量、已上架的游戏数量、业务 ID、业务创建时间。

业务配置

业务管理页面,将鼠标悬停在目标业务的竖向省略号图标上,单击查看详情,即可进入业务配置页面,您可在该页面配置业务的详细信息。

  • 基本信息一栏中,可查看业务的创建时间、业务 ID、业务名称、业务描述。单击编辑,可修改业务名称和描述信息。

  • 回调配置一栏中,单击编辑,然后按业务需要配置回调参数。通过设置回调地址可以在服务端及时收到游戏运行时的相关消息。

    • 回调地址:输入支持 HTTP 的回调地址 URL。

    • 回调鉴权 AK/SK:输入用于回调鉴权的 AK 和 SK(AccessKey ID 和 AccessKey Secret),或单击生成鉴权秘钥按钮,自动生成密钥。

    • 回调间隔时长:输入定期发送回调信息的间隔时间(单位为秒)。

    设置完成后,单击确认,保存配置。此时可单击回调地址旁的验证,校验配置的回调地址是否可用。

  • 配置文件信息一栏中,单击编辑,配置游戏的资源文件信息,供此业务下所有游戏共享使用。

    • 配置文件路径:输入在云端保存资源文件的路径(即游戏依赖的资源路径)。

    • 配置文件 URL:输入下载资源文件的 URL,当前仅支持 tgz 文件格式。

    • 单击增加配置,可以配置多个资源文件信息。

    设置完成后,单击确认,保存配置。

  • 高级配置一栏中,单击编辑,然后按业务需要配置游戏运行相关的设置。

    • 无操作踢下线:输入用户长时间无操作时,回收游戏服务的时长。单位为秒,支持设置的最大值为 36000,即 10 小时。

    • 实例保活时长:输入客户端切后台之后,云端游戏服务的保活时长。单位为秒,支持设置的最大值为 7200,即 2 小时。

    • 多开限制配置:设置是否禁止同一个账号在多台设备上登录,并选择多开配置的策略;

    设置完成后,单击确认,保存配置,此处的设置将对此业务下的全部游戏生效。

资源管理

业务管理页面,单击目标业务卡片的进入业务,即可跳转到该业务下的资源管理页面,资源管理页面提供实例资源购买和管理功能。

火山引擎云游戏为新用户提供 1 路实例资源试用 7 天,产生的带宽费用仍需按计费标准计费。非新用户需要进行正式购买,云游戏实例提供包月预付费日订购峰值后付费两种计费模式,参看计费说明

购买资源

  1. 资源管理页面单击购买资源,选择计费类型为包月预付费

  2. 按业务需要选择套餐配置,并输入购买的实例数量和租期,选择是否开启自动续费。

  3. 带宽计费类型目前仅支持按月 95 峰值计费,无需选择。

  4. 阅读并同意云游戏《产品服务条款》和《服务等级协议》,单击确认订单

  5. 确认购买的订单信息,根据页面提示完成支付。

  6. 支付成功后,返回资源管理页面,即可查看已购所有实例资源的相关信息。

续费资源

资源到期释放前,在资源管理页面选择一个或多个资源组,单击批量续费,或单击单个资源组列表操作列中的手动续费,根据弹窗指示分别填写资源组的续费租期,确认预付款后单击确定,然后前往费用中心完成支付。

如需为已购资源组开通自动续费功能或修改自动续费配置,可单击资源组列表操作列中的管理自动续费,为已购资源组配置自动续费功能。

退订资源

资源管理页面选择一个或多个资源组,单击批量退订,或单击单个资源组列表操作列中的退订,根据弹窗指示确定需退订的实例总数和预计退款金额。

游戏 ID 管理

业务管理页面,单击目标业务卡片的进入业务,在左侧导航栏中,打开游戏 ID 管理页面。游戏 ID 管理页面提供新增游戏、部署管理、版本更新、下架等功能。

新增游戏

说明

控制台只允许通过 URL 或已有游戏包新增游戏,本地游戏文件上传需使用上传工具客户端。
本章节介绍在控制台新增游戏的操作。

  1. 游戏 ID 管理页面,单击新增游戏,选择上传方式为URL 上传已有游戏包

    • 选择通过 URL 上传时,填写以下配置信息:

      模块配置项说明
      基本信息游戏名称输入游戏名称。
      游戏标识输入自定义游戏标识,允许使用大小写字母、数字、下划线、连字符。
      横竖屏选择游戏横竖屏。
      版本配置游戏包名输入游戏包名。
      版本名称输入自定义版本名称,版本名称以数字开头且只能包含数字、连字符、下划线、点号。
      启动路径输入游戏包内启动文件的相对路径。
      启动参数(可选)填写启动游戏需要配置的其他依赖参数,支持中文、大小写字母、数字和特殊符号。
      URL 地址输入游戏包的 URL 地址。
      部署管理(可选)您可在新增游戏时同步添加游戏部署策略,也可跳过本配置项,在新增完成后单独配置部署策略
      单击添加部署策略,在套餐名称下拉菜单中选择运行游戏的实例套餐。如需配置多个实例套餐,再次单击添加部署策略,并配置次优先级的实例套餐。如需调整已配置套餐的调度优先级,可上下拖动某一行配置项进行调整。完成配置后,单击确认
    • 选择通过已有游戏包新增游戏时,填写以下配置信息:

      模块配置项说明
      基本信息游戏名称输入游戏名称。
      游戏标识输入自定义游戏标识,允许使用大小写字母、数字、下划线、连字符。
      横竖屏选择游戏横竖屏。
      版本配置游戏包名选择游戏包名。
      版本名称选择版本名称。
      部署管理(可选)您可在新增游戏时同步添加游戏部署策略,也可跳过本配置项,在新增完成后单独配置部署策略
      单击添加部署策略,在套餐名称下拉菜单中选择运行游戏的实例套餐。如需配置多个实例套餐,再次单击添加部署策略,并配置次优先级的实例套餐。如需调整已配置套餐的调度优先级,可上下拖动某一行配置项进行调整。完成配置后,单击确认
  2. 填写完成后,单击确定。游戏将自动进入适配中状态,适配完成后变更为上架完成状态。

配置部署策略

游戏上传完成后,可以为游戏添加部署策略,配置实例套餐以及调度优先级。游戏启动时将根据优先级和资源使用情况启动实例套餐。

  1. 游戏 ID 管理页面单击操作栏的游戏配置

  2. 单击部署管理模块的编辑按钮,单击添加部署策略,在套餐名称下拉菜单中选择运行游戏的实例套餐。如需配置多个实例套餐,再次单击添加部署策略,并配置次优先级的实例套餐。如需调整已配置套餐的调度优先级,可上下拖动某一行配置项进行调整。完成配置后,单击确认

更新游戏

说明

控制台只允许通过 URL 上传版本或已有游戏包版本更新游戏,本地游戏文件上传需使用上传工具客户端。
本章节介绍在控制台更新游戏的操作。

  1. 游戏 ID 管理页面单击操作栏的版本管理

  2. 单击更新游戏,选择上传方式为URL 上传版本已有游戏包版本

    • 选择通过 URL 上传版本时,填写以下配置信息:

      配置项说明
      包类型新增游戏包版本时,选择上传完整包增量包。两种更新方式的区别参看更新方式说明
      版本名称输入自定义版本名称,版本名称以数字开头且只能包含数字、连字符、下划线、点号。
      启动路径(可选)输入包内启动文件的相对路径,启动文件即游戏包文件夹下游戏启动程序 exe 文件。
      启动参数(可选)输入启动游戏需要配置的其他依赖参数,支持中文、大小写字母、数字和特殊符号。
      URL 地址输入 URL 地址。
    • 选择通过已有游戏包版本更新游戏时,选择包版本名。

  3. 填写完成后,单击确定。游戏将自动进入新版本适配中状态(通过已有游戏包版本更新无需等待适配),适配完成后变更为上架完成状态。

绑定伴随程序

说明

绑定伴随程序前,需要先完成伴随程序的上传。你可以通过上传工具控制台完成伴随程序的上传和更新。

  1. 游戏 ID 管理页面单击操作栏的游戏配置

  2. 进入伴随配置编辑模式,从伴随程序列表中选择当前游戏需要绑定的伴随程序。

配置关键字识别服务

注意

如需使用该功能,请联系技术支持开通。

您可以通过配置 OCR 关键字或日志关键字实时检测游戏情况,并设置识别到关键字后触发执行的操作。

例如,可配置“挂机”为 OCR 关键字,并配置关键字触发执行“重启+回调“操作,当游戏画面中检测到“挂机”关键字时(如游戏内弹出警告),会自动重启游戏,并通过 PCMC SDK 回调。

  1. 游戏 ID 管理页面单击操作栏的游戏配置,并进入关键字配置编辑模式。

    alt

  2. 根据您的需求配置 OCR 关键字和日志关键字,可以配置多个关键字。

    • 添加游戏画面中需要 OCR 识别的关键字,选择需要触发执行的操作。

      触发执行操作说明
      重启 + 回调重启游戏,并将识别到的关键字通过 PCMC SDK OnOcrStatus 回调。
      仅回调将识别到的关键字通过 PCMC SDK OnOcrStatus 回调。
      回调坐标将识别到的全部文字及坐标信息同步通过 PCMC SDK OnOcrStatus 回调。
    • 输入游戏日志路径,添加需要识别的日志关键字,选择触发执行仅回调操作,将识别到的关键字通过 PCMC SDK OnLogStatus 回调。

  3. 关键字配置完成后,单击开关启用,然后单击确认保存。

    alt

下架游戏

游戏 ID 管理页面单击操作栏的下架,即可下架对应游戏。

注意

游戏下架后,会同时删除该游戏的版本和部署策略。如果有实例正在推流这个游戏,则不能删除游戏。如果需要重新申请已下架的游戏服务,需要重新上传和适配游戏。

数据监控

数据监控页面提供查看和监控当前云游戏业务运行数据的功能,目前云 XR 数据监控页面开放了资源订购和带宽用量数据。

在控制台左侧导航栏中,进入云端游 > 数据监控页面。

  • 资源订购标签页下,可查询业务维度的资源订购总量和资源订购走势。

  • 带宽用量标签页下,可查询当前账号在指定时间区间内产生的带宽用量趋势,包括当日带宽峰值和当月带宽 95 峰值。

    说明

    带宽用量不区分手游、端游、XR,展示当前账号下产生的全部带宽用量。

伴随程序

在控制台左侧导航栏中,进入云端游 > 伴随程序页面。伴随程序页面页面提供伴随程序的新增、配置、版本管理、下架等功能。

新增伴随程序

说明

控制台只允许通过 URL 或已有伴随程序包新增伴随程序,本地文件上传需使用上传工具客户端。
本章节介绍在控制台新增伴随程序的操作。

  1. 在伴随程序页面,单击新增伴随程序,选择上传方式为URL 上传已有伴随程序包

    • 选择通过 URL 上传时,填写以下配置信息:

      模块配置项说明
      基本信息伴随程序名称输入伴随程序名称,名称以数字开头且只能包含数字、连字符、下划线、点号。
      启动时机选择在游戏启动后游戏启动前启动伴随程序。
      版本配置伴随程序包名输入伴随程序包名。
      版本名称输入伴随程序自定义版本名称,版本名称以数字开头且只能包含数字、连字符、下划线、点号。
      启动路径输入包内启动文件的相对路径,启动文件即游戏包文件夹下游戏启动程序 exe 文件。
      启动参数(可选)填写启动游戏需要配置的其他依赖参数,支持中文、大小写字母、数字和特殊符号。
      URL 地址输入伴随程序包的 URL 地址。
    • 选择通过已有伴随程序包新增时,填写以下配置信息:

      模块配置项说明
      基本信息伴随程序名称输入伴随程序名称,名称以数字开头且只能包含数字、连字符、下划线、点号。
      启动时机选择在游戏启动后游戏启动前启动伴随程序。
      版本配置伴随程序包名选择已有的伴随程序包名。
      版本名称选择已有的伴随程序包版本。
  2. 单击确定,新增伴随程序将进行自动进行适配(通过已有伴随程序包新增无需等待适配)。适配完成后,伴随程序将进入上架完成状态。

配置伴随程序

  1. 在伴随程序列表中,单击目标伴随程序操作栏的程序配置,进入伴随程序配置页面。

  2. 你可以在伴随程序配置页面编辑伴随程序名称和启动时机。

更新伴随程序

说明

控制台只允许通过 URL 或已有伴随程序包更新伴随程序,本地文件上传需使用上传工具客户端。
本章节介绍在控制台更新伴随程序的操作。

  1. 在伴随程序列表中,单击目标伴随程序操作栏的版本管理,进入伴随程序版本管理页面,你可以在此页面更新伴随程序。

  2. 单击更新伴随程序,选择上传方式为URL 上传版本已有伴随程序包版本

    • 选择通过 URL 上传版本时,填写以下配置信息:

      配置项说明
      包类型新增伴随程序包版本时,选择上传完整包或增量包。两种更新方式的区别参看更新方式说明
      版本名称选择已有的伴随程序包版本,或输入伴随程序自定义版本名称,版本名称以数字开头且只能包含数字、连字符、下划线、点号。
      启动路径(可选)打开电脑本地文件浏览器,选择游戏包文件夹下游戏启动程序 exe 文件。
      启动参数(可选)填写启动游戏需要配置的其他依赖参数,支持中文、大小写字母、数字和特殊符号。
      URL 地址输入伴随程序包的 URL 地址。
    • 选择通过已有伴随程序包版本更新伴随程序时,选择包版本名。

  3. 填写完成后,单击确定。伴随程序将自动进入新版本适配中状态(通过已有伴随程序包版本更新无需等待适配),适配完成后变更为上架完成状态。

下架伴随程序

  1. 在伴随程序列表中,单击目标伴随程序操作栏的下架,进入下架伴随程序页面。

  2. 在二次确认弹窗中,单击下架,下架伴随程序。下架伴随程序将同时删除全部版本信息以及所有游戏绑定的此条配置。

游戏包和伴随程序包管理

在控制台左侧导航栏中,进入云游戏端游 > 游戏包管理页面。游戏包管理页面提供游戏包和伴随程序包的基本信息,游戏包和伴随程序包的上传与更新请通过上传工具进行。

游戏的版本通过游戏包维度进行管理,游戏 ID 可以关联到游戏包维度的版本镜像和配置信息。伴随程序同理。

常见问题

更新方式说明

火山引擎云游戏提供两种更新方式,您可按需选择:

  • 全量更新:直接上传一个完整可独立运行的游戏包版本,游戏包整体进行云化适配和更新应用;适用于不知晓游戏包内差异文件内容变更情况下,更为安全稳妥的更新方式,但全量更新耗时相对较长。
  • 增量更新:默认以前一个游戏包版本作为基础,在版本上进行同名文件替换与增量文件补充,适用于知晓游戏包内差异文件内容的情况下,更为轻量快速的更新方式。

以下为增量更新示例:

  • 全量包 test_pc_game_v1.0 文件目录结构如下所示。

    .
    ├── c.exe
    ├── test_a
    │   └── a.txt
    └── test_b
        └── b
            └── b.dll
    
  • 增量包 test_pc_game_v1.1 中

    • 更新了 c.exe 文件;
    • test_a 下增加了 a1.dll 文件;
    • 新增了 test_c/c.so 文件。
    .
    ├── c.exe
    ├── test_a
    │   └── a1.dll
    └── test_c
        └── c.so
    
  • 使用增量包 test_pc_game_v1.1 进行更新后,文件结构如下所示。

    .
    ├── c.exe
    ├── test_a
    │   ├── a.txt
    │   └── a1.dll
    ├── test_b
    │   └── b
    │       └── b.dll
    └── test_c
        └── c.so