サイトのトップへ戻る

Cocos2d-x ドキュメント 日本語訳

サイト内検索

Cocos コマンドラインツール



cocos コマンドラインツールとは何ですか?

Cocos2d-x には cocosと呼ばれるコマンドラインツールが付属しています。 新たに Cocos2d-x アプリケーションを作成するだけでなく、作成したアプリケーションを 実行したりデプロイしたりできるクロスプラットフォームツールです。 cocosiosandroidmaclinuxwin32wp8_1wp10web、といった cocos2d-x がサポートされている全てのプラットフォームで動作します。 特に必要でなければ、統合開発環境を使用する必要はありません。 cocosは多くの機能を持っているので、それらを機能ごとのグループに別けて見てみましょう。



cocosをセットアップする

/setup.py を実行して、使用するPATHを適切にセットアップするのは良い考えです。 そうすることで Cocos2d-x とその関連ツールを実行できるようになります。例:


# Option 1
> ./setup.py

# Option 2
> python setup.py

OS X環境であれば、 ~/.bash_profileに数行追加して文字コードを UTF-8に設定するのも良い考えです。 例:

export LC_ALL=en_US.UTF-8
export LANG=en_US.UTF-8

このコードを追加した後には、source ~/.bash_profile を実行するか、シェルを再起動する必要があります。



Testing your path for cocos

It is necessary for cocos to be in your path or to specify the complete path to it when using it. An easy test:

> cocos -v

1.2のような出力が表示された場合は、全ての設定ができています。 それ以外の表示された場合は、cocosの位置を PATHに追加する必要があります。

OS X環境では、PATHを更新したり\tools\cocos2d-console\binのフルパスを変更した後には source ~/.bash_profile を実行してください。



新規プロジェクトを作成する

新規プロジェクトを作成するには、 cocos new コマンドを使用します。 このコマンドは、以下の形式で実行します:

cocos new <game name> -p <package identifier> -l <language> -d <location>

例:

cocos new MyGame -p com.MyCompany.MyGame -l cpp -d ~/MyCompany

cocos new MyGame -p com.MyCompany.MyGame -l lua -d ~/MyCompany

cocos new MyGame -p com.MyCompany.MyGame -l js -d ~/MyCompany

上記のコードでは、 Cocos2d-x のソースコードを使って新規プロジェクトが作成されています。 pre-built ライブラリを使って新規プロジェクトを作成したい場合は、-t binaryの追加フラグを渡す必要があります。 例:

cocos new MyGame -p com.MyCompany.MyGame -l cpp -d ~/MyCompany -t binary

pre-built ライブラリを作成していない場合は、作成方法については以降の項目を参照してください。

cocos new --helpを実行して、他のオプションやプラットフォーム固有のオプションを表示することができます。



プロジェクトをコンパイルする

コードを変更したらそれをコンパイルする必要があります。 We all know this has to happen, let's go through it. コンパイルするためのコマンドは以下の形式で実行します:

cocos compile -s <path to your project> -p <platform> -m <mode> -o <output directory>

例:

cocos compile -s ~/MyCompany/MyGame -p ios -m release -o ~/MyCompany/MyGame/bin

cocos compile -s ~/MyCompany/MyGame -p android -m release -o ~/MyCompany/MyGame/bin

cocos compile -s c:\MyCompany\MyGame -p win32 -m release -o c:\MyCompany\MyGamein

There is a lot going on here so let's go over the finer points. -p はあなたがコンパイル対象とする プラットフォームのことです。 -m はモードのことで、 debugrelease を指定します。 このパラメーターを指定しなかった場合は、既定では debug になります。

既にプロジェクトの作業ディレクトリに移動しているのであれば、-sパラメーターと-oパラメーターの設定は任意であると知っておいてください。 上記コードを例にすると、あなたが~/MyCompany/MyGameディレクトリに既に移動している場合はcocos compileコマンドを以下のように短くできます:

cocos compile . -p ios -m release

静寂を意味する -q パラメーターを任意で設定することもできます。 これはコンソールへの出力内容を減らします。上記を例に設定してみましょう:

cocos compile -q -s ~/MyCompany/MyGame -p ios -m release -o ~/MyCompany/MyGame/bin

cocosはたくさんのプラットフォームをサポートしているので、特定のSDKバージョンを対象としたり、コードに署名をしたり、lua用オプションやweb固有オプションなど、プラットフォーム固有のオプションもいくつかあります。 cocos compile --help を実行して、プラットフォームごとで使用可能な全てのオプションを表示することができます。



プロジェクトを実行する

プロジェクトを作成したら、それをコマンドライン上からすぐに実行できます。 cocosはあなたが指定した環境での起動を行います。 コマンドは以下のような形式で実行します:

cocos run -s <path to your project> -p <platform>

例:

cocos run -s ~/MyCompany/MyGame -p ios

cocos run -s ~/MyCompany/MyGame -p android

cocos run -s c:\MyCompany\MyGame -p win32

任意で-mパラメーターを使用して、 debugモードや release モードでの実行を指定することができます。 このパラメーターを設定しない場合、既定では debugとなります。

cocos run -s ~/MyCompany/MyGame -p ios -m release

