[UE4] プレビュー版SpriteStudioプラグイン　自分のプロジェクトへの導入方法

先日、弊社で開発を担当しております SpriteStudio5 Player for UE4 プラグインのプレビュー版が公開されました！

そこで、このブログでも、本プラグインの導入方法や使用方法について紹介していきたいと思います。

SpriteStudioってなんぞや、という方は、まずはコチラへどうぞ。

まず今回は導入編です。

本プラグインの紹介ページはコチラ、SpriteStudioエディタの入手はコチラ、UE4プラグインの入手はコチラからになります。

１．GitHubからダウンロード

まずは、GitHubの本プラグインのページから、UE4プラグインとサンプルプロジェクトをダウンロードします。

画面右下の「Download ZIP」をクリックして下さい。

もちろんGitHubの使い方が分かる方は、通常通りクローンすればOKです。

プルリクも受け付けていますので、気が付いたことがあれば、どんどん送信して下さい。

２．サンプルプロジェクトを実行

~~サンプルプロジェクトは UE4.4.3 で制作されています。予め、このバージョンをインストールしておいて下さい。~~

~~UE4.5以降のバージョンでは開くことが出来ません。~~

2015/2/26 UE4.7.0 に対応しました。

また、サンプルプロジェクトも UE4.7.0 に切り替えています。

ダウンロードした SS5PlayerForUnrealEngine4-master.zip を解凍したら、下記のフォルダにサンプルプロジェクトの .uprojectファイルが入っています。

SS5PlayerForUnrealEngine4-master\sample\SpriteStudio5Sample

この .uprojectファイルをダブルクリックするか、UE4を起動しこのプロジェクトファイルを開いてみて下さい。

こんな感じで開けばOKです。

このプロジェクトのContentBrowserには、サンプルのActorやHUDのBlueprintが置いてありますので、こちらも是非ご覧下さい。

３．BluePrintプロジェクトへの導入

BluePrintプロジェクトへの導入には、ビルド済みプラグインを使用します。

ビルド済みプラグインは、UE4.7.0 用が配布されています。

導入は最も簡単なので、まずはこちらからお試し下さい。（他バージョンで利用するためには、C++コードからのビルドが必要になります）

まずは、一旦UE4のエディタは閉じておき、自分のプロジェクトの .uprojectファイルが置いてあるフォルダを開きます。

次に、プロジェクトのフォルダの直下に、最初にダウンロードしたzip内の「Plugins」フォルダをそのままコピーします。

「MyProject\Plugins\SpriteStudio5\…」のような形になっていればOKです。

この状態でUE4のエディタを起動し、プロジェクトを開きます。

プラグインがロードされていることを確認します。

メインメニューから[ Window -> Plugins ]を開き、「Plugins」ウィンドウ内の左側のタブの一番下にある「SpriteStudio5」を選択します。

「Enabled」のチェックボックスがONになっていればOKです。

これで、自分のプロジェクトにSpriteStudio5プラグインがロードされました。

一般の方はココまででOKです。

ココから先はC++プログラマ向けの内容になります。

４．C++プロジェクトへの導入

C++プロジェクトへの導入方法は、途中まではBlueprintプロジェクトと同様です。

ダウンロードしたzipから、自分のプロジェクトにPluginsフォルダをコピーして下さい。

このプラグインにはソースコードも含まれるため、C++プロジェクトに導入した場合、プロジェクトのビルド時にプラグインのコードもビルドされることになります。

このプラグインをコピーした後、通常の手順に従って、まずは「Generate Visual Studio project files」を実行することになります。

（Window以外の環境の方はスイマセン；）

しかし、サブスクリプション版のデフォルトの状態では、いくつかのエンジンモジュールを参照していると、この段階でエラーが発生してしまいます。

※UE4.7では、デフォルトの状態でこのエラーは発生しないようです。旧バージョンのUEで使用される場合のみ、下記の手順を参照して下さい。

SpriteStudio5プラグインでも、これらのエラーが発生してしまうモジュールを使用しているため、下記の手順で対応を行う必要があります。

1. UnrealEngineのGitHubから、エンジン本体のコードを取得します。
2. 取得したエンジン本体のコードから、下記のフォルダ以下を取り出します。
  - UnrealEngine\Engine\Source\ThredParty\FBX
  - UnrealEngine\Engine\Source\ThredParty\ForsythTriOO
  - UnrealEngine\Engine\Source\ThredParty\HACD
  - UnrealEngine\Engine\Source\ThredParty\nvTriStrip
  - UnrealEngine\Engine\Source\ThredParty\Windows\DX9
3. これらのフォルダを、エンジンのインストールフォルダの同階層にコピーします。(デフォルトでは C:\Program Files\Unreal Engine\[VERSION]\Engine\Source\ThirdParty)

これで、「Generate Visual Studio project files」が成功するようになります。

あとは、通常通りプロジェクトをビルドして実行すればOKです。

５．UE4.5/4.6への導入

ビルド済みプラグインはUE4.4のみの対応になりますが、ソースコード自体は UE4.4～UE4.7 に対応しています。

但し、UE4.5/4.6 では、エンジン本体のバグにより、実行直後にクラッシュしてしまいます。

これを回避するには、エンジン本体のソースコードを修正する必要があります。

修正方法の詳細やビルド切り替え用の#defineなどは、下記のヘッダファイルにまとめられています。

SpriteStudio5\Source\SpriteStudio5\Public\SsVersion.h

UE4.5/4.6への導入が必要な方は、こちらを参照してビルドを行って下さい。

[UE4] プレビュー版SpriteStudioプラグイン 自分のプロジェクトへの導入方法