Client SDK for Cocos2d-x 導入手順
1 はじめに
Client SDK for Cocos2d-x の 導入手順について解説します。
Cocos2d-x および C++ での開発基礎知識をお持ちの開発者を前提に記載しています。 そのため、Cocos2d-x と C++ の説明については割愛します。
2 動作環境
Client SDK for Cocos2d-xは以下の環境で動作します。
2.1 対応Cocos2d-xバージョン
- cocos2d-x ver2.2.6以降
- cocos2d-x ver3.0.0以降
2.2.6以前の場合、64bit対応は非サポートとなります。
2.2 対応プラットフォーム
- iOS
- Android
2.3 開発環境
- Xcode ( iOS向けビルドを行う場合 )
- Eclipse ( Android向けビルドを行う場合 )
- Android Studio ( Android向けビルドを行う場合 )
3 SDK導入準備
3.1. Client SDKのダウンロードと解凍
Client SDKパッケージファイルをコンソールからダウンロードしてください。
ダウンロードが完了しましたら、ダウンロードしたSDKを任意の場所に解凍してください。
解凍後は以下のようなフォルダ構成になります。
| フォルダ・ファイル名 | 説明 |
|---|---|
| Magellan | Client SDK(共通)ライブラリヘッダ |
| MagellanPackageVer2 | Cocos2d-x ver2.x.x用 Client SDKライブラリ |
| MagellanPackageVer3 | Cocos2d-x ver3.x.x用 Client SDKライブラリ |
3.2 Client SDKライブラリの選択
MAGELLAN_ClientSDKforCocos2dx_vXXX.zipは Client SDKライブラリ と ライブラリヘッダ を格納したパッケージです。
Cocos2d-xバージョンとプラットフォームによって導入するClient SDKライブラリが異なります。
お使いの開発環境に応じてClient SDKライブラリを選択してください。
3.2.1 Cocos2d-x バージョン
Cocos2d-xのversion2.x.xとversion3.x.xで導入するClient SDKライブラリが異なります。
ご使用のCocos2d-xバージョンに該当するフォルダを選択してください。
| Cocos2d-xバージョン | 対象フォルダ |
|---|---|
| version2.x.x | MagellanPackageVer2 |
| version3.x.x | MagellanPackageVer3 |
3.2.2 プラットフォーム
プラットフォーム(iOS・Android)で導入するClient SDKライブラリが異なります。
ビルドを行うプラットフォームに該当するフォルダを選択してください。
| プラットフォーム | 対象フォルダ |
|---|---|
| iOS | ios |
| Android | android |
Androidビルドを行う場合はさらに、ビルドターゲットで導入するライブラリが異なります。 ターゲットに該当するフォルダを選択してください。
3.3 開発環境の選択
ビルドを行うプラットフォームに応じてSDKを導入する開発環境を選択してください。
| プラットフォーム | 開発環境 |
|---|---|
| iOS向けビルドを行う場合 | Xcode |
| Android向けビルドを行う場合 | Eclipse または Android Studio |
Android StudioはCocos2d-x version3.7以降の環境で使用可能です。
4 SDK導入手順
以下のようなCocos2d-xプロジェクトフォルダ構成を前提に、Client SDK for Cocos2d-xの導入手順について解説します。
MAGELLANシステムを利用するには、SDK導入準備 で準備した
Client SDKライブラリとライブラリヘッダを開発プロジェクト環境にインポートする必要があります。
4.1 ライブラリヘッダインポート(Xcode/Eclipse共通)
ライブラリヘッダ(Magellanフォルダ）を開発プロジェクト環境の任意の場所（ここではMagellanSample/Classes配下）に配置してください。
4.2 ヘッダ検索パスの設定（Xcode）
- 設定済みのPath配下にライブラリヘッダ(Magellanフォルダ）をコピーした場合、本手順は不要です。
4.2〜4.3はXcode環境にClient SDK for Cocos2d-xを導入する場合に必要な手順となります。
Eclipse・Android Studioを使用する場合はClient SDKライブラリインポート(Eclipse/Android Studio)を参照してください。
検索パスの設定はXcodeプロジェクト設定の編集画面にあるBuild Settings > Search Pathsで行います。
ターゲットのSeartch Paths > Header Search Paths項目に以下の値を設定してください。
$(SRCROOT)/../Classes
これで開発プロジェクト環境でMagellanフォルダ（ライブラリヘッダ）が参照可能となります。
4.3 Client SDKライブラリインポート（Xcode）
Xcodeプロジェクトが参照するライブラリはパスで管理されています。
パスはBuild Settings > Search Paths > Library Search Pathsで確認することができます。
何もライブラリを使用していない場合は以下のようにパス設定値がない状態になります。
まず SDK導入準備 で選択したフォルダ内に格納されているlibMagellan.aファイルを開発プロジェクト環境の任意の場所（ここではMagellanSample/proj.ios_mac/ios配下）に配置してください。
次にXcodeプロジェクト設定の編集画面にある、Build Settings > Build Phasesを開きます。
Build Settings > Build Phases > Link Binary With Librariesを展開後、+アイコンを選択します。
すると以下のような画面が表示されます。ここで Add Other を選択します。
先ほど配置したlibMagellan.aをフォルダ内から選択、Openを選択します。
これでプロジェクトにlibMagellan.aがインポートされました。
続いて、ライブラリリンク確認をXcodeプロジェクト編集画面のBuild Settings > Search Paths > Library Search Pathsで行います。
libMagellan.aを格納しているフォルダパスMagellanSample/proj.ios_mac/iosがライブラリ参照パスとして追加されています。
4.4 Client SDKライブラリインポート(Eclipse/Android Studio)
まず SDK導入準備 で選択したフォルダ内に格納されている下記2フォルダを開発プロジェクト環境の任意の場所に配置してください。
| フォルダ | 説明 |
|---|---|
| armeabi-v7a | Client SDKライブラリ：armeabi-v7a用 関連ライブラリ： curl, mosquitto |
| x86 | Client SDKライブラリ：x86用 関連ライブラリ： curl, mosquitto |
Eclipseの場合
（ここではMagellanSample/proj.android/jni/libs配下）
Android Studioの場合
（ここではMagellanSample/proj.android-studio/app/jni/libs配下）
次にjniフォルダ内のあるAndroid.mkファイルを編集します。
Android.mkファイルに以下定義を追加してください。
LOCAL_LDLIBS := -L$(LOCAL_PATH)/libs/$(TARGET_ARCH_ABI) -lmagellan -lcurl -lmosquitto
LOCAL_STATIC_LIBRARIES := cocos2dx_static magellan curl mosquitto
以上で Client SDK for Cocos2d-xの導入は全て完了となります。
