Steamworks ドキュメンテーション
Steamへのアップロード
以下は、Steamにコンテンツを配信するためのValveのツール、SteamPipeの使い方の説明です。 ゲームをアップデートするためのベストプラクティスの詳細については、こちらゲームのアップデート - ベストプラクティスをご覧ください。

SteamPipeコンテンツシステムの概説

SteamPipeは、Steamのゲーム/アプリケーションコンテンツシステムです。 SteamPipeは、次のような機能を備えています:
  • 効率的かつ迅速なコンテンツ配信
  • パブリックブランチと、複数のビルドのテストを可能にする、プライベートの「ベータ」ブランチ
  • ウェブベースによるシンプルなビルド管理 - 数クリックで、新規ビルドのリリースまたは以前のビルドへのロールバックを実行
  • ライブ設定前にビルドのアップデートサイズを確認
  • 複数のアプリケーション間でのコンテンツを共有
  • パブリックまたはベータコンテンツから インストーラーディスクを構築
  • アップデートのダウンロードの開始後も、ゲーム/アプリをオフラインで使用可能
  • すべてのコンテンツを常に暗号化し、アクティブでないバージョンは顧客からは見えません
  • 開発中に使用可能なSteamPipeローカルコンテンツサーバー
注: SteamPipeにはいくつかの重要な概念がありますので、先に進む前に アプリケーション の内容を理解しておいてください。 個々がどのように組み合わさるのかについて、基本概念を理解しておくだけでも、製品を Steam にアップロードする際には非常に役立ちます。

Steamworksビデオチュートリアル - Steampipeでのゲームの構築

このチュートリアルでは、Steam用のサンプルアプリケーションの構築を通じてSteamPipeとその使い方の手順を解説します。
https://www.youtube.com/watch?v=SoNH-v6aU9Q

Steamworksビデオチュートリアル - 新しいプラットフォームと言語の追加

このチュートリアルでは、アプリにデポを追加することで、ゲームに新しいプラットフォームや言語を追加する手順を解説します。
https://www.youtube.com/watch?v=PShS32hcing

SteamPipeの技術概説

SteamPipeはHTTPプロトコルを使用してコンテンツを配信します。 ダウンロードは通常のWebトラフィックを使って行われるため、顧客とSteamサーバーの間にサードパーティーHTTPキャッシュがある場合、ダウンロードスピードは向上します。 コンテンツを弊社のコンテンツネットワークに追加できる外部CDNプロバイダーにホストさせることもできます。 ほとんどの顧客のファイアウォールはHTTPトラフィックを許可し、ダウンロードをブロックすることはありません。

SteamPipeには、既存のコンテンツファイルの修正部分だけを変更する、バイナリ差分に基づく効率的なパッチアルゴリズムが搭載されています。 コンテンツがアップデートされると、こうした差分のみが送信されます。 こうすることで、開発者とユーザーによる転送量を少なく抑え、転送時間も短くすることができます。 ほとんどのパートナーは、プライベートブランチ上でビルドを効率よくパッチできるため、SteamPipeローカルコンテンツサーバーは不要だと感じています。

Steamのビルドアカウント

Steam上でビルドを作成する前に、「アプリのメタデータを編集する」および「Steamにアプリの変更を公開する」という権限を持つSteamアカウントをパートナーアカウントに追加してください。 セキュリティ上の理由から、専用のビルドアカウントを置くことをお勧めします。必要に応じて、https://store.steampowered.com/joinで新しいSteamアカウントを作成してください。

Steamworksアカウントの管理者であれば、Steamアカウントを追加し、必要な権限を付与することができます。 このプロセスについての詳細は、Steamworksアカウントの管理を参照してください。 以下は、アカウント追加の例です:

create_build_account.png

新規SteamPipe アプリの初期設定

