オンボーディング

設定の概要については、Codemonkey の動画 を視聴してください。

インテグレーション

UGS にサインアップし、プロジェクトを作成してリンクし、UGC SDK パッケージをプロジェクトにインポートする必要があります。以下のステップに従って UGC SDK を統合します。

  1. Unity アカウントをお持ちでない場合は、アカウントを作成 し、新しいプロジェクトを作成 してから、Unity Gaming Services にサインアップしてください。
  2. Unity エディターで Edit (編集) > Project Settings (プロジェクト設定) > Services (サービス) に移動します。
  3. 既存の認証情報を使用してサインインします。
  4. ドロップダウンリストからプロジェクトを選択し、Link project ID (プロジェクト ID をリンク) を選択します。
  5. Unity エディターで、Window (ウィンドウ) > Package Manager (パッケージマネージャー) を開きます。パッケージが、Unity Dashboard の UGC 設定ページで一時的に使用可能になります。
  6. User Generated Content を選択し、Install (インストール) を選択します。

Unity Dashboard が UGC に関して更新され、審査担当者ステータスを作成し、playerId を使用してプレイヤーに割り当てるためのページが追加されます。

Content (コンテンツ)

Content (コンテンツ) メニューを使用して、コンテンツのリストを表示します。可視性、作成日、更新日を使用して、フィルター処理します。各コンテンツ項目には、バージョン番号、フラグ件数 (不適切なコンテンツ)、ステータス (非表示または公開)、リリース日があります。

詳しい情報を確認するにはコンテンツ名を選択します。

平均評価や更新日などの詳細が表示されます。可視性を編集できます。Public Game (公開ゲーム)、Public Global (公開グローバル)、および Hidden (非表示) から選択します。

ダウンロード、サブスクリプション、レポートなど、コンテンツの他の統計が表示されます。

Service Settings (サービス設定)

左側のパネルの Service Settings (サービス設定)を使用して、コンテンツを設定します。以下を設定できます。

  • Labels (ラベル): コンテンツに関するラベルのキュレーションリスト。
  • Categories (カテゴリ): ゲームのタイプと属性のリスト。
  • コンテンツが検出されるためにコンテンツが必要とする評価の最小件数。
  • コンテンツが検出されるためにコンテンツが必要とする最小ダウンロード回数。
  • Moderation status (審査ステータス): Approved (承認済み) または Rejected (拒否済み)。
  • Authentication provider settings (認証プロバイダー設定): Apple、Facebook、Google クライアント ID から選択します。

Web Portal Setup (ウェブポータル設定)

左側のパネルにある Web Portal Setup (ウェブポータル設定) を使用して、ウェブポータルを設定します。この設定は SDK にも関連します。以下を設定できます。

  • Site name (サイト名): この名前はウェブポータルにも表示されます。
  • Studio name (スタジオ名): この名前はウェブポータルにも表示されます。
  • Description (説明): サイトの説明を入力します。
  • Banner image (バナー画像): クリエーションセンターと審査センターで一番上に表示される画像を設定します。
  • Site visibility (サイトの可視性): サイトが UGC ポータルと UGC SDK 使用できるように設定します。またはオフにします。
  • URL: スタジオがクリエーターに提供するクリエーターツールのダウンロード URL。
  • Title (タイトル): クリエーターセンターのタイトルを入力します。
  • Description (説明): クリエーターセンターでクリエーターに表示される説明を入力します。

Moderation (審査)

左側のパネルの Moderation (審査) を使用して、設定を行います。Flexible (柔軟) では、コンテンツがすぐに公開されますが、不適切であるというユーザーレポートが一定数を超えた場合に審査が行われます。Strict (厳格) では、公開前にすべてのコンテンツが審査担当者によって承認される必要があります。プレイヤーを、独自の権限を保持するクリエーターおよび審査担当者として設定します。また、バンプレイヤーのリストを表示したり (現在 playerID が表示される)、ログを見てコンテンツの審査の状況を確認したりすることもできます。

Webhooks (ウェブフック)

