入门
请观看我们的 Codemonkey 视频,了解设置概述。
集成
您必须注册 UGS,创建并关联项目,并将 UGC SDK 包导入到您的项目中。请按照以下步骤集成 UGC SDK:
- 如果您还没有 Unity 帐户,创建一个帐户并创建一个新项目,以注册使用 Unity Gaming Services(Unity 游戏服务)。
- 在 Unity 编辑器中,转到 Edit(编辑)> Project Settings(项目设置)> Services(服务)。
- 使用您现有的凭据登录。
- 从下拉选单中选择您的项目并选择 Link project ID(关联项目 ID)。
- 在 Unity 编辑器中,打开 Window(窗口)> Package Manager(包管理器)。这些软件包暂时只能通过 Unity Dashboard(Unity 后台)中的 UGC 设置页面获取。
- 选择 User Generated Content(用户生成内容),然后选择 Install(安装)。
Unity Dashboard(Unity 后台)已针对 UGC 进行了更新,其中包括使用 playerID 为部分玩家创建和分配审核员状态的相关页面。
Content(内容)
Content(内容)菜单显示您的内容列表。该菜单按可见性、创建日期和更新日期进行过滤。每个内容项都有版本号、标记计数(针对不当内容)、状态(隐藏或公开)和发布日期。
选择内容名称,了解更多详细信息。
查看平均评分和更新日期等详细信息。您可以编辑可见性;从 Public Game(公共游戏)、Public Global(公共全局)和 Hidden(隐藏)中进行选择。
查看有关您的内容的更多统计信息,例如下载次数、订阅人数和上报次数。
Service Settings(服务设置)
使用左侧面板中的 Service Settings(服务设置)部分,可配置内容设置。可以进行以下设置:
- 标签:为您的内容精心制作的标签列表。
- 类别:游戏类型和属性列表。
- 内容发现所需的最少评分次数。
- 内容发现所需的最少下载次数。
- 审核状态:Approved(已批准)或 Rejected(已拒绝)。
- 身份验证服务提供者设置:从 Apple、Facebook 以及 Google Client ID 中选择。
Web Portal Setup(Web 门户设置)
使用左侧面板中的 Web Portal Setup(Web 门户设置)部分,可以为门户网站配置设置。该设置还与 SDK 相关。可以进行以下设置:
- 站点名称:该名称还将显示在 Web 门户中。
- 工作室名称:该名称还将显示在 Web 门户中。
- 描述:输入网站描述。
- 横幅图片:设置显示在创作中心和审核中心顶部的图像。
- 站点可见性:将网站设置为在 UGC 门户和 UGC SDK 上可见,或将其关闭。
- URL:工作室向创作者提供的创作者工具下载 URL。
- 标题:为创作者中心输入标题。
- 描述:输入创作者在创作者中心看到的描述。
Moderation(审核)
使用左侧面板中的 Moderation(审核)部分,可以配置您的设置。**Flexible(灵活)**表示内容将立即发布,但如果超过一定数量的用户报告内容不当,则会接受审核。**Strict(严格)**表示所有内容在发布之前都必须经由审核员批准。将玩家设置为具有自身权限的创作者和审核员。您还可以查看被禁玩家列表(当前按 playerID 显示),并查看日志,了解内容的审核情况。
Webhook
使用左侧面板中的 Webhook 部分,可在发生特定事件(例如添加了新内容)时触发通知或操作。
当用户创建新 Webhook 时,Unity 会生成密钥。该密钥仅显示一次,接收 Webhook 请求的服务器将使用它来验证请求来源,确保来自 Unity。您须复制该密钥,以便验证来自 Webhook 请求的签名。
创作者通过创建过程更新内容事件,例如原始内容格式。表示是游戏内加载的内容;例如,在 PS5 上加载的游戏实例,或在 Nintendo Switch 上加载的游戏实例。
添加 Webhook 的步骤如下:
- 选择 Add Webhooks(添加 Webhook)。
- 为 Webhook 指定名称、URL 和密码。
- 启用您想要观看的事件。
- 选择 Save(保存)。
UGC Editor Bridge 快速入门
User-Generated Content (UGC) Editor Bridge 是一个 Unity 包,供内容创作者直接从 Unity 编辑器上传特定游戏的 UGC。它是为开发 UGC 游戏的游戏工作室提供的模板 Unity 包,后者可以对其进行修改以符合自己的需求和设计。默认情况下可正常使用。
UGC Bridge 减少了游戏中 UGC 集成的摩擦,利用 Unity 编辑器作为 UGC 编辑器的基础,并且降低了工程成本。
这里涉及两个不同的项目:UGC 游戏项目和 UGC Editor Bridge 项目。
UGC 游戏项目即游戏的 Unity 项目。该项目由游戏工作室所有,很可能不与内容创作者共享。
UGC Editor Bridge 项目指为了托管游戏工作室定制的 UGC Editor Bridge 包而创建的项目。这个项目可以使用定制的打包方式打包,也可以由内容创作者创建。游戏开发者可以根据自己的喜好来打包该项目,正如您将在部署部分看到的那样。
要求
要使用 UGC Editor Bridge,您需要一个支持 UGC 的项目。用于 UGC Editor Bridge 的项目不需要与游戏项目相同,但我们在两者之间共享 Project ID,这样 UGC Editor Bridge 项目即可发布游戏项目的内容。Unity 要求与 UGC SDK 相同。
安装
在 Unity 编辑器中,转到 Window(窗口)> Package Manager(包管理器)。搜索“ugc”,选择 User Generated Content Bridge。
在新的 Unity 项目中,打开包管理器。点击左上角的 +,然后选择 Add package from disk(从磁盘添加包)。转到下载的包,选择 package.json 文件并选择 open(打开)。
在项目设置中,选择 UGC Bridge。在 Project ID 字段中,复制粘贴 UGC 游戏项目的 ID。您可以保留当前环境,也可以创建新环境并将其名称粘贴到字段中。
使用 UGC Bridge
身份验证
要发布内容,内容创作者需要经过身份验证。用户可以作为匿名用户通过主面板完成身份验证,或通过配置的提供商之一完成身份验证。
选择并发布内容
选择项目窗口中的任意资源作为要发布的内容。选择后,资源会显示在主面板的 **Selection(选择)**部分。您可以使用该资源创建新内容(并填写所有相关字段,如名称、描述、标签等),也可以选择预先存在的内容并将选定资源发布为该内容的新版本。
验证
如果您为要发布的内容配置了验证规则,系统就会在发布步骤对内容进行验证。验证问题显示在发布面板的底部,您可以修复它们。
定制
UGC Editor Bridge 可以由项目开发者进行定制,以用于他们的游戏。UI 和流程围绕五个步骤构建:身份验证、选择、发布、验证和构建。创建后,您可以使用功能或字段来自定义每个步骤。请参阅功能示例以了解该过程。
创建新的验证规则
要创建新的验证规则,右键单击项目视图,选择Create(创建)> UGC Bridge > Validation Rule Templates(验证规则模板)> New Validation Rule Script(新建验证规则脚本)。这将创建一个新的验证规则脚本。输入名称并打开脚本。
在脚本中,需要填写:
属性 | 描述 |
---|---|
HelpBoxText | 该验证规则失败时显示的文本。 |
MessageType | 该验证规则失败时显示的消息类型。类型包括 Info(信息)、Warning(警告)、Error(错误)和 None (无)。 |
ValidationRuleState | 验证规则的当前状态。可以是 NotValidated(未验证)、NotValid(无效)或 Valid(有效)。 |
方法 | 描述 |
---|---|
ValidateRule(对象内容) | 该规则如何处理验证。此方法还应该设置该属性。 |
您还可以添加完成验证可能需要的任何字段或方法。
当验证规则脚本填写完毕后,返回 Unity。在项目视图中右键单击,选择 Create(创建)> UGC Bridge > Validation Rule Assets(验证规则资源),创建此验证规则的资源。创建后,将验证规则添加到您正在使用的验证步骤中。
自定义用户身份验证
要创建新的用户身份验证步骤,右键单击项目视图,选择 Create(创建)> UGC Bridge > Step Templates(步骤模板)> New User Authentication Step Script(新用户身份验证步骤脚本)。这将创建新的用户身份验证步骤脚本。输入名称并打开脚本。
在脚本中,需要填写:
方法 | 描述 |
---|---|
OnGUI | 如果用户身份验证需要在主面板用户身份验证部分中安排字段或按钮,可以在此处绘制。如果不需要 UI,将此处留空。 |
SessionSignIn | 当刷新编辑器会话时调用此方法,以便玩家自动登录(如果已经登录)。 |
您还可以添加用户身份验证可能需要的任何字段或方法。
用户身份验证步骤脚本填写完毕后,返回 Unity。在项目视图中右键单击,选择 Create(创建)> UGC Bridge > Step Assets(步骤资源),创建此用户身份验证步骤的资源。创建后,将新用户身份验证步骤分配给项目设置。
自定义内容选择
要创建新的内容选择步骤,右键单击项目视图,选择 Create(创建)> UGC Bridge > Step Templates(步骤模板) > New Content Selection Step Script(新内容选择步骤脚本)。这将创建新的内容选择步骤脚本。输入名称并打开脚本。
在脚本中,需要填写:
属性 | 描述 |
---|---|
SourceContentFilePath | 所选发布内容的文件路径。 |
RepresentationContentFilePath | 所选发布内容的表示的文件路径。仅当 RequireRepresentation 设置为 true 时使用 |
RequireRepresentation | 在发布内容之前检查是否需要构建表示。如果在运行时不使用源内容,则覆盖。默认设置为 false。 |
方法 | 描述 |
---|---|
OnGUI() | 如果内容选择需要在主面板中安排字段,可以在此处绘制。如果不需要 UI,将此处留空。 |
您还可以添加内容选择可能需要的任何字段或方法。
当内容选择步骤脚本填写完毕后,返回 Unity。在项目视图中右键单击,选择 Create(创建)> UGC Bridge > Step Assets(步骤资源),创建此内容选择步骤的资源。创建后,将其分配给项目设置,作为默认内容选择步骤。
自定义内容发布
要创建新的内容发布步骤,右键单击项目视图,选择 Create(创建)> UGC Bridge > Step Templates(步骤模板)> New Content Publishing Step Script(新内容发布步骤脚本)。这将创建新的内容发布步骤脚本。输入名称并打开脚本。
在脚本中,需要填写:
属性 | 描述 |
---|---|
ContentPublishingData | 用于发布内容的数据。已在基本脚本中查看过该属性。 |
方法 | 描述 |
---|---|
OnGUI() | 绘制字段的位置。 |
PublishAsync(Action onPublished, Action onError) | 此函数会触发异步发布调用,并在出现错误或成功时使用相应的回调。 |
您还可以添加内容发布可能需要的任何字段或方法。
当内容发布步骤脚本填写完毕后,返回 Unity。在项目视图中右键单击,选择 Create(创建)> UGC Bridge > Step Assets(步骤资源),创建此内容发布步骤的资源。创建后,将其分配给项目设置,作为默认内容发布步骤。
自定义内容验证
要创建新的内容验证步骤,右键单击项目视图,选择 Create(创建)> UGC Bridge > Step Templates(步骤模板)> New Content Validation Step Script(新内容验证步骤脚本)。这将创建新的内容验证步骤脚本。输入名称并打开脚本。
在脚本中,需要填写:
属性 | 描述 |
---|---|
ValidationRules | 发布内容之前必须处于有效状态的验证规则列表。 |
方法 | 描述 |
---|---|
OnGUI() | 在绘制验证规则 GUI 之前,您可以在其中绘制一些信息。 |
ValidateContent() | 用于在发布内容之前检查验证规则。 |
您还可以添加内容验证可能需要的任何字段或方法。
填充内容验证步骤脚本后,返回 Unity。在项目视图中右键单击,选择 Create(创建)> UGC Bridge > Step Assets(步骤资源),创建此内容验证步骤的资源。创建后,将其分配给项目设置,作为默认内容验证步骤。
自定义内容构建
要创建新的内容构建步骤,右键单击项目视图,选择 Create(创建)> UGC Bridge > Step Templates(步骤模板)> New Content Building Step Script(新内容构建步骤脚本)。这将创建新的内容构建步骤脚本。输入名称并打开脚本。
在脚本中,需要填写:
属性 | 描述 |
---|---|
OnContentBuiltEvent | 当内容内置到资源包中时引发的事件。 |
方法 | 描述 |
---|---|
Build(Object selection, string outputFolderPath) | 在输出文件夹中构建选定的内容。 |
您还可以添加内容构建可能需要的任何字段或方法。
当内容构建步骤脚本填写完毕后,返回 Unity。在项目视图中右键单击,选择 Create(创建)> UGC Bridge > Step Assets(步骤资源),创建此内容构建步骤的资源。创建后,将其分配给项目设置,作为默认内容构建步骤。
建议
目前对打包并向内容创作者提供 UGC Editor Bridge 项目的建议是:
- 创建一个空的 Unity 项目。
- 使用 Project ID 和环境配置 UGC Bridge 设置。
- 设置步骤。
- 压缩项目并将该存档提供给内容创作者。