最終更新日 2015/12/14
Cocos2d-x 3.9 の開発環境構築手順をまとめます。
＊2015/11/16に3.9がリリースされました。現在このページは3.9向けに更新中です。一部情報が古い可能性があります。

目次

まえおき

• インストールするCocos2d-xのバージョンは3.9 で、インストール先は C:\cocos2d-x\cocos2d-x-3.9 とします。
• インストールするPythonのバージョンは2.7.9で、インストール先は C:\Python27 とします。
• インストールするApache Antのバージョンは1.9.4で、インストール先は C:\apache-ant\apache-ant-1.9.4 とします。
• Windows版の開発には VisualStudio 2013 を使用します。
  Cocos2d-x 3.9 は C++11 の機能を使用しているため、VisualStudio 2012 以前のバージョンでは動作しません。VisualStudio2012で動作するかは不明です。
  無料の Community 版でも問題ありません。
  最新のVisualStudio2015でも動作します。
• Android版のNDKのバージョンはr10dとします。
  Cocos2d-x3.9はr10cより前のNDKでは動作しないようなので注意してください。

Cocos2d-x本体のインストール

Cocos2d-x 3.9 をインストールします。
ダウンロードしたファイルを解凍して任意のフォルダにコピーするだけです。

1. Cocos2d-xの日本語公式ダウンロードサイト http://jp.cocos.com/products/download/ ( 英語版公式http://www.cocos2d-x.org/download ) にアクセスして、対象のパッケージをダウンロードします。
   Cocos2d-xのDownload v3.9 をクリックしてダウンロードして下さい。
   
2. ダウンロードした cocos2d-x-3.9.zip を解凍します。
3. 解凍された cocos2d-x-3.9 フォルダを C:\cocos2d-x 以下にフォルダごと移動します。
   ↓こんなフォルダ階層になります。
   
4. 以上でCocos2d-x本体のインストールは完了です。

Pythonのインストール

Python 2.7.9 をインストールします。
Pythonとは、後述するsetup.pyやcocosコマンドの内部で使用するスクリプト実行環境です。
ここでは2.7.9をインストールしますが、2.x系であれば問題ありません。
(2015/11/24現在2.x系の最新は2.7.10です)
3.x系は問題が出る場合があるようなので、使用しないほうがよさそうです。

以下、インストール手順です。

1. Python日本語公式サイト http://www.python.jp/ にアクセスします。
2. ページ左側にある Python 2.7.9 の下のダウンロードをクリックして、ダウンロードページに移動します。
   
3. 『Windows x86 MSI Installer』をクリックして、インストーラをダウンロードします。
   (64ビット版より32ビット版の方が問題が起きづらいようなので、64ビットOSでも32ビットを選択します)
   
4. ダウンロードした、インストーラ(python-2.7.9.msi)を実行します。
   1. そのままNextで次に進みます。
      
   2. そのままNextで次に進みます。
      
      ＊上書きインストールの場合「This update will replace your existing Python27 installation.」が表示されます。
   3. 次は、python.exeにパスを通すために少し設定を変更します。
      『Add python.exe to Path』の『×』となっている所をクリックして、『Will be installed on local hard drive』を選択します。
      
      これで、python.exeにパスが通ってpython.exeがどこでも使えるようになります。
      下記のように変わったのを確認したら、Nextで次に進みます。
      
   4. そのままインストールを完了させます。
5. Pythonが問題なく動作するかどうかの確認をします。
   コマンドプロンプトを立ち上げ、

   python --version

   と打ち込んで、

   Python 2.7.9

   と表示されれば、Pythonのインストールは無事完了です。
   
   動かない場合、環境変数がちゃんと設定されているかを確認してください。
   以下のように環境変数は設定されていると思います。
   

Apache Antのインストール

＊Android版が必要でない場合Apache Antのインストールは必須ではありません。
Android版でCocos2d-xをビルドしたい場合はこのタイミングでApache Antをインストールしておきます。
Apache Antはビルドの手助けツールです。
Cocos2d-xで用意されているAndroidのビルドツールの内部でApache Antが使用されています。
以下インストールの手順です。

