ソースから Stingray をビルドする

このトピックでは、ソース コードおよびライブラリのローカル コピーから Stingray エンジンおよび編集ツールをビルドする方法について説明します。

• 必要なすべてのプラットフォームに対して、ソース コードの最新のローカル コピーが必要です。該当するのは、メインの stingray リポジトリと、アクセス可能な任意のプライベート コンソール プラットフォームのサブモジュールです。
• Stingray ソース リポジトリのブランチの readme.md ファイルに記述されているすべてのツールをインストールする必要があります。
• Stingray ライブラリ フォルダを直接指すように SR_LIB_DIR 環境変数を設定する必要があります。「ライブラリの従属関係」を参照してください。

• ビルド システムで主に最初に使用するのは、Stingray ソース コード リポジトリの最上位にある make.rb スクリプトです。このスクリプトを使用して、製品のあらゆる部分をビルドします。すべてのターゲット プラットフォームを対象とし、すべてのビルド設定で行う必要があります。
• make.rb は CMake を利用してランタイム エンジンのビルドを設定し、実行します。さらに msbuild ツールを呼び出して、Stingray エディタ バックエンド アプリケーションと従来の編集ツールに関する C# ソリューションを構築します。

• ターゲット プラットフォームが 64 ビット版 Windows の場合、編集ツールをビルドできるのは Windows マシンのみです。
• iOS を除くすべてのターゲット プラットフォームでは、ランタイム エンジンを Windows マシンでビルドできます。iOS の場合は Mac OS X マシンでビルドする必要があります。

既定により、make.rb は生成されたすべてのバイナリおよびその他の必須ファイルを build/binaries サブフォルダに格納します。Windows で完全ビルドを行う場合、この出力フォルダの内容は次のとおりです。

• core: エディタのビューポートとレンダラー設定用の Lua スクリプト。
• editor: Stingray エディタの実行可能ファイル。
• engine
  • <platform>: 各プラットフォームのエンジン ランタイムおよびデータ コンパイラ
• tools: 従来の Bitsquid ツール(Unit Editor や Material Editor など)。
• tools_external: サードパーティ製の編集ツール

--output コマンドライン オプションを使用して、別の出力場所を指定できます。

すべてをビルドする最も簡単な方法は、64 ビット Windows マシンで make.rb を実行することです。

> make.rb

これを実行すると、必要なすべてのライブラリがコンピュータにダウンロードされます。その後、既定の dev ビルド設定を使用して Stingray エディタ、ランタイム エンジン、および従来のオーサリング ツールがビルドされます(「Stingray のビルド環境設定について」を参照)。また、Stingray エディタで必要な core コンテンツ ファイルも出力フォルダにコピーされます。

特定のプラットフォームでランタイム エンジンをビルドするには、--platform コマンドライン パラメータを追加します。

たとえば、次のようになります。

> make.rb --platform android

使用可能なプラットフォームの値は win32、win64、ios、android、xb1、ps4 です。

iOS のエンジンをビルドするには、Mac で make.rb スクリプトを実行する必要があります。iOS は Mac 上でビルドできる唯一のターゲットであるため、プラットフォーム ターゲットの指定を省略することができます。

Xcode 8 ではコード署名が必須です。iOS 8 を使用する場合は、make.rb: SR_IOS_DEVELOPMENT_TEAM を実行する前に、環境変数を 1 つ設定する必要があります。この環境変数の値には、Apple 開発チームの数字 ID を設定します。たとえば、次のようになります。

export SR_IOS_DEVELOPMENT_TEAM=5557727

Xbox One のエンジンをビルドするには:

• Xbox One プラットフォーム SDK がインストールされているフォルダを指すように DurangoXDK 環境変数を設定する必要があります。

この環境変数は、SDK インストーラによってすでに設定されています。

PlayStation 4 のエンジンをビルドするには:

• PlayStation 4 プラットフォーム SDK がインストールされているルート フォルダを指すように SCE_ROOT_DIR 環境変数を設定する必要があります。
• Stingray で必要なバージョンのプラットフォーム SDK が格納されているフォルダを指すように SCE_ORBIS_SDK_DIR 環境変数を設定する必要があります。

これの環境変数は、SDK インストーラによってすでに設定されています。

既定のビルド プロセスが機能するように設定したら、このプロセスをカスタマイズして、さまざまな機能やコンポーネントのサポートを追加または除去することができます。

make.rb スクリプトの動作をコントロールするには、コマンド ラインでさまざまなオプションを指定します。これらの詳細については、以下を実行してください。

> make.rb --help

ビルド プロセスをさらにカスタマイズするには、まず make.rb のすべての手順を調べて、このプロセスの主な手順について理解します。CMake ビルドは cmake サブフォルダ内にあるスクリプト、およびソース ツリー全体に分散している環境設定ファイルを利用します。CMake に精通しているユーザがビルドを詳細に変更する場合は、これらのファイルを自力で修正することができます。

システムの動作を理解する上で役立つ背景情報については、CMake のドキュメントを参照してください。