左側のパネルの Webhooks (ウェブフック) を使用し、1 つのコンテンツが新しく追加されるなど、特定のイベントが発生したときに通知またはアクションをトリガーします。

ユーザーが新しいウェブフックを作成すると、Unity によってシークレットが生成されます。このシークレットは 1 回しか表示されません。ウェブフックを受け取るサーバーが、それを使用してリクエスト元を検証し、Unity から送信されていることを確認します。ウェブフックリクエストの署名を検証できるように、シークレットをコピーする必要があります。

クリエーターは、作成プロセス (例えば Raw コンテンツ形式) を介してコンテンツイベントを更新します。リプレゼンテーションは、ゲーム内でロードされるものです。例えば、PS5 にロードされるゲーム、または Nintendo Switch にロードされるゲームのインスタンスです。

ウェブフックを追加するには、以下を行います。

  1. Add Webhooks (ウェブフックの追加) を選択します。
  2. ウェブフックの名前、URL、シークレットを指定します。
  3. 監視するイベントを有効にします。
  4. Save (保存) を選択します。

UGC エディターブリッジのクイックスタート

User-Generated Content (UGC) エディターブリッジは、コンテンツクリエーターが特定のゲームの UGC を Unity エディターから直接アップロードするための Unity パッケージです。これは、Unity パッケージから UGC ゲームを開発しているゲームスタジオに提供されたテンプレートであるため、ニーズや目的に合わせて変更できます。これはデフォルトで作動します。

UGC Bridge によって、ゲーム内での UGC インテグレーションがスムーズになります。また、UGC エディターの基盤として Unity エディターを活用し、開発費用を削減できます。

UGC ゲームプロジェクトと UGC エディターブリッジプロジェクトという 2 つのプロジェクトについて説明します。

UGC ゲームプロジェクトはゲームの Unity プロジェクトです。このプロジェクトはゲームスタジオが所有し、コンテンツクリエーターと共有されることはほぼありません。

UGC エディターブリッジプロジェクトは、ゲームスタジオによってカスタマイズされた UGC エディターブリッジパッケージをホストするために作成されるプロジェクトです。このプロジェクトは、カスタマイズされたパッケージに含めることができます。またはコンテンツクリエーターが作成することもできます。展開に関するセクションで説明するように、自らの設定に基づいてこのプロジェクトをパッケージ化するかどうかはゲーム開発者しだいです。

要件

UGC エディターブリッジを使用するには、UGC 対応プロジェクトが必要です。UGC エディターブリッジのために使用されるプロジェクトは、ゲームプロジェクトと同じでなくてもかまいません。ただし、これら 2 つのプロジェクト ID を共有するため、UGC エディターブリッジプロジェクトはゲームプロジェクトのコンテンツを公開できます。Unity の要件は UGC SDK と同じです。

インストール

Unity エディターで、Window (ウィンドウ) > Package Manager (パッケージマネージャー) に移動します。"ugc" を検索し、User Generated Content Bridge を選択します。

新しい Unity プロジェクトで、Package Manager を開きます。左上の + をクリックし、Add package from disk (パッケージをディスクから追加) を選択します。ダウンロードされたパッケージに移動し、package.json ファイルを選択し、open (開く) を選択します。

project settings (プロジェクト設定) で、UGC Bridge を選択します。project id (プロジェクト ID) フィールドに、UGC ゲームプロジェクトの ID をコピーして貼り付けます。環境については、そのままにしておくか、新しい環境を作成して名前をフィールドに貼り付けます。

UGC Bridge の使用

認証

コンテンツを公開するには、コンテンツクリエーターの認証が必要です。ユーザーは、メインパネルで匿名ユーザーとして認証するか、設定されたプロバイダーのどれかで認証できます。

コンテンツの選択と公開

Project ウィンドウでいずれかのアセットを、公開するコンテンツとして選択します。いったん選択すると、メインパネルの Selection (選択) セクションに反映されます。それを使用して新しいコンテンツを作成できます (さらに、名前、説明、タグなど、関連するフィールドに入力します)。あるいは、既存のコンテンツを選択し、選択した内容をそのコンテンツの新バージョンとして公開できます。