1. Apache Antの公式サイト http://ant.apache.org/ にアクセスし、ページ左側にある『Binary Distributions』をクリックし、ダウンロードページに移動します。
   
2. 『apache-ant-1.9.4-bin.zip』をクリックし、zipファイルをダウンロードします。
   ＊zipファイルへの直リンク→http://download.nextag.com/apache//ant/binaries/apache-ant-1.9.4-bin.zip
   
3. ダウンロードした『apache-ant-1.9.4-bin.zip』を解凍し、apache-ant-1.9.4 フォルダをそのまま C:\apache-ant にフォルダごと移動します。
   エクスプローラで見ると以下のようになります。
   
4. 以上でApache Antのインストールは完了です。

Cocos2d-xの環境設定

setup.pyという環境変数設定用のツールが付属されおり、対話型でCocos2d-xに必要な環境変数の設定を行えます。
setup.pyによって設定される環境変数は以下の通りです。

COCOS2D_CONSOLE_ROOTにパスが通されることにより、後述のcocosコマンドがどこからでも使えるようになります。

• 上記の通り、Android版の環境を整えたい場合はAndroid SDKおよびNDKの環境設定が必要になります。
  このページでも後述していますが、Android開発環境が整っていない場合 Android開発環境の構築 を参考にしてこのタイミングで開発環境を構築するのが良いかもしれません。
  この時点でAndroidの設定項目をスキップして、後でAndroid環境を設定し、setup.pyを実行する形でも問題ないと思います。
  NDK_ROOTとANDROID_SDK_ROOTの環境変数を設定してるだけ？な気もするので、setup.py自体必要ないかもしれません。

以下、setup.pyによる環境設定の手順となります。

1. コマンドラインから、

   C:\cocos2d-x\cocos2d-x-3.9\setup.py

   を実行します。
2. 設定されていない環境変数がある場合、

   Please enter the path of [環境変数名] (or press Enter to skip):

   という表示が出て、パスを指定するか、もしくはスキップするかを問われます。
   スキップする場合はそのままエンターキーを押し、指定する場合は、パスを指定してエンターキーを押して次に進んでください。
   下記のスクリーンショットは、3.7環境の状態から3.9環境のsetup.pyを実行した際のログです。
   
   すでに旧バージョンのCOCOS2D_CONSOLE_ROOTの環境変数の設定がされている場合はsetup.pyを実行した新しいバージョンの環境で上書きされます。
3. 環境変数を設定した場合は、PCを再起動する旨のメッセージが出るので、PCを再起動しましょう。
4. PCを再起動したら、Cocos2d-xの環境設定は完了です。

Cocos2d-xプロジェクトの新規作成

Cocos2d-xの新規プロジェクトを作成します。
プロジェクトを作成するフォルダは D:\projects 直下とします。
プロジェクト名は『MyGame』とします。

1. コマンドプロンプトを開き、

   cocos new MyGame -p com.mycompany.mygame -l cpp -d D:\projects

   を実行します。
   成功すると、以下の様なログが出力されます。
   
   cocosコマンドが認識出来ない場合は、前項のCocos2d-x環境設定(COCOS2D_CONSOLE_ROOT)に失敗している可能性があります。
   再度設定を行うか、PCの再起動を忘れていないかを確認してください。
   コマンドの内容を軽く以下に説明しておきます。

   cocos	Cocos2d-xのコンソールコマンドです。プロジェクトの作成の他にも、ビルドや実行などがcocosコマンドから可能なようです。
   new	最初の引数には、cocosコマンドの種類を指定します。newは、新規のプロジェクトを作りますよという指定です。
   -p com.mycompany.mygame	パッケージ名を指定します。ここでは適当なパッケージ名を指定していますが、基本的には、[自分のドメイン.ゲーム名]のようなパッケージ名になります。
   -l cpp	使用する言語を指定します。cppはC++言語を使用するという意味です。
   -d D:\projects	プロジェクトを作成するディレクトリを指定します。この場合、D:\projectsに、MyGameというプロジェクト(フォルダ)が生成されます。

