How to use cocos2d.ini

The cocos2d.ini file contains all the needed information to:

• know where the templates are installed
• know where cocos2d-x and/or cocos2d-js are installed
• know cocos2d-x mode (source, binary or distro)
• and more

If, for whatever reason, a plugin can't be found, or if the templates can't be found, then probably it is because the cocos2d.ini file was not populated correctly.

Let's take a look at the cocos2d.ini file:

#
# cocos2d command line tool configuration file
#

[global]
# there are 3 modes
# "source", which means that the cocos2d-x source code is being used for "new" and other plugins.
# "precompiled", which means that cocos2d-x precompiled libraries and headers will be used for "new" and other plugins
# "distro", which means that cocos2d-x precompiled libraries and headers won't be copied when using "new" and other plugins
# Default: source. Distros and other installers must override this setting
cocos2d_x_mode=source

[plugins]
# What are the plugins that must be enabled
# To add a new plugin add it's classname here
project_new.CCPluginNew
project_compile.CCPluginCompile
project_run.CCPluginRun
project_deploy.CCPluginDeploy
plugin_jscompile.CCPluginJSCompile
plugin_luacompile.CCPluginLuaCompile

[paths]
# where cocos2d-x is installed
# example: /usr/local/cocos2d-x
# example: ~/progs/cocos2d-x
# eg: this file must exist: /usr/local/cocos2d-x/cocos/cocos2d.h
# Default: empty. Installers will populate it
cocos2d_x=

# where are the cocos2d-x's templates installed
# example: /home/user/templates
# example: ~/src/cocos2d-x-templates
# eg: this directory must exist: /home/user/templates/cpp-template-default
# Default: empty. Installers will populate it
templates=

# where are the plugins installed
# but distros can override this directory
# Default: ../plugins. Installers can replace it if needed
plugins=../plugins