検証

公開したいコンテンツの検証ルールを設定しておくと、公開ステップで検証されます。検証の問題が公開パネルの下部に表示されるので修正できます。

カスタマイズ

UGC エディターブリッジは、プロジェクト開発者がゲームのためにカスタマイズできるように設計されています。UI およびプロセスは 5 つのステップに対して作成されます。認証、選択、公開、検証、ビルドです。いったん作成したら、各ステップに機能やフィールドを加えてカスタマイズできます。プロセスを理解できるように、具体的な例で説明します。

新しい検証ルールの作成

新しい検証ルールを作成するには、Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Validation Rule Templates (検証ルールテンプレート) > New Validation Rule Script (新しい検証ルールスクリプト) を選択します。これで、新しい検証ルールスクリプトが作成されます。名前を入力して、スクリプトを開きます。

スクリプトに以下を入力します。

プロパティ説明
HelpBoxTextこの検証ルールに一致しない場合に表示されるテキスト。
MessageTypeこのルールに一致しない場合に表示されるメッセージのタイプ。タイプは、Info、Warning、Error、None です。
ValidationRuleState検証ルールの現在の状態。NotValidated、NotValid、または Valid です。
メソッド説明
ValidateRule(Object content)このルールが検証を処理する方法。このメソッドではプロパティも設定されます。

検証に必要となる可能性があるフィールドまたはメソッドを追加することもできます。

検証ルールのスクリプトを入力したら、Unity に戻ります。Project ウィンドウを右クリックし、Create > UGC Bridge > Validation Rule Assets (作成 > UGC Bridge > 検証ルールアセット) を選択し、この検証ルールのアセットを作成します。いったん作成したら、使用する検証ステップに検証ルールを追加します。

ユーザー認証のカスタマイズ

新しいユーザー認証ステップを作成するには、Project ウィンドウを右クリックし、Create > UGC Bridge > Step Templates > New User Authentication Step Script (作成 > UGC Bridge > ステップテンプレート > 新しいユーザー認証ステップスクリプト)を選択します。これで、新しいユーザー認証ステップスクリプトが作成されます。名前を入力して、スクリプトを開きます。

スクリプトに以下を入力します。

メソッド説明
OnGUIユーザー認証で、メインパネルのユーザー認証 (user authentication) セクションにフィールドまたはボタンが必要な場合には、ここで描画できます。UI が必要ない場合、ここは空にしておきます。
SessionSignInこのメソッドが呼び出されるのは、プレイヤーの自動サインインのためにエディターセッションが更新されるときです (すでにサインインしている場合)。

ユーザー認証に必要となる可能性があるフィールドまたはメソッドを追加することもできます。

ユーザー認証ステップのスクリプトを入力したら、Unity に戻ります。Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Step Assets (ステップのアセット) を選択して、このユーザー認証ステップのアセットを作成します。いったん作成したら、新しいユーザー認証ステップをプロジェクト設定に割り当てます。

コンテンツ選択のカスタマイズ

新しいコンテンツ選択ステップを作成するには、Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Step Templates (ステップテンプレート) > New Content Selection Step Script (新しいコンテンツ選択ステップスクリプト) を選択します。これで、新しいコンテンツ選択ステップスクリプトが作成されます。名前を入力して、スクリプトを開きます。

スクリプトに以下を入力します。

プロパティ説明
SourceContentFilePath公開するために選択したコンテンツのファイルパス。
RepresentationContentFilePath公開するために選択したコンテンツのリプレゼンテーションのファイルパス。RequireRepresentationtrue に設定されている場合のみ使用されます。
RequireRepresentationコンテンツを公開する前にリプレゼンテーションをビルドする必要がある場合に選択します。ソースコンテンツが実行時に使用されない場合はオーバーライドします。デフォルトでは false に設定されます。
メソッド説明
OnGUI()コンテンツ選択で、メインパネルにフィールドが必要な場合には、ここで描画できます。UI が必要ない場合、ここは空にしておきます。