2. プロジェクトフォルダが D:\projects\MyGame として生成されていると思うので確認してみてください。

Windows版

前項で作成したMyGameプロジェクトをWindows版としてビルド、実行する手順です。

1. VisualStudio2013(もしくは2012)がインストールされていなければインストールしてください。
   Visual Studio 2013 Communityという、個人で使う分にはProfessionalと何も変わり無いバージョンがリリースされているので、2013をオススメします。(ライセンスの詳細は公式サイトをご覧ください)
   ↓このあたりからダウンロードできます。(本体の他に日本語パックが必要かもしれません)
   Visual Studio Community 2013
   Visual Studio のダウンロード
2. D:\projects\MyGame\proj.win32\MyGame.sln をダブルクリックしてVisualStudio2013を起動します。
3. ツールバーの ビルド＞ソリューションのリビルド で、ソリューションをリビルドします。
   ビルドが開始され、出力ウィンドウにずらずらーっとビルドログが出力されます。
   よく見るとwarningが大量に出ていたりしますが、とりあえず気にしないでください。

   (略)
   6>     ライブラリ D:\projects\MyGame\proj.win32\Debug.win32\MyGame.lib とオブジェクト D:\projects\MyGame\proj.win32\Debug.win32\MyGame.exp を作成中
   6>  MyGame.vcxproj -> D:\projects\MyGame\proj.win32\Debug.win32\MyGame.exe
   6>  D:\projects\MyGame\Resources\CloseNormal.png -> D:\projects\MyGame\proj.win32\Debug.win32\CloseNormal.png
   6>  D:\projects\MyGame\Resources\CloseSelected.png -> D:\projects\MyGame\proj.win32\Debug.win32\CloseSelected.png
   6>  D:\projects\MyGame\Resources\HelloWorld.png -> D:\projects\MyGame\proj.win32\Debug.win32\HelloWorld.png
   6>  D:\projects\MyGame\Resources\fonts\arial.ttf -> D:\projects\MyGame\proj.win32\Debug.win32\fonts\arial.ttf
   6>  D:\projects\MyGame\Resources\fonts\Marker Felt.ttf -> D:\projects\MyGame\proj.win32\Debug.win32\fonts\Marker Felt.ttf
   6>  D:\projects\MyGame\Resources\res\.gitkeep -> D:\projects\MyGame\proj.win32\Debug.win32\res\.gitkeep
   6>  6 個のファイルをコピーしました
   ========== すべてリビルド: 6 正常終了、0 失敗、0 スキップ ==========

   な感じでログが完了していればビルドは成功です。
4. ツールバーの デバッグ＞デバッグ開始 でアプリケーションを実行します。
   HelloWorld なウィンドウが立ち上がれば成功です。
   

Android版

前項で作成したMyGameプロジェクトをAndroid版としてビルド、実行する手順です。
Android版が必要が必要無ければこの項は無視してかまいません。

1. Androidの開発環境が必要です。
   開発環境が整っていない場合 Android開発環境の構築 を参考にして開発環境を構築してください。
   Android NDKも必須です。上記ページを参考に環境を構築してください。
   NDKは、r10を使用してください、r10より古いNDKではビルドできません。
2. 環境変数の設定
   前項のCocos2d-xの開発環境構築で、環境変数の設定が完了している必要があります。
   Windowsのシステム環境変数に以下がきちんと設定されているか確認してください。

   環境変数名	値
   ANDROID_SDK_ROOT	C:\Android\android-sdk
   NDK_ROOT	C:\Android\android-ndk

   これらの環境変数は、後述する build_native.py が内部で参照しています。