以下のステップに従い、新規SteamPipeアプリを設定します:
  1. アプリケーションのAppIDを検索 (Steamworks内のホームページでアプリケーションを選択すると、見つけられます)
  2. アプリの 一般的なインストール設定 ページを開きます。
  3. 1 つ以上の起動オプションを定義します (ゲーム起動に必要なパスと任意の引数)。 (?) にマウスオーバーすることで各フィールドの情報が得られます。

    以下の例は5つの起動オプションです。Windows用に2例、macOS用に2例、Linux用に1例です。
    3つ目の起動オプションは、ユーザーが特定のDLCを所有している場合にのみWindowsで表示されます。

    updatedlaunchoptions_3.png
  4. デポページにアクセスして、このアプリに必要なデポを追加します。初期設定で、デポがすでにアプリケーションに設定済みの場合があります。
    1. 初期設定のデポをクリックし、デポの名前を ("ベースコンテンツ" または "Windowsコンテンツ" などの) 的確で覚えやすいものに変更します。
    2. 言語固有のデポでない場合、言語設定は「すべての言語」のままにします。
    3. OS固有のデポでない場合、OS設定は「全OS」のままにしておいてください(オールインワンアプリ、PC、またはMacの場合、「全OS」のままにしておいてください)。 OS固有のゲームのデポに対してのみ設定します。
    4. 新しいデポを追加するをクリックして、追加のデポを指定します。
    5. 変更を保存するをクリックして、変更点を保存します。
  5. デポの定義が完了したら、公開ページから変更を公開します。
  6. 自分に所有権を与えるには、新規に定義されたデポをパッケージ内に格納してください。 Steam 上の各ゲームには、パブリッシャーグループ内のメンバーアカウントに自動付与されるDeveloper Compパッケージがあります。
    新しいデポをAssociated Packages & DLCページ上の、パッケージ (または、これらのデポを持つ他のパッケージ) に追加することができます。
注: 実行可能ファイルが、メインインストールフォルダーのサブフォルダーにある場合は、実行可能ファイルフィールドにサブフォルダー名を追加します。 スラッシュやドットを先頭に使用しないでください。
プラットフォーム注記: 上述の通り、macOSアプリケーションはアプリバンドル(Game.app)またはスクリプト/バイナリ(Game.app/Contents/MacOS/Game)のいずれかを指定することで起動できます。 一般的に、可能な場合にはアプリバンドル形式が好まれます。これは、Steam外から手動で起動されたのと同じようにmacOSが起動パラメーターをより正確に決定できるためです。

Appleシリコンデバイスのアプリバンドルを通して起動されるアプリケーションは、アプリケーションで利用可能な最高のアーキテクチャを起動するのに対し、バイナリの直接起動は、Steamプロセスと同じアーキテクチャ(現時点ではx86_64)を使用することにご留意ください。

SteamPipeアップロードのためのSDKの設定

ビルドをアップロードするマシンに最新バージョンのSteamworks SDKをダウンロードして解凍します。

SteamPipeツールは、2つの関連するサブディレクトリを含むtoolsフォルダー内のSDK内にあります。

ContentBuilderディレクトリは、ゲームコンテンツとSteamPipeビルドツールがある場所です。 このディレクトリには、次のサブディレクトリがあります:
  • builder-デフォルトでは、コマンドラインバージョンのSteamであるsteamcmd.exeのみを含みます。
  • builder_linux-Linuxバージョンのsteamcmdです。
  • builder_osx-macOSバージョンのsteamcmdです。
  • content-デポを構築するすべてのゲームファイルを含みます。
  • output-ビルドログ、チャンクキャッシュ、中間アウトプットが保存されます。 注:このフォルダーは、いつでも削除または空にすることができますが、削除してしまうと、次のアップロードにかかる時間が少し長くなります。
  • scripts-ゲームのデポを構築するための全ビルドスクリプトを配置する場所です。
steampipebuilddir.png

ビルドシステムをブートストラップするために、プラットフォームのびづらーフォルダーでsteamcmd.exeを必ず一回直接実行してください。 ゲームデポを構築するのに必要な全ファイルが、ビルダーディレクトリに作成されます。

ContentServerディレクトリには、専用のSteamPipeローカルコンテンツサーバーを実行するツールが含まれています。

macOS向けSteamCmd

macOSでSteamCmdを有効にするには以下の手順に従ってください:
  1. ターミナルから\ContentBuilder\builder_osx\osx32フォルダーを参照します
  2. chmod +x steamcmdを実行します
  3. 親フォルダー(tools\ContentBuilder\builder_osx)を参照します
  4. 「bash ./steamcmd.sh」と入力します
  5. SteamCmdが実行されて最新のビルドにアップデートされSteamCmdプロンプトが表示されます
  6. 「exit」と入力してからreturnキーを押してプロンプトを終了します
その後、このドキュメントの以下の手順に従えば(必要に応じてパスの変更が必要です)、コンテンツをSteamにアップロードするためのデポとアプリ設定ファイルを作成できます。

