Install and configure Cocos Framework
Apart from the built-in game release function of Web version, Cocos Creator uses the JSB technology based on Cocos2d-x engine for the cross-platform release of original applications and Cocos Play smartphone web-based games. Before using Cocos Creator to zip and send games to original platforms, you need to configure the Cocos Framework and related development environment first.
Download and install Cocos Framework
Cocos Framework is the pre-compiled version of Cocos2d-x. Compared to the completed version, it is small, free of compilation and easy to install. The latest version of Cocos2d-x is v3.9. The following are download links for Cocos Framework v3.9:
After downloading, run the installation package, follow the instructions, and get it done.
You can choose the target path when installing Cocos Framework for Windows. The Mac version will be installed under
/Applications/Cocos/frameworks by default. Please confirm the installation path of your Cocos Framework, because it will be configured in Cocos Creator later.
Download SDK and NDK, which are needed for the Android platform release
If you have no plan to release your games on Android, or you have already have a complete Android development environment in your operating system, you can skip this section.
Download Android SDK and NDK in accordance with your operating system via the following links:
- Android SDK for Windows
- Android SDK for Mac
- Android NDK for Windows 32 Bit
- Android NDK for Windows 64 Bit
- Android NDK for Mac
Please unzip and drop them anywhere you like after downloading, because we need to set up the path of Android SDK and NDK later. Don't forget where you put the unzipped versions of the documents above.
Install C++ compiling environment
The compiling tool Cocos Console in Cocos Framework needs the following running environment:
- Python 2.7.5+, download page. Pay attention! Don't download Python 3.x version.
- In Windows, the installation of Visual Studio 2013 or 2015 Community Edition is needed, download page
- In Mac, the installation of Xcode and command line tool is needed, download page
Configure path in original release environments
Next, let's go back to Cocos Creator to configure the environmental path of the constructing release original platform. Choose
document/preference in the main menu, and open the preference window:
We need to configure the following four paths here:
- Cocos Console. It's normally in the
/tools/cocos2d-console/bindirectory under Cocos Framework. The chosen path should include an executable file named
- NDK, choose the NDK path that has just been downloaded and unzipped. You can skip this if you don't need to compile on Android platform
- Android SDK, choose the Android SDK path that has just been downloaded and unzipped. You can skip this if you don't need to compile the Android platform
- ANT, which will be put in the
toolsdirectory after installing Cocos Framework, which is at the same hierarchy as
frameworks. The chosen path should include an executable file named
Close the window after configuration is completed.
We have received lots of feedback about original packing in the public beta, and some possible reasons are supplemented here:
Check the path
The path set up in preference settings should be guaranteed to be correct, for example: the path of ant should be set under the bin directory in the ant installation directory, the root directory of which is NDK, while the directory of Android SDK should include documents like build-tools, platforms, etc..
Check NDK version
No matter which version's engine is used, you must use versions later than NDK r9b. If Cocos2d-x framework is used, please use versions later than NDK r10, and r10e version is recommended.
On Windows platform, JAVA_HOME environmental variables need to be checked
If using Windows platform, please confirm if JAVA_HOME is included in your environmental variables. By right clicking My Computer, choosing property and opening the advanced tab, you can check and modify environmental variables. For effective running on Windows platform, you might need to restart the computer.
Check JAVA environment
Input the following code into Mac terminal or Windows command line tool for check:
If JAVA SE displays, there is no problem. If JRE displays, then you need to install JAVA SE running environment.
Check if the C++ compiling environment is correctly installed in Visual Studio
When installing Visual Studio, the C++ compiling component is not ticked off by default. If Visual Studio wasn't installed, you need to install it and choose compiling components concerning C++.
Package name issue
Check the package name in the constructing release panel. Package names that include blank space,
-, etc. are all illegal.
In the end, if zipping still fails, you can try to create a standard Cocos2d-x project and compile it. If the Cocos2d-x project is compilable and Cocos Creator couldn't be zipped, please send the bug to us by forum.
Continue on to read about Publising -> Native.