Setup Native Development Environment
Apart from publish game to Web, Cocos Creator uses the JSB technology based on cocos2d-x engine for the cross-platform release of native games. Before using Cocos Creator to bundle and publish games to native platforms, you need to configure related cocos2d-x development environment first.
Android platform dependencies
To publish to the Android platform, you need to install all of the following development environments.
If you do not have a plan to publish to the Android platform, or if your operating system already has a full Android development environment, you can skip this section.
Download the Java SDK (JDK)
Compile the Android project requires a complete Java SDK tool on your local computer, download it at the following address:
Download and pay attention to select the machine and the operating system and architecture, download the installation can be completed after the installation process.
After the installation is complete, please confirm that the
java command is valid on the command line. 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.
On 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.
Download and install Android Studio
Starting with v1.5, we support the latest version of Android Studio and companion building tools. We recommend Android Studio as an Android platform build tool and you should download the required SDK and NDK packages in Android Studio. First install Android Studio.
Download the SDK and NDK required to publish the Android platform
After installing Android Studio, refer to the official documentation and open the SDK Manager:
- In the
SDK Platformstab page, check the API level you want to install, and choose the minimum compatible API Level 10 (2.3.3) and the mainstream API Level such as 17 (4.2) and 22 (5.1).
- In the
SDK Toolstab page, first check the lower right corner of the
Show package details, show the version of the tool selection.
- In the `Android SDK Build-Tools', select at least build tools version 25.
- Check the
Android SDK Platform-Tools,
Android SDK Toolsand
Android Support Library
- Check the
NDKand ensure that the version is above 14 (Please use versions later than NDK "r10c", and "r10e" version is recommended).
- Take note of the path of
Android SDK Locationon top of the SDK Manager window. Later we need to fill in the location of the SDK in Cocos Creator.
OKand follow the prompts to complete the installation.
Android SDK 10 dependencies
Starting with v1.2.2, the default Android project template will specify the
android-10 sdk platform version as the default target. For more information, see Pull Request Use API Level 10.
If you encounter build error like 'not found android-10', you can download
Android SDK API Level 10 according to the description below.
If you need to change the target API Level, you can modify the built project file
target = android-10
android-10 to the other API Level you need.
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 2015 or 2017 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 three paths here:
- Android SDK Root, choose the
Android SDK Locationpath we just noted in Android Studio SDK Manager window (the directory of Android SDK should include documents like "build-tools", "platforms", etc.). You can skip this if you don't need to compile the Android platform.
- NDK Root, choose the
Android SDK Locationpath. You can skip this if you don't need to compile on Android platform
- ANT Path (you can skip it if build with Android Studio), you should choose the downloaded and unzipped Apache Ant folder, the path should be set under the bin directory in the ant installation directory. The chosen path should include an executable file named
Close the window after configuration is completed.
Note: The configure will work when build native project. If the configure not works(some Mac may occur this situation), please try to set these settings to System Environment manually: COCOS_CONSOLE_ROOT, ANT_ROOT, NDK_ROOT, ANDROID_SDK_ROOT.
We have received lots of feedback about original packing in the public beta, and some possible reasons are supplemented here:
Check Xcode and Visual Studio
Xcode support is required for building Mac version and iOS version. Building Windows version requires the installation of Visual Studio. When installing Visual Studio, the C++ compiling component is not ticked off by default. If it 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.
Android built successfully, but prompt
dlopen failed: cannot locate symbol "xxxx" referenced by "libcocos2djs.so"...in runtime.
Please check if the architecture and version of NDK and Android SDK correspond to the phone's Android system. In addition you can try to use the NDK and Android SDK version used in this article to test.
In the end, if building 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, please send the bug to us by forum.
Continue on to read about Publising -> Native.