SteamPipeビルド設定ファイルの作成

SteamPipeでアプリ用にファイルをアップロードするには、ビルドと含まれる各デポを記述するスクリプトを作成する必要があります。 以下のスクリプトの例は、Steamworks SDKのTools\ContentBuilder\scriptsフォルダーにあります。

SteamPipe GUIツール

Windowsで実行していて、構成ファイルの作成とビルドのアップロードに役立つGUIツールが必要な場合は、Steamworks SDKのtoolsフォルダー内のSteamPipeGUIを使用できます。 zipファイルには、使用方法に関する追加インストラクションが含まれています。

GUIツールを使用する場合は、SteamPipeシステムの仕組みをさらに理解するために、以下のセクションを読むことをお勧めします。

簡単なビルドスクリプト


最も基本的なビルドスクリプトから始めてみましょう。 この例では、ゲーム(AppID 1000)に1つのデポ(DepotID 1001)があり、コンテンツフォルダーとサブフォルダーからすべてのファイルをアップロードします。 そのために必要なビルドスクリプトは1つだけです。SDKに含まれる「simple_app_build.vdf」を見てみましょう。

"AppBuild" { "AppID" "1000" // あなたのAppID "Desc" "This is a simple build script" // このビルドの内部的な説明 "ContentRoot" "..\content\" // このファイルの場所からの相対的なコンテンツのルートフォルダー "BuildOutput" "..\output\" // ビルドログとビルドキャッシュファイル用のビルド出力フォルダー "Depots" { "1001" // your DepotID { "FileMapping" { "LocalPath" "*" // contentrootフォルダーのすべてのファイル "DepotPath" "." // デポのルートにマップされます "recursive" "1" // すべてのサブフォルダーを含める } } } }

適宜ゲームに合ったAppIDとDepotIDに変更してください。 ビルドを開始するには、steamcmdを実行し、いくつかのパラメーターを渡す必要があります:
tools\ContentBuilder\builder\steamcmd.exe +login <account_name> <password> +run_app_build ..\scripts\simple_app_build.vdf +quit

注意: ビルドの初回実行時には、Steamガードに阻まれる場合があります。 Steamガードによってログインが失敗した場合は、Steamガードコードを確認し、steamcmdを次のように実行して再試行してください: steamcmd.exe "set_steam_guard_code <code>"。 Steamガードでログインに成功すると、sentryファイルによって、正規のログインであることが確認されます。

頻繁に再イメージされるマシンまたは仮想マシンからsteamcmdを使用している場合、イメージ内にsentryと設定ファイルを含めることでSteamガードが毎回プロンプトされないようにすることができます。 sentryファイルは、<Steam>\ssfn<hashOfNumbers>内にあり、configファイルは<Steam>\config\config.vdf内にあります。

SteamPipeビルドプロセスでは以下の手順が発生します:
  1. Steamcmd.exeは自身を最新版に更新します。
  2. Steamcmd.exeは、指定されたビルダーのSteamアカウントを使用してSteamバックエンドにログインします。
  3. アプリビルドの開始がMDS(マスターデポサーバー)に登録されます。それにより、ユーザーがこのアプリを修正するのに必要な権限があるかどうかを確認します。
  4. コンテンツフォルダーのファイルとデポビルドの設定ファイルで定義されたフィルタールールに基づき、アプリビルド内の各デポのファイルリストが生成されます。
  5. 各ファイルはスキャンされ、約1MBのチャンクに分割されます。 デポが過去に構築されていた場合、この分割プロセスでは、変更のないチャンクはできるだけそのまま維持されます。
  6. 新しいファイルのチャンクは圧縮され、暗号化されてからMDSにアップロードされます。
  7. このデポバージョンの最終マニフェストが生成されます。各マニフェストは一意の64ビットのマニフェストIDで識別されます。
  8. デポがすべて処理されると、MDSはこのアプリビルドの処理を終了し、グローバルビルドIDを割り当てます。
  9. 構築が完了すると、ビルドの出力先フォルダーに*.csm、または*.csdファイルが作られます。 これらは一時ファイルで削除することも可能ですが、これらがあるとその後のビルド時間が短縮できます。


ビルドが完了すると、アプリのビルドページに表示されます(この例では、https://partner.steamgames.com/apps/builds/1000)。 デフォルトブランチ、または任意のベータブランチのビルドをライブに設定することができ、数分で、ユーザーがこのアップデートをダウンロードできるようになります。

高度なビルドスクリプト


アプリに、複雑なファイルマッピングルールを持つデポが多数ある場合は、アプリのビルドスクリプトによって参照されるデポごとのデポビルドスクリプトを作成できます。 まず、アプリのビルドスクリプトで使用可能なパラメーターを見てみましょう:

  • AppID -ゲームのAppID。 アップロードを行うSteamパートナーアカウントには「アプリのメタデータ編集」権限が必要です。
  • Desc -説明は、アプリ管理パネルの「ビルド」セクションにのみ表示されます。 これは「ビルド」ページでビルドをアップロードした後、いつでも変更できます。
  • ContentRoot -ゲームファイルのルートフォルダーです。絶対パスまたはビルドスクリプトファイルからの相対パスを指定できます。
  • BuildOutput -このディレクトリは、ビルドログ、デポマニフェスト、チャンクキャッシュ、および中間出力の保存先です。 最適なパフォーマンスを得るには、ビルドの出力に別のディスクを使用します。 これにより、ディスクへの入出力処理の負荷が分散され、コンテンツのルートディスクが読み取り要求を処理し、出力ディスクが書き込み要求を処理できるようになります。
  • Preview -このタイプのビルドは、ログとファイルマニフェストのみをビルドの出力フォルダーに出力します。 プレビュービルドの作成は、アップロードスクリプトの反復処理やファイルマッピング、フィルター、およびプロパティが意図したとおりに機能していることを確認するのに良い方法です。
  • Local -これをSteamPipeローカルコンテンツサーバー(LCS)のhtdocsパスに設定します。 LCSビルドはコンテンツをあなたのHTTPサーバーにのみ配置するので、Steamクライアントを使用してゲームのインストールテストをすることができます。
  • SetLive -ビルドが成功した場合に、自動的にライブに設定されるベータブランチ名。空白の場合は設定されません。 「default」ブランチは自動的にライブに設定できないことに注意してください。 アプリ管理パネルから設定する必要があります。
  • Depots-このセクションには、各デポのすべてのファイルマッピング、フィルター、ファイルプロパティか、またはデポごとの個々のスクリプトファイルへの参照が含まれます。

すべてのオプションの使用しているアプリビルドスクリプト例「app_build_1000.vdf」
"AppBuild" { "AppID" "1000" // あなたのAppID "Desc" "Your build description here" // このビルドの内部的な説明 "Preview" "1" // プレビュービルドのみに設定し、何もアップロードしません "Local" "..\..\ContentServer\htdocs" // コンテンツをSteamにアップロードせず、ローカルコンテンツサーバーに配置します "SetLive" "AlphaTest" // このビルドをベータブランチでライブに設定します "ContentRoot" "..\content\" // このスクリプトファイルからの相対的なコンテンツのルートフォルダー "BuildOutput" "D:\build_output\" // 最適なパフォーマンスを得るために、ビルドキャッシュとログファイルを別のドライブに置きます "Depots" { // 各デポのファイルマッピング情報は、別のスクリプト内にあります "1001" "depot_build_1001.vdf" "1002" "depot_build_1002.vdf" } }

このアプリビルドスクリプトは、すべてのファイルマッピングとファイルプロパティを指定する2つのデポビルドスクリプトファイルを参照します。 以下の設定がデポビルドスクリプトで利用できます(アプリビルドスクリプトにセクションが直接含まれている場合も同様に利用できます)。

  • DepotID -このセクションのDepotID
  • ContentRoot -オプションで、デポごとにアプリビルドスクリプトからContentRootフォルダーを上書きします。
  • FileMapping -これにより、単一のファイルまたは一連のファイルがローカルコンテンツルートからデポにマップされます。 デポにファイルを追加する複数のファイルマッピングが考えられます。 LocalPathパラメーターは、コンテンツルートフォルダーへの相対パスであり「?」や「*」などのワイルドカードを含めることができます。 再帰検索が有効の場合は、サブフォルダー内の一致するファイルにも適用されます。 DepotPathパラメーターは、選択したファイルのデポ内での場所を指定します(特別なマッピング指定がない場合は「.」のみを使用します)
  • FileExclusion -マップされたファイルを再度除外します。「?」や「*」などのワイルドカードを含めることができます。
  • InstallScript -ファイルをインストールスクリプト としてマークし、ビルドプロセス中にファイルに署名します。 Steamクライアントは、このデポをマウントするすべてのアプリケーションに対して署名を行う必要があることを認識しています。
  • FileProperties -特別なフラグでファイルをマークします:
    • userconfig-このファイルは、ユーザーまたはゲームによって変更されます。 これはアップデートにより上書きされず、ファイルの前のバージョンと異なる場合でも照合エラーを起こすことはありません。
    • versionedconfig -userconfigに似ていますが、デポ内のファイルがアップデートされた場合、ユーザーのゲームがアップデートされるときにローカルファイルを上書きします。 デポ内のファイルのアップデートは、フォーマット変更やバグ修正など必要があるときのみにしてください。

すべてのオプションを使用しているデポビルドスクリプト例depot_build_1002.vdf
"DepotBuild" { "DepotID" "1002" "ContentRoot" "C:\content\depot1002" // アプリビルドスクリプトからContentRootを上書きします "FileMapping" { // 「.\bin」内のすべてのソースファイルとフォルダーは、デポ内の「.\executables」フォルダーにマップされます "LocalPath" "bin\*" "DepotPath" "executables\" "Recursive" "1" // すべてのサブフォルダーを含めます } "FileMapping" { // \\audio内のオーディオファイルをドイツ語版で上書きする "LocalPath" "localization\german\audio\*" "DepotPath" "audio\" } "FileMapping" { // ドイツ語版にインストールスクリプトをデポルートフォルダーにコピーします "LocalPath" "localization\german\german_installscript.vdf" "DepotPath" "." } "FileExclusion" "bin\server.exe" // このファイルを除外します "FileExclusion" "*.pdb" // あらゆる場所のすべての.PDBファイルを除外します "FileExclusion" "bin\tools*" // bin\tools\以下のすべてのファイルを除外します "InstallScript" "localization\german\german_installscript.vdf" "FileProperties" { "LocalPath" "bin\setup.cfg" "Attributes" "userconfig" // このファイルは実行時に変更されます } }

注: これらのスクリプトには任意の名前を付けることができますが、一貫性を保つためにapp_build_<AppID>depot_build_<DepotID>という名前を使用しています。 このマシン上で複数のアプリ用のデポを構築する予定がある場合には、各アプリケーションのビルドスクリプトを整理しやすくするため、各アプリケーション用のスクリプトディレクトリにサブディレクトリを作成することをおすすめします。

アップデートの管理

アプリのリリース後、顧客は「デフォルトビルド」とマークされたビルドを受け取ることになります。 新しいビルドをアップロードするときは、顧客に一般公開する前にテストすることをお勧めします。テストに関する詳細は、Steam上でのテストを参照してください。

ビルドの問題をデバッグ

ビルドがうまくいかなかった場合にエラー情報を探すには、ビルドスクリプトが実行されたコンソールではなく、出力ディレクトリを見てください。 ほとんどのエラー情報は *.ログファイル内に見つかります。
Steamクライアントコマンドとクライアントサイドのファイルを使って問題のデバッグができます:
  • "app_status [appid]"-クライアント上の現在のアプリの状態を表示。
  • "app_info_print [appid]"-このゲームの現在のSteamworks設定(デポ、起動オプションなど)を表示。
  • "app_config_print [appid]"-このゲームの現在のユーザー設定(現在の言語、インストールディレクトリなど)を表示。
  • file "logs\content_log.txt"-ログに記録されたすべてのSteamPipe操作とエラーを表示。
  • file "steamapps\appmanifest_[appid].acf"-このアプリの現在のインストール状況を表示(KeyValuesフォーマット)。

SteamPipeのための効率的なデポの構築

以前のSteamコンテンツシステムは、パッチアップデートをファイルレベルで行っていたため、仮に1バイトの変更があったとすると、すべてのユーザーが新しいファイル全体を受け取る必要がありました。 ゲームが複数のパックファイル(1つの大きなファイルに格納されたゲームコンテンツの集合体)を使用していた場合に、これは非常に非効率的です。 パックファイルのサイズは簡単に1GBを超えることがあるため、アップデートによって不必要に大きなダウンロードが発生していました。 大容量のダウンロードを避ける一般的な方法は、新しいパックファイルを追加して、既に配布済みのパックファイルのコンテンツを上書きすることでした。 これは、アップデートに対して有効ですが、新規ユーザーにとっては既にパッチ対応された不要なコンテンツをダウンロードすることとなり、長期的に見て負担が大きい方法でした。

新しいコンテンツシステムは、各ファイルをおよそ1 MBのチャンクに分割することでこの問題を解決しました。 各チャンクは圧縮され、Steamコンテンツシステムによる配信の前に暗号化されます。 ゲームコンテンツに重複する大型のパーツがある場合、そこは再使用されるため、ユーザーは一度ダウンロードするだけで済みます。 しかしながら、このシステムの真の強みは、効率的なアップデートパッチを構築できることです。 システムがパッチを構築する間、新コンテンツにおける既知のチャンクがスキャンされます。 既知のチャンクが見つかれば、再利用されます。 こうすることで、大きなファイル内に数バイトの大きさの変更や追加があった場合、ユーザーがダウンロードするべきは差分だけとなります。

ほとんどのケースで問題なく実行できますが、ゲームのコンテンツレイアウトをデザインする際に避けるべき事項がいくつかあります。 ゲームデータの圧縮や暗号化は避けるのが得策です。 これはSteamコンテンツシステムによって、既に配信中のダウンロードやリテール版ディスクで実行済みです。 重複で行うと、差分パッチの効力が減少します。 圧縮および暗号化が推奨されるのは、パッケージファイル内の各アセットが個別に圧縮および/または暗号化される場合のみです。 そうしないと、1つのアセットを変更する際に(変更されていない可能性がある)他のいくつかのアセットのダウンロードが常に必要になります。

If you package multiple assets in a pack file, make sure that with each re-packaging, no unnecessary changes are made. ファイル名はビルドマシンによって変わるため、オリジナルのソースファイルのフルネームをディスクに含める方法は問題になりがちです。 その他、各ファイルにビルドのタイムスタンプを含むことも悪い例です。 可能であれば、パックファイルの最後に新コンテンツを追加して、存在するファイルの順序を保ってください。 また、パックファイルのメタデータ(各アセットのオフセットとサイズ)は一つの場所に格納するようにし、アセットデータと共に散在させないでください。 BeyondoCompareのようなバイナリ差分チェックツールを使って、パックファイルの2つのビルドを比べ、何百もの不要な変更が現れないようにしてください。

Using pack files is especially useful to package lots of small files (<1 MB) into a single larger file. This will improve download speed and disk IO performance. But you might also want to avoid to put all your assets in a single huge pack file since Steam needs to copy & patch the whole file even if only a small subset of it changed. A good start would be to bundle resources of the same type together in pack files smaller than 4GB each.

If you follow these rules you will minimize patch sizes and only new content will need to be downloaded. Your customers will thank you for that and you will be able to increase the quality of your product by shipping more updates.

If you suspect that your game packaging is not interacting well with the SteamPipe update process, please contact your Valve representative and we can look into enabling advanced features to help with this.

リテール版インストールディスクの構築

To build retail install disc for SteamPipe games, you must first setup a build project file.
In this example, the SKU file is called "sku_goldmaster.txt":
"sku" { "name" "Test Game Installer" "appid" "202930" "disk_size_mb" "640" "included_depots" { "1" "202931" "2" "202932" } }
Some tips to keep in mind:
  • リテール版ディスクのイメージを書き込む新しいフォルダーを作成してください。例 "D:\retail_disks" このincluded_depotsセクション内のデポのみが追加され、除外セクションは無くなります。
  • -devと-consoleコマンドラインパラメーターと一緒にSteam.exeを使用するか、steamcmd.exeを使用して、インストーラーイメージを作成してください。 いずれの場合も、"build_installer"コマンドを使用してください。
  • リテールディスクに収録する予定のゲームと全デポを所有するSteamアカウントでログインします。 それ以外は、アカウントに特別な権限は必要なく、誰でもビルドインストーラーディスクを作成できます。
  • Steam.exeを使用する場合、その他すべてのダウンロードは終了してください。
  • コンソールページで、build_installerコマンドを実行します:
    build_installer sku_goldmaster.txt "D:\retail_disks"
    すべてのデポが再ダウンロードされるため、初回はビルドに時間がかかることがあります。
  • ローカルコンテンツサーバーを使用してゴールドマスターをビルドするには、次を実行します:
    @localcontentserver "webserver"
    build_installer sku_goldmaster.txt "D:\retail_disks" local
    「リテール版インストールディスク」とローカルのゲームのバックアップは基本的に同じなので、出力されたものは「バックアップ」を参照します。
  • 「Backup finished for AppID...」という表示が出れば、インストールディスクのイメージの完成です。 バックアップビルドの詳細については、logs\backup_log.txtを参照してください。
  • 「D:\retail_disks」内に新しいファルダ― (Disk_1、Disk_2 など) が作成され、「disk_size\mb」で指定した通り、それぞれは 640 MB 以下の大きさになります。 各ディスクフォルダーに、それぞれのデポ用の「sku.sis」ファイルと.csdおよび.csmが作成されます。 より大きなデポの場合は、複数のディスクに収録されることになります。 すべてのリテール版インストールディスクのコンテンツは、ローカルのゲームバックアップファイルとは異なり、常に暗号化されます。 SDK GM設定ファイル(setup.exe, setup.ini など)を最初のディスクのフォルダーにコピーすると、リテール版ディスクのインストーラーが完成します。
  • macOS用のGMを作成する場合には、必ず、Mac上でgoldmaster/disk_assets/SteamRetailInstaller.dmgイメージを開くようにしてください。 そして、その中にあるアプリをあなたのメディアのルートにコピーします。 また、インストーラーを見分けやすくするために、インストールアプリの名前を変更したり、アイコンのブランド化や、ウィンドウの装飾をお勧めします。
  • macOS用のマルチディスクGMを作成する場合は、各ディスクのボリューム名を一致させてください。 ボリューム名はマウントパスの一部となるため、名前が一致しない場合、インストーラーが次のディスクを見つけることができません。

任意でベータブランチからリテールインストーラを構築する

The process above will create a retail installer based on the default branch. If you need to create an installer based on a beta branch, you must first create a beta branch named "baseline". Then use the following command to build from the baseline branch:
build_installer <project file> <target folder> <beta key> <beta pwd> steamcmd ex: build_installer sku_goldmaster.txt "D:\retail_disks" baseline superSecret script ex: steamcmd.exe +login user_name password +build_installer "..\Build\GameDataSku.txt" c:\destination beta_key beta_password +exit

リテール版インストーラーからDLCをインストールする

In some circumstances, you may wish to create a retail installer that includes your DLC packages. In such cases, the process to create the installer requires only a few changes.
In "sku_goldmaster.txt", include the DLC AppIDs under the "included_depots" section. Once you have run the "build_installer" process, find the generated sku.sis file for the installer and open it with a text editor.
Add the DLC AppID in the "apps" section. For example, if I had a game with AppID 1000 and DLC AppID 1010, I would adjust the "apps" section as follows:
"apps" { "0" "1000" "1" "1010" }
This will ensure that Steam checks for ownership of the DLC and prompt the user for a key if the DLC is not owned by the account that they are logging into on Steam.

複数のApp ID用のリテール版インストーラーを単一ディスク/インストールパッケージ上に作成する

To build a GM containing multiple Steam Pipe apps. Build each app installer one by one but point them all to the same output folder. Each build will merge itself with the already existing install image.

リテール版インストールディスクのカスタマイズ

See Customizing a gold master for more details on customizing your retail install disk.

リリース前のゲームのプリロード

By default, all content is always encrypted, on all retail discs and on all content servers. Switching a game to preload mode means owners can download the content, but it stays encrypted on the users' disk and can't be played. Once the game becomes officially released, Steam will decrypt the preloaded content and the user can play the game.

Switching a game to preload mode is recommended in these cases:
  • ゲームが実際に利用可能になる前に、製品キー付きでリテールディスクを出荷する場合(ゼロデイ著作権侵害)。
  • 予約購入ゲームで、ファイルサイズが20GBを超える場合。

Please submit a ticket to Steam Publishing if you believe your game requires preloading.

DLCの構築

DLC is built as a depot of the base game. See the ダウンロードコンテンツ (DLC) documentation for more information.

SteamPipeのトラブルシューティング

steamcmd経由でログインする際に「Login Failure: Account Login Denied Failed」と表示される

Cause: Probably SteamGuard is preventing login. Resolution:
  • ログインしようとしているアカウントに登録したメールアドレスをチェックして、Steamサポートからのメールを探してください。 メールのコードをコピーします。
  • 次のsteamcmdを実行します:set_steam_guard_code <code>
  • steamcmdからもう一度ログインしてください: Steam>login <buildaccount> <password>

ダウンロードの問題の一般的なトラブルシューティング

  • コンピューター、モデム、ルーターなどを再起動する。
  • ファイアウォールの設定を確認する。 新システムはport 80(HTTP)とその他すべてのSteamポートを必要とします。必要なポートの一覧は こちらを参照してください。
  • 一時的にローカルのウイルス対策、スパムブロックプログラムを無効にする。
  • Steamクライアント内の設定->ダウンロード地域を確認する。 お住いの地域と一致させてください。
  • ダウンロードを中止して、アンインストールして再度ゲームをインストールする(マニフェストキャッシュを消去します)。
  • Steamを終了し、Steamインストールフォルダー内のappcacheとdepotchacheという2つのフォルダーを消去する。
  • Steamダウンロード地域をどこか遠い場所に設定する。 これは近くのコンテンツサーバーが破損したデータを提供している場合に有効です。

Mac・Linuxビルドがファイルをインストールしないのは 何故でしょうか。

If you're testing via Steam the installation of your game or application across multiple platforms, you may run into a situation where the build deploys on Windows but doesn't deploy any files on Mac or Linux despite your SteamPipe process being setup to upload Mac and/or Linux depots. There is a step that is easily missed which involves adding your alternate Depots to the Package being deployed. You can check what depots are included in a package via the following steps:
  1. ゲームのアプリ管理ページを開きます。
  2. 「関連アイテム表示」セクションで、「関連する全てのパッケージ、DLC、体験版、ツール」をクリックします。
  3. ダウンロードしようとしているパッケージのタイトルをクリックします。
  4. 含まれるデポセクションを確認します。
  5. デポの追加/削除ボタンを使って、パッケージに正しいデポが割り当てられていることを確認します。
There are a number of discussion threads about this that may also assist:

steamcmd.exeを実行すると、次のエラーが表示されます:「SteamUpdater:更新するためにインターネットにアクセスする必要があります。 ネットワーク接続をご確認のうえ、もう一度お試しください。」

Resolution: Go to Internet Options->Connections->Lan Settings and check Automatically detect settings.

アプリのビルドを実行すると、以下のエラーが表示されます:"ERROR! Failed 'DepotBuild for scriptname.vdf' - status = 6."

Possible Causes:
  • アカウント上にアプリに対する権限が無い。
    • app_build.vdf内のappIDが正しいことを確認します。
    • ビルドアカウントにそのappIDにおける適切な権限があることを確認します。
  • Steamcmdがデポコンテンツを見つけられない。
    • app_buildapp_buildスクリプト内のcontentrootの値が、スクリプトファイルの位置に対して有効なパスであることを確認します。
    • depot_buildスクリプト内のLocalPathの値が、app_buildスクリプト内パスの位置に対して有効なパスであることを確認します。 パスに実際のコンテンツが含まれていることを確認します。

アプリのビルドを実行すると、以下のエラーが表示されます:"ERROR! Failed to get application info for app NNNNN (check login and subscription)"

This means that Steam can't retrieve information about the app, either because it doesn't exist or the user doesn't have access to the app.
  • NNNNNがアプリ用に割り当てられたapp IDであることを確認します。
  • app_build.vdf内のappIDが正しいことを確認します。
  • 新規のappIDの場合、Steamworksにおけるアプリ管理の設定が公開済みであることを確認します。 新規アプリでは、インストールタブ内でSteam Pipeインストールディレクトリ、Steam Pipeタブ内にデポ、公開タブにすべての変更が存在しているはずです。
  • 以上すべて問題なければ、アカウントがapp IDを所有していることを確認してください。

起動時に次のエラーが表示されます:「[AppName]のインストール中にエラーが発生しました」

Possible Causes:

起動時に"Error code 15"が表示されます

This is the CEG servers rejecting the request to CEG the exe. Check the release state on the game page. If it is not 'playable', you will need to request Steam keys that override the release state.

起動時に「Steamサーバーが混みあっているため、あなたのリクエストを処理することができません。
Error Code (2)」と表示されます

This is the CEG servers failing to find a matching CEG exe. Double check that you have a working CEG executable on the CEG tab of your app admin. Click the 'status' button to make sure that it's propped.

Steamcmdコマンドが何か、またはどのように使うかを思い出せません。

Use the 'find' command in steamcmd to search for any steamcmd command. It will do partial matching on the command name and it will list out the command syntax.
Steam>find build_installer ConVars: Commands: build_installer : <project file> <target folder> <beta key> <beta pwd>