Unreal Engineプロジェクトに Genvid MILE SDK をインストールする。¶
このセクションでは、 Genvid MILE SDK をアンリアル・エンジン 4 または 5 のプロジェクトに統合するために必要な最初の手順について説明します。
In This Section
はじめに¶
Genvid SDK は、現在 Unreal Engine 4.15 から 5.0 をサポートしています。各Unreal Engineバージョンの最新リビジョンを使用することをお勧めします。
Unreal Engine 4.15 から 4.19 では、Visual Studio 2015 toolchain の最新版がインストールされていることを確認してください (Visual Studio 2017 のビルドツールは、Microsoft ダウンロード サイトからダウンロードできます)。
Visual Studio 2015 、 2017 toolchain のインストール手順:
- Visual C++ Build Tools 実行ファイルを起動します。
- Workloads タブで Visual C++ Build Tools を選択します。
- Summary セクションから Visual Studio 2015 を使用するには、以下のコンポーネントを選択します。
- Windows Univeral CRT SDK
- Windows 8.1 SDK
- VC++ 2015.3 v14.00 (v140) toolset for desktop
- .NET Framework 4.5 targeting pack
Unreal Engine 4.20 から 4.27 では、Visual Studio 2017 toolchain の最新版がインストールされていることを確認してください (Visual Studio 2017 のビルドツールは、Microsoft Visual Studio Essentials download サイトからダウンロードできます。ログインには、最低でも無料のアカウントが必要です)。
Unreal Engine 4.25 以降の場合は、Visual Studio Essentials 2019 の使用をお勧めします (Visual Studio Essentials 2019 は、Microsoft Visual Studio のダウンロードページ から入手できます)。詳細については、Unreal Engine 4.25 リリースノート の Platform SDK Upgrades セクションを参照してください。
注釈
- Visual Studio 2015 がインストールされていない場合、 Unreal Engine Cube サンプルのビルド時に次の 2 つの警告メッセージが表示されます。
- これはシステムの仕様であり、ビルド生成が中止されるわけではないので、この警告は無視して問題ありません。
警告メッセージ
CommandEnvironment.SetupBuildEnvironment: WARNING: C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\Devenv.com does not exist. CommandEnvironment.SetupBuildEnvironment: WARNING: Assuming no solution compilation capability.
ゲームフォルダへのインストール¶
注釈
このセクション書では、ゲームの .uproject ファイルがあるフォルダを {UE4_PROJ_ROOT} と呼んでいます。
プラグインをインストールするには、プラグインをゲームディレクトリにコピーします (UE4_PROJ_ROOT)。Genvid プラグインは GenvidPlugin
のフォルダ (engine-integration/ue4/
にあります) で、 UE4_PROJ_ROOT/Plugins
にコピーします。Genvid モジュールは Genvid
フォルダ (engine-integration/ue4/
にあります) で、 UE4_PROJ_ROOT/Source
にコピーします。Engine ディレクトリに入れても構いませんが、再コンパイルが煩雑になるため、お勧めしません (Unreal Engine が直接使用するディレクトリではないため)。
すでに上記を行った場合は、以下のファイルをコピーする必要はありませんが、SDK の新しいバージョンにアップデートする場合は、以下の Genvid Native API ファイルをコピーする必要があります。
api/native/include/genvid.h
->UE4_PROJ_ROOT/Plugins/GenvidPlugin/ThirdParty/GenvidSDK/include/genvid.h
- すべての関数と型を宣言する Genvid Native SDK のヘッダーファイル。
api/native/Win64/Genvid.lib
->UE4_PROJ_ROOT/Plugins/GenvidPlugin/ThirdParty/GenvidSDK/Win64/Genvid.lib
- リンク時に使用する 64-bit のインポートライブラリ。実行時に
Genvid.dll
との関連付けが必要。 api/native/Win64/Genvid.dll
->UE4_PROJ_ROOT/Plugins/GenvidPlugin/ThirdParty/GenvidSDK/Win64/Genvid.dll
- 実行時に使用する 64 ビットの共有ライブラリ。
api/native/Win32/Genvid.lib
->UE4_PROJ_ROOT/Plugins/GenvidPlugin/ThirdParty/GenvidSDK/Win32/Genvid.lib
- リンク時に使用する 32 ビットのインポートライブラリ。実行時に
Genvid.dll
との関連付けが必要。 api/native/Win32/Genvid.dll
->UE4_PROJ_ROOT/Plugins/GenvidPlugin/ThirdParty/GenvidSDK/Win32/Genvid.dll
- 実行時に使用する 32 ビットの共有ライブラリ。
engine-integration/ue4/
で、必要なファイルを簡単にコピーする Python スクリプトを提供しています。一度にすべてのファイルをコピーするには、次のコマンドを実行します。
py copy-ue4-plugin.py checkout {UE4ROOT}/MyGame
コピーしたファイルでアップデートを行うマニフェストファイルを作成します。古いマニフェストファイルを検出した場合は、新しいファイルをコピーする前にコンテンツ内のファイルが消去されます。
注釈
SDK バージョン 1.25 をスタートすると、マニフェストファイルは、プラグインフォルダではなくアプリケーションフォルダに配置されます。既存のマニフェストファイルをアプリケーションフォルダに移動して使用してください。
--dry-run
オプションで、スクリプトの動作を実行前に確認することができます。詳細は、 copy-ue4-plugin.py を参照してください。
すべてのファイルをコピーしたら、プラグインが使用できるように、ゲームのビルドスクリプトを変更する必要があります。ゲームのビルドスクリプトに以下の行を追加します。(例、 UE4_PROJ_ROOT/MyGame/Source/MyGame/MyGame.Build.cs
)
PrivateIncludePaths.Add("Genvid/Private");
PublicIncludePaths.Add("Genvid/Public");
PublicDependencyModuleNames.Add("Genvid");
完了後、git レポジトリから Unreal Engineを取得する場合、再度 GenerateProjectFiles.bat
を実行すれば、Genvid モジュールにアクセスできます。