コンテンツ選択に必要となる可能性があるフィールドまたはメソッドを追加することもできます。

コンテンツ選択ステップのスクリプトを入力したら、Unity に戻ります。Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Step Assets (ステップのアセット) を選択して、このコンテンツ選択ステップのアセットを作成します。いったん作成したら、これをデフォルトのコンテンツ選択ステップとしてプロジェクト設定に割り当てます。

コンテンツ公開のカスタマイズ

新しいコンテンツ公開ステップを作成するには、Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Step Templates (ステップテンプレート) > New Content Publishing Step Script (新しいコンテンツ公開ステップスクリプト) を選択します。これで、新しいコンテンツ公開ステップスクリプトが作成されます。名前を入力して、スクリプトを開きます。

スクリプトに以下を入力します。

プロパティ説明
ContentPublishingDataコンテンツの公開に使用されるデータ。このプロパティはベーススクリプトですでに確認されています。
メソッド説明
OnGUI()フィールドがここで描画されます。
PublishAsync(Action onPublished, Action onError)この関数は、非同期公開呼び出しを起動し、対応するコールバック (エラーまたは成功) を使用します。

コンテンツ公開に必要となる可能性があるフィールドまたはメソッドを追加することもできます。

コンテンツ公開ステップのスクリプトを入力したら、Unity に戻ります。Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Step Assets (ステップのアセット) を選択して、このコンテンツ公開ステップのアセットを作成します。いったん作成したら、これをデフォルトのコンテンツ公開ステップとしてプロジェクト設定に割り当てます。

コンテンツ検証のカスタマイズ

新しいコンテンツ検証ステップを作成するには、Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Step Templates (ステップテンプレート) > New Content Validation Step Script (新しいコンテンツ検証ステップスクリプト) を選択します。これで、新しいコンテンツ検証ステップスクリプトが作成されます。名前を入力して、スクリプトを開きます。

スクリプトに以下を入力します。

プロパティ説明
ValidationRulesコンテンツを公開する前に検証する必要がある検証ルールのリスト。
メソッド説明
OnGUI()検証ルールの GUI が描画される前に、ここで情報が描画されます。
ValidateContent()コンテンツが公開される前に、ここで検証ルールがチェックされます。

コンテンツ検証に必要となる可能性があるフィールドまたはメソッドを追加することもできます。

コンテンツ検証ステップのスクリプトを入力したら、Unity に戻ります。Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Step Assets (ステップのアセット) を選択して、このコンテンツ検証ステップのアセットを作成します。いったん作成したら、これをデフォルトのコンテンツ検証ステップとしてプロジェクト設定に割り当てます。

コンテンツビルドのカスタマイズ

新しいコンテンツビルドステップを作成するには、Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Step Templates (ステップテンプレート) > New Content Building Step Script (新しいコンテンツビルドステップスクリプト) を選択します。これで、新しいコンテンツビルドステップスクリプトが作成されます。名前を入力して、スクリプトを開きます。

スクリプトに以下を入力します。

プロパティ説明
OnContentBuiltEventコンテンツがアセットバンドルにビルドされるときに発生するイベント。
メソッド説明
Build(Object selection, string outputFolderPath)選択されたコンテンツを出力フォルダーにビルドします。

コンテンツビルドに必要となる可能性があるフィールドまたはメソッドを追加することもできます。

コンテンツビルドステップのスクリプトを入力したら、Unity に戻ります。Project ウィンドウを右クリックし、Create (作成) > UGC Bridge > Step Assets (ステップのアセット) を選択して、このコンテンツビルドステップのアセットを作成します。いったん作成したら、これをデフォルトのコンテンツビルドステップとしてプロジェクト設定に割り当てます。

推奨事項

UGC エディターブリッジプロジェクトのパッケージ化と提供に関する、コンテンツクリエーター向けの現在の推奨事項は以下のとおりです。

  1. 空の Unity プロジェクトを作成します。
  2. UGC Bridge にプロジェクト ID と環境を設定します。
  3. ステップを設定します。
  4. プロジェクトを圧縮し、そのアーカイブをコンテンツクリエーターに提供します。