Client SDK for Unityの導入手順

1 はじめに

Client SDK for Unity の 導入手順について解説します。

tips用アイコン

Unity および C# での開発基礎知識をお持ちの開発者を前提に記載しています。 そのため、Unity と C# の説明については割愛します。

2 動作環境

Client SDK for Unityは以下の環境で動作します。

2.1 対応Unityバージョン

  • Unity 4.x
  • Unity 5.x

2.2 対応プラットフォーム

  • iOS
  • Android
  • Windowsエディタ
  • Macエディタ

2.3 必要なUnityライセンス

  • Unity Pro

tips用アイコン

Unity4のエディタ上で実行する場合のみ必要となります。

3 SDK導入準備

3.1. Client SDKのダウンロードと解凍

Client SDKパッケージファイルをコンソールからダウンロードしてください。

ダウンロードが完了しましたら、ダウンロードしたSDKを任意の場所に解凍してください。
解凍後は以下のようなフォルダ構成になります。
structure

フォルダ・ファイル名 説明
magellan_unity4.unitypackage Unity4用Client SDK Unityパッケージ
magellan_unity5.unitypackage Unity5用Client SDK Unityパッケージ

3.2 Client SDKライブラリの選択

magellan_unityX.uintypackageはClient SDKライブラリとライブラリヘッダ、プラグインソースを格納したパッケージです。

Unityバージョンによって導入するUnityパッケージが異なります。
お使いの開発環境に応じてClient SDKライブラリを選択してください。

Unityバージョン 対象フォルダ
Unity4 magellan_unity4.unitypackage
Unity5 magellan_unity5.unitypackage

Unity上で展開するとPluginsというフォルダがインポートされます。
Pluginsの構成は以下の通りです。

フォルダ・ファイル名 説明
Android Android用 Client SDKライブラリ
iOS iOS用 Client SDKライブラリとUnityブリッジヘッダ
Magellan Client SDKライブラリを呼び出すプラグインソース
magellan_unity.bundle Unityエディタ(Mac)用 Client SDKライブラリ。
x86 Unityエディタ(Windows x86)用 Client SDKライブラリ
x86_64 Unityエディタ(Windows x86_64)用 Client SDKライブラリ

4 SDK導入手順

MAGELLAN Client SDK for Unityの導入方法について解説します。

4.1 Client SDKのインポート

MAGELLANシステムを利用するにはmagellan_unityX.unitypackage を開発プロジェクトにインポートする必要があります。
以下の手順に従って、Client SDK for Unity を開発プロジェクトに追加します。

Unityを起動した状態で、magellan_unityX.unitypackage をダブルクリックします。 structure

Importing Package 画面でインポートするファイルが一覧で表示されるので、全てのファイルをインポートします。 structure

Importボタンを押下すると、Assets配下に以下のようにインポートされます。 structure

4.2 MagellanBehaviourの配置

MAGELLANシステムを利用するためには、MagellanBehaviour をシーンに配置する必要があります。
MagellanBehaviourは以下のプレハブにアタッチされています。このプレハブをシーンに配置します。

Plugins/Magellan/MagellanBehaviour.prefab

structure

MagellanBehaviourは、MAGELLANシステムを制御するためのスクリプトです。
AwakeでMAGELLANシステムの初期化処理が実行され、OnDestroyで終了処理が実行されます。
初期化処理が完了するとMAGELLANシステムの各機能が使用可能になります。

tips用アイコン

MagellanBehaviour がシーンから削除されるとMAGELLANシステムの機能が正しく動作しないため、複数シーンで使用する場合は MagellanBehaviour が削除されないよう注意する必要があります。

4.3 プラットフォーム設定

tips用アイコン

プラットフォーム設定はUnity5の場合のみ必要な手順となります。

Unity5の場合はプラグインのプラットフォーム設定が必要になります。
下記3つのファイルに対してInspectorで以下の設定を行ってください。

  • Assets/Plugins/magellan_unity.bundle
  • Assets/Plugins/x86/magellan_unity.dll
  • Assets/Plugins/x86_64/magellan_unity.dll

4.3.1 magellan_unity.bundle

structure

  • Select platforms for plugin
    Editorにチェックしてください。
  • Platform settings
    CPUAny CPUOSOSXを選択してください。

4.3.2 magellan_unity.dll(x86)

structure

  • Select platforms for plugin
    Editorにチェックしてください。
  • Platform settings
    CPUx86OSWindowsを選択してください。

4.3.3 magellan_unity.dll(x86_64)

structure

  • Select platforms for plugin
    Editorにチェックしてください。
  • Platform settings
    CPUx86_64OSWindowsを選択してください。

以上で Client SDK for Unityの導入は全て完了となります。