3. コマンドプロンプトからビルドを実行
   Eclipseで設定すればEclipse上からビルドできますが、基本としてはCocos2d-xのビルドはPythonファイルで外部からビルドします。
   以下、Pythonファイルからビルドする基本的な手順です。
   ビルドだけで、実行はまだです。
   1. コマンドプロンプトを立ち上げ、プロジェクトのandroidフォルダに移動

      cd /d D:\projects\MyGame\proj.android

   2. 続けて、ビルド用のPythonファイルを実行

      build_native.py

      すると、ビルドが開始されます。
      以下のようなログが出力されて終了すればビルドは成功です。
      
      Warningが結構出ますが、とりあえずスルーで…。
4. Eclipseを起動
   簡単のため、プロジェクト用のEclipseワークスペースとしてMyGameのディレクトリをそのまま指定します。
   Eclipse起動時、もしくはEclipse起動後のツールバーのファイル＞ワークスペースの切り替え＞その他
   で表示されるワークスペース・ランチャーダイアログに、MyGameのパスを指定します。
   
5. Eclipseの設定
   1. ツールバーの ウィンドウ＞設定＞一般＞ワークスペース＞リンクされたリソース で、『新規』ボタンを押します。
      名前は『COCOS2DX』で、ロケーションを『C:\cocos2d-x\cocos2d-x-3.9』にしてOKを押します。(この設定は必要ないかもしれません)
   2. ツールバーの ウィンドウ＞設定＞C/C++＞ビルド＞環境 で、『追加』ボタンを押します。
      名前は『NDK_ROOT』で、値を『C:\Android\android-ndk』にしてOKを押します。
   3. ツールバーの ウィンドウ＞設定＞C/C++＞コード解析 で、『Syntax and Semantic Errors』のチェックを外し、適用ボタンを押します。
6. Cocos2d-xライブラリプロジェクトを追加
   『ファイル＞新規＞プロジェクト』で、新規プロジェクトダイアログを開きます。
   
   『Android＞既存コードからのAndroidプロジェクト』を選択して『次へ』ボタンを押します。
   
   『プロジェクトのインポートダイアログ』が表示されたら、ルート・ディレクトリーの参照ボタンを押し、フォルダーの箇所に

   D:\projects\MyGame\cocos2d\cocos\platform\android\java

   を指定し、OKボタンを押します。
   
   プロジェクト名にlibcocos2dxが表示されていることを確認して、完了ボタンを押します。
   
   パッケージエクスプローラーにlibcocos2dxが表示されていれば成功です。
7. ゲーム本体のプロジェクトを追加
   前項のCocos2d-xライブラリプロジェクトと同じ要領で、ゲーム本体のプロジェクト、今回で言う所のMyGameプロジェクトを追加します。
   手順は前項と全く一緒で、『プロジェクトのインポートダイアログ』のルート・ディレクトリーのフォルダー指定を

   D:\projects\MyGame\proj.android

   とします。
   プロジェクト名にMyGameが表示されていることを確認して、完了ボタンを押します。
   
   パッケージエクスプローラーにMyGameが表示されていれば成功です。
   • 完了ボタンを押した際に、

     プロジェクト説明が無効です

     なエラーが出る場合があります。その場合は、ファイル＞インポート＞一般 ＞既存プロジェクトをワークスペースへ からプロジェクトをインポートしてみてください。
     
8. パッケージエクスプローラーに２つのプロジェクトが追加されているかを確認
   libcocos2dxとMyGame(もしくはproj.android)が存在するか確認します。
   
   上記のようになっていれば、成功です。
9. アプリケーションの実行
   Eclipseのパッケージエクスプローラーのproj.androidプロジェクトを右クリック＞デバッグ＞Androidアプリケーション から開始します。
   Android端末が適切に接続されている、もしくは仮想デバイスが適切に設定されていれば、アプリケーションが実行されるはずです。

旧バージョンの開発環境の構築

旧バージョンのCocos2d-xの開発環境構築手順は以下のページを参照してください。

• Cocos2d-x 3.5 開発環境の構築
• Cocos2d-x 3.4 開発環境の構築
• Cocos2d-x 3.2 開発環境の構築
• Cocos2d-x 3.0 開発環境の構築
• Cocos2d-x 3.0 rc0 開発環境の構築
• Cocos2d-x 3.0 beta2 開発環境の構築