上記の cocos compile コマンドを使用する際には、 既にプロジェクトの作業ディレクトリに移動しているのであれば、-sパラメーターと-oパラメーターの設定は任意であると知っておいてください。 上記コードを例にすると、あなたが~/MyCompany/MyGameディレクトリに既に移動している場合はstrong>cocos runコマンドを以下のように短くできます:

cocos run . -p ios -m release

web向けに動作させる場合には、動作させたいブラウザを指定することができる追加のパラメーターがあります。 ipアドレスとポート番号を指定することもできます。 これもコマンドラインパラメーターから指定します。 Google Chromeを指定する例:

cocos run -s ~/MyCompany/MyGame -p web -b /Applications/Google\ Chrome.app

cocos run -s ~/MyCompany/MyGame -p web -b C:\Program Files\Google\Chrome\Application\chrome.exe

cocos run -s ~/MyCompany/MyGame -p web -b /usr/local/bin/chrome

cocos run --help を実行して、プラットフォームごとで使用可能な全てのオプションを表示することができます。



プロジェクトをデプロイする

ゲームを公開する準備ができたら、cocosではゲームをデプロイする簡単なメカニズムが用意されています。 上記のコマンド群と同じ様に、何をしたいのか設定を行います。このコマンドは以下のような形式で実行します。:

cocos deploy -s <path to your project> -p <platform> -m <mode>

例:

cocos deploy -s ~/MyCompany/MyGame -p ios -m release

cocos deploy -s ~/MyCompany/MyGame -p android -m release

cocos deploy -s c:\MyCompany\MyGame -p win32 -m release

静寂を意味する -q パラメーターを任意で設定することもできます。 これはコンソールへの出力内容を減らします。上記を例に設定してみましょう:

cocos deploy -q -s ~/MyCompany/MyGame -p ios -m release

cocos deploy --help を実行して、プラットフォームごとで使用可能な全てのオプションを表示することができます。



pre-built ライブラリを作成してソースコードの代わりに使用する

Cocos2d-x はソースコードとpre-builtライブラリの両方の形式で使用することができます。 ソースコードを使用すると、開発者は内部でエンジンが行っている内容を見ることができます。 ソースを使用するとコンパイル時間が増えます。 コンパイル時間を大幅に減らすために、ソースからpre-built ライブラリを作成することができます。 これは、 Cocos2d-xを使用するためにプロジェクトに追加できる静的ライブラリです。 cocos ツールで pre-builtライブラリをコンパイルするのは簡単です。 例:

# remove the 'prebuilt' folder
# without the -m flag, this builds for release mode
# generates libraries for every platform
cocos gen-libs -c

# remove the 'prebuilt' folder
# without the -m flag, this builds for release mode
# generates libraries for just ios
cocos gen-libs -c -p ios

# remove the 'prebuilt' folder
# without the -m flag, this builds for release mode
# generates libraries for just ios and android
cocos gen-libs -c -p ios -p android

# remove the 'prebuilt' folder
# with the -m flag, this builds for debug
# generates libraries for just ios and android
cocos gen-libs -c -p ios -m debug

cocos gen-libs --helpを実行して、プラットフォームごとで使用可能な全てのオプションを表示することができます。



追加のプラグインをインストールする

Cocos Package Managerを使用して、 VRSDKBOXといった追加機能を簡単にゲームに追加できます。 これを支援するための様々なコマンドがあります。例:

# list available packages
cocos package list

# show all packages imported into your project
cocos package info

# update installed packages to the latest versions
cocos package update

cocos package --helpを実行して、プラットフォームごとで使用可能な全てのオプションを表示することができます。



VRをインストールする

VRは簡単にプロジェクトに追加できます! 全ての VR プロジェクトには vrsdkbaseが必要です。 vrsdkbaseVRを使用するためのプロジェクトの設定を担います。 これは簡単にインポートできます:

$ cocos package import -v -b vrsdkbase --anysdk

サポートされているVR SDKを使用している場合は、それをインポートするようにしてください 。例:

# add the GearVR package
$ cocos package import -v -b gearvr --anysdk

# add the Deepoon VR package
$ cocos package import -v -b deepoon --anysdk

# add the Google VR package
$ cocos package import -v -b gvr --anysdk

# add the Oculus VR package
$ cocos package import -v -b oculus --anysdk

詳細情報については、VRの章を参照してください。



SDKBOX プラグインをインストールする

SDKBOX プラグインは Cocos Package Managerを使ってインストールすることができます。例:

# install a package, in this example, Facebook
cocos package import facebook


ユニークなコマンドラインオプション

cocos にはゲーム作成の手助けに使うことができるユニークなオプションがいくつかあります。 これら全てのオプションを見るには、 cocos --helpを実行してください。 これらのオプションについて説明します。.

コマンド 説明
luacompile ゲーム内の lua スクリプトを暗号化します。 これは-m release引数を付けてcocos compileを実行した時に行われます。 開発者はスクリプトを暗号化するためにこれを手動で行うことができます。
jscompile ゲーム内の JavaScript スクリプトを暗号化します。 これは-m release引数を付けてcocos compileを実行した時に行われます。 開発者はスクリプトを暗号化するためにこれを手動で行うことができます。
gen-simulator The simulator powers the preview function in Cocos Creator.
gen-templates バイナリテンプレートを生成します。バイナリテンプレートは、pre-built librariesを使用したプロジェクトで開発を始める際に必要です。 バイナリテンプレートは Cocos Bundle package と Cocos Creatorでも必要になります。