Following the release of v2.4.1 last week, Cocos Creator has brought you the long-awaited byte game platform support! A new platform always means new opportunities and challenges, and will bring more users and potential to developers. We also look forward to the explosion of more excellent products on byte games! We recommend that developers who need to release byte games upgrade the engine to the latest version to get the best experience.

What’s new

Byte games

The byte game is developed based on the full product matrix of Bytedance and includes such creations as Today Toutiao, TikTok and Today Toutiao Speedy Edition. It does not require users to download, just click to open the new game type that is ready to play. ByteDance’s full product matrix takes content distribution as the core, and promotes the distribution of small games through content, and uses content to bring volume and fission to small games. Currently, there are very rich application scenarios. There are traffic portals in natural search, feed stream, personal homepage, small video, video comment area, etc. For detailed instructions, please refer to the Understanding Mini Games: Overview of Traffic Portals article (Chinese Only). In terms of revenue, ByteDance currently supports both advertising and in-app purchases.

For games developed with Cocos Creator, developers only need to select the ByteDance game publishing platform when building, and Cocos Creator automatically completes the adaptation and building. For details, please refer to the Publish to Byte Games documentation.

Known issues

• After the iOS device is upgraded to iOS 14 beta.3, there will be a problem that the web platform cannot display the screen temporarily. You can customize the engine and manually merge the changes #6974 for repair.

v2.4.1 Byte platform has been unlocked synchronously

Cocos Creator v2.4.2 and v2.4.1 are exactly the same in terms of product functions, so the release portal of byte games for existing v2.4.1 users has been unlocked through hot updates. v2.4.1 users only need to start Cocos Dashboard v1.0.8 when the network is connected, and then open the editor. If unsuccessful, please make sure that Cocos Dashboard is using the latest v1.0.8, and completely exit and reopen. Minimizing the app isn’t good enough.

In addition, there is more good news: v2.4.1 already supports the Huawei AppGallery Connect platform, and developers can access Huawei HMS Core with one click, currently including account, Services such as payment, advertisement, and games will continue to support SDKs such as push, analysis and positioning in the near future.

Also, Cocos Creator will cooperate with Huawei in all aspects, especially at the technical level, integration with the underlying algorithms of CG Kit, tap Vulkan’s extreme rendering capabilities, release greater graphics rendering performance, and improve rendering efficiency. At the product level, Huawei’s HMS Core and AppGallery Connect will also be successively connected to more high-quality services to help developers develop higher-quality games.

Upgrade Tips

Upgrading a project from a previous version of Cocos Creator is irreversible. Please backup the old version of the project before upgrading.

Projects under development can usually be upgraded seamlessly, but because of the uniqueness of each project, developers should conduct a technical evaluation based on their project’s own needs. If developers encounter difficulties in upgrading, please feel free to give us feedback and we will try our best to assist. In addition, due to stability considerations, it is recommended that projects that are about to be launched or already launched be upgraded with caution.

Upgrade from <2.4.0 version

• cc.loader is no longer recommended, please use the latest cc.assetManager instead, please refer to the Resource Management Module Upgrade Guide .
• The sub-package function has been upgraded to Asset Bundle, please refer to the Resource Subcontract Upgrade Guide .
• Adjusted the directory structure after the project is built and adjusted the API of BuildResults. If you use the editor plug-in to get the editor’s build results, please refer to Customized Project Build Process Upgrade Guide .
• The cc.RawAsset that was deprecated since 1.10 has been officially removed, please use cc.Asset instead. Since 2.4 is no longer compatible with the legacy usage of the RawAsset type in the original 1.x project, it is recommended that all projects to be upgraded to 2.4, especially those upgraded from version 1.9, be edited in any 1.10 ~ 2.3 version. All warnings or errors output when the compiler compiles the code are processed correctly, and then upgraded to 2.4.
• cc.Color.fromHex is deprecated, please use cc.Color.fromHEX interface.

Upgrade from < 2.3.3 version

• The CCTexture2D and CCTexture2DRGB methods in the Effect have been abandoned.
• Vec3.FRONT has been abandoned, please use Vec3.FORWARD instead.

Upgrade from < v2.3.0 version

Since v2.3.0, Android and Android Instant use the same build template, please note:

• If the code is used solely by the Android platform, please put it in the app/src directory, and the third-party library used by itself, please put it in theapp/libs directory.
• If the code and third-party libraries used by Android Instant are separate, please put them in the game/src, game/libs directories.
• For code and third-party libraries shared by Android and Android Instant, please place them in the src and libs directories under the proj.android-studio root directory, respectively.
• proj.android-studio under the root directory jni/CocosAndroid.mk, jni/CocosApplication.mk, mainly used to configure engine-related configuration, developer configuration, it is recommended that Android be placed in app/jni/Android.mk and app/jni/Application.mk, Android Instant, please put in game/jni/Android.mk and game/jni/Application.mk.
• When Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling for Android Instant, it will execute instant: assembleRelease/Debug.

In addition, when Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling Android Instant, it will executein``stant:assembleRelease/Debug.

If you have customized the pause logic when switching between audio background and background, please remove it after upgrading to 2.3.0 Currently Cocos Creator games automatically pause and resume audio internally when switching between front and back on all platforms. If the developer has customized this block before, and listens for and performs audio operations like cc.audioEngine.pause() and resume(), it may conflict with the engine’s default behavior. If you encounter related audio issues, simply remove the corresponding custom code.

Upgrade from version v2.0 – v2.3.0

Starting from 2.3.0, the Canvas component is no longer responsible for setting the Canvas node size to the screen size. This behavior will be implemented in conjunction with the Widget component. To ensure compatibility, after the 2.0 project is upgraded, the node where Canvas is located will automatically add Widget components. (No problem upgrading from a 1.0 project)

Upgrade from < v2.2.0

Starting from 2.2.0, we have strengthened the memory management mechanism, and now require users to dynamically create cc.Node which is independent of the scene node tree through code must be released through destroy(), otherwise the engine cannot know when to recycle this type The memory of the node will cause a memory leak.

• In addition, the nodes that are manually removed from the scene need to be unified when they are not needed.

// Assuming testNode is a node in the scene, if it was manually removed

//from the scene before, such as

testNode.parent = null;

// or

testNode.removeFromParent(true);

// or

parentNode.removeChild(testNode);

// If testNode will be used again in the future, there is no need to

// manually destroy the node otherwise it should be called manually

testNode.destroy();

• If a node is managed via cc.NodePool, it is not affected.

Upgrade from < v2.0

If you open the 1.x project, all resources such as scenes will be upgraded automatically. If there are warnings or errors in the code, you can refer to v1.10.0 Resource Upgrade Guide and the v2.0.0 Upgrade Documentation.

Cocos Creator v2.4.1 is here! This update brings more new features, optimizes performance and improves stability. Efficiency is everything! This version contains many new features and updates, such as resource management system refactoring, asset bundles, optimized the performance of graphic rendering.

What’s new

New platforms always mean new opportunities and challenges. Cocos Creator 2.4.1 adds support for two new platforms: HUAWEI AppGallery Connect and LinkSure Mini Game. You can now choose these platforms when building. This version allows your game to connect to Huawei HMS Core with one click, and upload to HUAWEI AppGallery with one click Connect, eliminating the complicated operations such as accessing SDKs and uploading platforms during the development process, helping developers create high-quality innovative applications and enhance the game experience!

Added HUAWEI AppGallery Connect release platform

In Cocos Creator, through the HUAWEI AppGallery Connect publishing platform, developers can access Huawei HMS Core with one click, including login, payment, Share, Location, Analysis and other services that can greatly improve the developer’s work efficiency.

Developers can enable the SDKHub in the service panel and configure the corresponding SDK presets.

Choose HUAWEI AppGallery Connect platform during building, and select the preset SDK preset.

After the building is completed, you can upload with one click through the upload window.

Added LinkSure Mini Game publishing platform

LinkSure Mini Game is a mini game application platform under the WiFi Master Key, which is convenient, lightweight, and free of installation. It is now officially supported by Cocos Creator. Developers only need to select the LinkSure Mini Game release platform when building, and the platform adaptation is automatically completed.

For more information about publishing to LinkSure Mini Game, please refer to the Publishing documentation.

Release Notes

Bug fixes

• [Engine] Fixed the problem of the wrong execution sequence of plugin scripts at runtime [#6983]
• [Engine] Fixed the problem that the scene may fail to load when delayed loading is enabled [#6983]
• [Native] Fixed the wrong typesetting of the rich text component on the native platform [#6975]
• [Editor] Fixed the problem that the scene view is automatically switched to 2D view when entering the Prefab editor mode
• [Editor] Fix the problem that the build fails after the main package is configured as a mini game sub-package on the Xiaomi mini game, OPPO mini game, and vivo mini game platform

Known issues

• After the iOS device is upgraded to iOS 14 beta.2, there will be a problem that the web platform cannot display the screen temporarily. You can customize the engine and merge the changes manually [#6974] to resolve. We will continue to follow up with subsequent versions of iOS 14 to avoid compatibility issues.

Upgrade Tips

Upgrading a project from a previous version of Cocos Creator is irreversible. Please backup the old version of the project before upgrading.

Projects under development can usually be upgraded seamlessly, but because of the uniqueness of each project, developers should conduct a technical evaluation based on their project’s own needs. If developers encounter difficulties in upgrading, please feel free to give us feedback and we will try our best to assist. In addition, due to stability considerations, it is recommended that projects that are about to be launched or already launched be upgraded with caution.

Upgrade from <2.4.0 version

• cc.loader is no longer recommended, please use the latest cc.assetManager instead, please refer to the Resource Management Module Upgrade Guide
• The sub-package function has been upgraded to Asset Bundle, please refer to the Resource Subcontract Upgrade Guide
• Adjusted the directory structure after the project is built and adjusted the API of BuildResults. If you use the editor plug-in to get the editor’s build results, please refer to Customized Project Build Process Upgrade Guide
• The cc.RawAsset that was deprecated since 1.10 has been officially removed, please use cc.Asset instead. Since 2.4 is no longer compatible with the legacy usage of the RawAsset type in the original 1.x project, it is recommended that all projects to be upgraded to 2.4, especially those upgraded from version 1.9, be edited in any 1.10 ~ 2.3 version. All warnings or errors output when the compiler compiles the code are processed correctly, and then upgraded to 2.4.
• cc.Color.fromHex is deprecated, please use cc.Color.fromHEX interface

Upgrade from < 2.3.3 version

• The CCTexture2D and CCTexture2DRGB methods in the Effect have been abandoned.
• Vec3.FRONT has been abandoned, please use Vec3.FORWARD instead.

Upgrade from < v2.3.0 version

Since v2.3.0, Android and Android Instant use the same build template, please note:

• If the code is used solely by the Android platform, please put it in the app/src directory, and the third-party library used by itself, please put it in theapp/libs directory.
• If the code and third-party libraries used by Android Instant are separate, please put them in the game/src, game/libs directories.
• For code and third-party libraries shared by Android and Android Instant, please place them in the src and libs directories under the proj.android-studio root directory, respectively.
• proj.android-studio under the root directory jni/CocosAndroid.mk, jni/CocosApplication.mk, mainly used to configure engine-related configuration, developer configuration, it is recommended that Android be placed in app/jni/Android.mk and app/jni/Application.mk, Android Instant, please put in game/jni/Android.mk and game/jni/Application.mk.
• When Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling for Android Instant, it will execute instant: assembleRelease/Debug.

In addition, when Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling Android Instant, it will executein``stant:assembleRelease/Debug.

If you have customized the pause logic when switching between audio background and background, please remove it after upgrading to 2.3.0 Currently Cocos Creator games automatically pause and resume audio internally when switching between front and back on all platforms. If the developer has customized this block before, and listens for and performs audio operations like cc.audioEngine.pause() and resume(), it may conflict with the engine’s default behavior. If you encounter related audio issues, simply remove the corresponding custom code.

Upgrade from version v2.0 – v2.3.0

Starting from 2.3.0, the Canvas component is no longer responsible for setting the Canvas node size to the screen size. This behavior will be implemented in conjunction with the Widget component. To ensure compatibility, after the 2.0 project is upgraded, the node where Canvas is located will automatically add Widget components. (No problem upgrading from a 1.0 project)

Upgrade from < v2.2.0

Starting from 2.2.0, we have strengthened the memory management mechanism, and now require users to dynamically create cc.Node which is independent of the scene node tree through code must be released through destroy(), otherwise the engine cannot know when to recycle this type The memory of the node will cause a memory leak.

• In addition, the nodes that are manually removed from the scene need to be unified when they are not needed.

// Assuming testNode is a node in the scene, if it was manually removed

//from the scene before, such as

testNode.parent = null;

// or

testNode.removeFromParent(true);

// or

parentNode.removeChild(testNode);

// If testNode will be used again in the future, there is no need to

// manually destroy the node otherwise it should be called manually

testNode.destroy();

• If a node is managed via cc.NodePool, it is not affected.

Upgrade from < v2.0

If you open the 1.x project, all resources such as scenes will be upgraded automatically. If there are warnings or errors in the code, you can refer to v1.10.0 Resource Upgrade Guide and the v2.0.0 Upgrade Documentation.

Cocos Creator v2.4.0 is here! This update brings more new features, optimizes performance and improves stability. Efficiency is everything! This version contains many new features and updates, such as resource management system refactoring, asset bundles, optimized the performance of graphic rendering.

It is recommended for all v2.3.x developers to upgrade! Please perform the necessary technical evaluation and backups before upgrading.

What’s New

If the worker wants to do his best, he must first sharpen his weapon! After two months of testing, version 2.4.0 is finally here! Thanks to all the friends who gave us valuable comments and suggestions!

Support Asset Bundles

Asset Bundle can divide the resources in a project into modules according to the wishes of the developer, and divide the resources with different needs in different scenarios into multiple packages. This reduces the time required to download and load a game for the first time, and can also be copied across projects.

Asset Bundle also provides priority, compression type and other related settings to optimize the package and loading of the Asset Bundle.

For additional details, please refer to the Asset Bundle documentation and the Load Asset Bundle documentation.

Added cc.AssetManager module for resource management

Asset Manager is newly introduced in Cocos Creator v2.4. It has the function to load resources, find resources, destroy resources, cache resources, asset bundles and so on. Asset Manager has better performance, easier-to-use APIs, and stronger scalability. It mainly provides the following new features:

• Supports loading and pre-loading of all resources, pre-loading can run silently in a lighter way, without affecting operation efficiency.
• Supports Asset Bundles.
• Supports a more secure automatic release mechanism, no need to consider its reference when releasing resources, to avoid mistaken release of resources.
• Support download failure retry, download priority, download concurrent number and other settings, which can be adjusted according to various situations.
• Support more convenient custom loading process to achieve special effects.

For details, please refer to the Asset Manager documentation and the Dynamic Loading documentation.

Add Label blending options

Supports setting Label’s belnding options, and different settings in different usage scenarios can be used to maximize text rendering performance. For details, please refer to the Blending Mode of System Fonts  documentation.

Use FreeType to render Label on native platforms

• Increased Label initialization speed, Android increased by about 5 times, iOS increased by 3 times
• Support bold, outline, shadow and other effects when using TTF font and Char mode

Support Graphic anti-aliasing effects

Using SDF technology to optimize Graphic’s aliasing problem:

Support the compressed texture of other small game platforms

The editor further supports the compression texture limitation of more mini game platforms. Just add the compressed texture format in the Mini Game item to set the compression of multiple platforms including WeChat mini games, OPPO mini games, Vivo mini games, etc.

Improve native hot update support

Cocos Creator v2.4 further improves the native hot update capability and optimize the following:

• Add interface to get update package size
• Add MD5 parameter to the link, more friendly to CDN
• Solve the problem of resource loss and confusion caused by interruption of the update process

Please see this GitHub issue.

For details, please refer to the Hot Update Sample Tutorial.

Added SafeArea UI component

This component will adapt the layout of the node where it is located to the safe area of the mobile phone with a special screen. It can be adapted to Android and iOS devices. For details, refer to the SafeArea Component documentation.

Release Notes

Other new features

• Add compressed texture cache function, cache the compressed texture after construction, and reuse the cache content as much as possible to speed up the construction speed
• Use ImageBitmap to load images on the Web platform, improve the preview and Web platform image resolution speed, and reduce the stutter during loading
• Editor property panel supports drag and drop array assignment
• Upgrade TypeScript version to 3.9.2
• Upgrade the V8 version of the native platform to 8.0.426.16
• Support importing GLTF resources
• Support the first scene subcontracting function on all small game platforms
• Support module culling during preview, improve preview speed, and expose module culling settings earlier

Improvements

• Optimize the performance of free and relative modes of 2D particle system [#6236]
• Optimize the efficiency of ToggleContainer to get toggleItems [#6569]
• Increase the bandwidth of the native platform WebSocket [#2353]
• SpriteFrame resource adds a None trim type, which can be quickly set to no crop.
• Improve the code hints of jsb
• Support setting preview port
• The window size can be set when the native desktop platform is built

Engine

• [CORE] Fixed the issue that the return value of cc.easeBackOut is incorrect when time is 0, [#6728], (thank you chen-gaoyuan)
• [CORE] Fixed the issue of Node.walk traversal error [#6710]
• [CORE] Fixed the error of calling cc.dynamicAtlasManager.showDebug [#6697]
• [CORE] Fixed the issue of setting node size in onLoad is invalid [#6688]
• [CORE] Fixed the issue of resetting the background material back to the default material when the button is disabled [#6562]
• [CORE] Fixed error when BMFont configuration data does not exist [#6472]
• [CORE] Fixed the issue of invalid transparency after pre-multiplication is enabled [#6451]
• [CORE] Fixed the issue of Camera.render() rendering twice, [#6355], (thank you Dacheng Xiaofa)
• [CORE] Fixed the issue of picture flip after calling Texture2D.setPremultiplyAlpha [#6602]
• [PARTICLE] Fixed the 2d particle system relative mode, the particle follows the problem when the node rotates [#6236]
• [3D] Fixed the problem that 3D Label is not displayed in char mode [#6882]
• [3D] Fixed the problem of rendering error caused by checking the option Enable Auto Batchand switching Mesh resources [#6901]
• [3D] Fixed the problem of rendering the shadow of a single camera misaligned [#6477]
• [3D] Fixed the issue of cc_matProj error in effect [#6653]
• [EDITBOX] Fixed the issue that the EditBox.maxLength attribute does not take effect in number mode [#6725]
• [EDITBOX] Fixed the issue that the EditBox could not update the position when scrolling in ScrollView [#6634]
• [TILEDMAP] Fixed the possible rendering order of Tiled Map may be wrong [#6284]
• [TILEDMAP] Fixed the problem that the hidden image of Tiled Map will still be rendered [#6309]
• [SPINE] Fixed Spine texture rendering error after using compressed texture [#6483]
• [SPINE] Fixed the issue that Spine texture may render incorrectly [#6584]
• [SPINE] Fixed the issue that DragonBone and Spine render incorrectly after the texture is set to pre-multiplied [#6696], (thanks Dacheng Xiaofa).
• [DRAGONBONE] Fixed the issue that DragonBone keeps reporting errors when destroying scenes [#6553]

Native

• Fixed the problem of incorrect node scaling after screen flip [#6689]
• Fix Android native JniHelper is not thread safe [#2457]
• Fix the issue that unzip is not thread safe [#2131], (thanks benloong)
• Fix the problem that the Edit button of Android EditBox is blocked by the virtual navigation bar [#2426]
• Fix the problem that Spine node can not get the node size on iOS [#273]
• Fix the issue of cc_time error in native Effect [#6586]
• Fix the possible crash of iOS audio playback [#2358]
• Fix the problem of node rotation calculation error [#2361]
• Fixed the crash caused by encoding error when setting Label.string [#2395]
• Fixed an error when the game exited [#2406]
• Fix the problem that the input box will push up the view after the screen is rotated [#2415]
• Fix the problem that the path animation in the JSON file exported by Spine 3.6.53 failed to parse [#2413], (thanks to laomoi)
• Fix the problem of gravity sensor error on Android [#2231]
• Fix Tiled Map will not be rendered when the node moves to a location without plot information [#2283]
• Fix the problem that the original WebSocket interface is inconsistent with the Web [#2297]
• Fixed an issue where calling Camera’s render method would cause Spine to speed up playback [#258]
• Fixed an issue where the AudioSource module was removed due to the removal of the AudioSource module on the Android platform
• Fix Android 9, Android 10 version number detection failure [#6466]

Web

• Fix the issue that audio cannot be played after removing the headset from iOS Web-Mobile [#6730]
• Fix WebView transparency error on iOS [#6717]
• Fix the problem that English can no longer be input after entering Chinese on iOS browser [#6631]

Mini Game

• Fixed the issue that the WeChat mini game WebSocket sends an error report of Uint8Array[#115]
• Fixed the issue that playback cannot be resumed automatically when audio is interrupted unexpectedly [#118]
• Fix the problem that PC WeChat data open domain cannot run

Editor

• Fix the problem of incorrect save and restore status of Sprite Editor
• Fixed an issue where animation clips that are not being edited cannot be renamed in animation editing state
• Fixed an issue where the editor could not recognize after adding Spine resources
• Fixed the issue that the editor may not open after the user plug-in restarts
• Fixed an issue where the return value of getNativeAssetPaths was called multiple times incorrectly
• Fix the problem that the script fails to load after the script is renamed
• Fixed an issue where width and height will be reported incorrectly when clicking on the gallery
• Fixed the issue that the picture may be distorted when using Auto Atlas
• Fixed an issue where importing some pictures caused the resource panel error
• Fixed the problem that the node cannot be deleted by delete key in Prefab edit mode
• Fixed an issue where Filter Unused Resources was not valid when the atlas was not exported
• Fix the problem that the value range of the macro defined in the effect is invalid [#6616]
• Fixed an issue where the animation editor setting CircleCollider.offset attribute is abnormal [#6600]
• Fix the problem that the last save is invalid
• Fixed the issue of invalid setting preview browser
• Fix the problem of error report when importing Cocos Studio project without font resources
• Fixed an issue where multiple openings may cause editor errors

Known Issues

• When using remote Asset Bundle and checking Lazy loading, the audio may not be played. Please use cc.assetManager.postLoadNative to load and play.

Upgrade Tips

Upgrading a project from a previous version of Cocos Creator is irreversible. Please backup the old version of the project before upgrading.

Projects under development can usually be upgraded seamlessly, but because of the uniqueness of each project, developers should conduct a technical evaluation based on their project’s own needs. If developers encounter difficulties in upgrading, please feel free to give us feedback and we will try our best to assist. In addition, due to stability considerations, it is recommended that projects that are about to be launched or already launched be upgraded with caution.

Upgrade from <2.4.0 version

• cc.loader is no longer recommended, please use the latest cc.assetManager instead, please refer to the Resource Management Module Upgrade Guide
• The sub-package function has been upgraded to Asset Bundle, please refer to the Resource Subcontract Upgrade Guide
• Adjusted the directory structure after the project is built and adjusted the API of BuildResults. If you use the editor plug-in to get the editor’s build results, please refer to Customized Project Build Process Upgrade Guide
• The cc.RawAsset that was deprecated since 1.10 has been officially removed, please use cc.Asset instead. Since 2.4 is no longer compatible with the legacy usage of the RawAsset type in the original 1.x project, it is recommended that all projects to be upgraded to 2.4, especially those upgraded from version 1.9, be edited in any 1.10 ~ 2.3 version. All warnings or errors output when the compiler compiles the code are processed correctly, and then upgraded to 2.4.
• cc.Color.fromHex is deprecated, please use cc.Color.fromHEX interface

Upgrade from < 2.3.3 version

• The CCTexture2D and CCTexture2DRGB methods in the Effect have been abandoned.
• Vec3.FRONT has been abandoned, please use Vec3.FORWARD instead.

Upgrade from < v2.3.0 version

Since v2.3.0, Android and Android Instant use the same build template, please note:

• If the code is used solely by the Android platform, please put it in the app/src directory, and the third-party library used by itself, please put it in theapp/libs directory.
• If the code and third-party libraries used by Android Instant are separate, please put them in the game/src, game/libs directories.
• For code and third-party libraries shared by Android and Android Instant, please place them in the src and libs directories under the proj.android-studio root directory, respectively.
• proj.android-studio under the root directory jni/CocosAndroid.mk, jni/CocosApplication.mk, mainly used to configure engine-related configuration, developer configuration, it is recommended that Android be placed in app/jni/Android.mk and app/jni/Application.mk, Android Instant, please put in game/jni/Android.mk and game/jni/Application.mk.
• When Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling for Android Instant, it will execute instant: assembleRelease/Debug.

In addition, when Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling Android Instant, it will executein``stant:assembleRelease/Debug.

If you have customized the pause logic when switching between audio background and background, please remove it after upgrading to 2.3.0 Currently Cocos Creator games automatically pause and resume audio internally when switching between front and back on all platforms. If the developer has customized this block before, and listens for and performs audio operations like cc.audioEngine.pause() and resume(), it may conflict with the engine’s default behavior. If you encounter related audio issues, simply remove the corresponding custom code.

Upgrade from version v2.0 – v2.3.0

Starting from 2.3.0, the Canvas component is no longer responsible for setting the Canvas node size to the screen size. This behavior will be implemented in conjunction with the Widget component. To ensure compatibility, after the 2.0 project is upgraded, the node where Canvas is located will automatically add Widget components. (No problem upgrading from a 1.0 project)

Upgrade from < v2.2.0

Starting from 2.2.0, we have strengthened the memory management mechanism, and now require users to dynamically create cc.Node which is independent of the scene node tree through code must be released through destroy(), otherwise the engine cannot know when to recycle this type The memory of the node will cause a memory leak.

• In addition, the nodes that are manually removed from the scene need to be unified when they are not needed.

// Assuming testNode is a node in the scene, if it was manually removed

//from the scene before, such as

testNode.parent = null;

// or

testNode.removeFromParent(true);

// or

parentNode.removeChild(testNode);

// If testNode will be used again in the future, there is no need to

// manually destroy the node otherwise it should be called manually

testNode.destroy();

• If a node is managed via cc.NodePool, it is not affected.

Upgrade from < v2.0

If you open the 1.x project, all resources such as scenes will be upgraded automatically. If there are warnings or errors in the code, you can refer to v1.10.0 Resource Upgrade Guide and the v2.0.0 Upgrade Documentation.

Cocos Creator v2.3.4 is here! This update brings more new features, optimizes performance and improves stability. Efficiency is everything!

It is recommended for all v2.3.x developers to upgrade! Please perform the necessary technical evaluation and backups before upgrading.

Note: Yes, you use Dashboard now to Download and manage Cocos Creator.

Note: Starting with Cocos Creator v2.4 using Dashboard will be required! There will no longer be a separate Cocos Creator installer provided. Please download and get acclimated with Dashboard soon.

What’s New

Tencent Cloud-Cloud Development

Cloud Development (Tencent Cloud Base, TCB) is Tencent Cloud’s one-stop back-end cloud service for mobile developers. Developers can access the service with one click inside Cocos Creator. After accessing the service, you can manage all cloud functions in the cloud function panel, including operations such as adding, deleting, and synchronizing.

For more details, please refer to Tencent Cloud Development documentation.

Tencent Cloud-Online game engine for mini games

Mini Game Online Battle Engine (MGOBE) provides room management, online matching, frame synchronization, status synchronization, etc… Developers can quickly build networked, multiplayer interactive games. Developers do not need to pay attention to the underlying network architecture, network communication, *server expansion and contraction, operation and maintenance, etc… They can obtain nearby access, low latency, and *real-time expansion of high-performance online MGOBE is suitable for games such as turn-based, strategy, real-time conversation (casual battle, MOBA, FPS) and so on.

Developers can access the service with one click from within Cocos Creator. For more details, please refer to Mini Game Online Battle Engine documentation.

Tencent Cloud-Game Multimedia Engine

Game Multimedia Engine (GME) provides a one-stop voice solution. In-depth optimization for different scenarios including covering games, social networking, entertainment and other pan-Internet industryapplication scenarios. GME includes real-time voice, voice message, text-to-text, and voice analysis services to meet diverse voice needs.

Developers can access the service with one click from within Cocos Creator. For more details, please refer to Game Multimedia Engine documentation.

Upgrade Tips

Upgrading a project from a previous version of Cocos Creator is irreversible. Please backup the old version of the project before upgrading.

Projects under development can usually be upgraded seamlessly, but because of the uniqueness of each project, developers should conduct a technical evaluation based on their project’s own needs. If developers encounter difficulties in upgrading, please feel free to give us feedback and we will try our best to assist. In addition, due to stability considerations, it is recommended that projects that are about to be launched or already launched be upgraded with caution.

Upgrade from < 2.3.3 version

• The CCTexture2D and CCTexture2DRGB methods in the Effect have been abandoned.
• Vec3.FRONT has been abandoned, please use Vec3.FORWARD instead.

Upgrade from < v2.3.0 version

Since v2.3.0, Android and Android Instant use the same build template, please note:

• If the code is used solely by the Android platform, please put it in the app/src directory, and the third-party library used by itself, please put it in theapp/libs directory.
• If the code and third-party libraries used by Android Instant are separate, please put them in the game/src, game/libs directories.
• For code and third-party libraries shared by Android and Android Instant, please place them in the src and libs directories under the proj.android-studio root directory, respectively.
• proj.android-studio under the root directory jni/CocosAndroid.mk, jni/CocosApplication.mk, mainly used to configure engine-related configuration, developer configuration, it is recommended that Android be placed in app/jni/Android.mk and app/jni/Application.mk, Android Instant, please put in game/jni/Android.mk and game/jni/Application.mk.
• When Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling for Android Instant, it will execute instant: assembleRelease/Debug.

In addition, when Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling Android Instant, it will executein``stant:assembleRelease/Debug.

If you have customized the pause logic when switching between audio background and background, please remove it after upgrading to 2.3.0 Currently Cocos Creator games automatically pause and resume audio internally when switching between front and back on all platforms. If the developer has customized this block before, and listens for and performs audio operations like cc.audioEngine.pause() and resume(), it may conflict with the engine’s default behavior. If you encounter related audio issues, simply remove the corresponding custom code.

Upgrade from version v2.0 – v2.3.0

Starting from 2.3.0, the Canvas component is no longer responsible for setting the Canvas node size to the screen size. This behavior will be implemented in conjunction with the Widget component. To ensure compatibility, after the 2.0 project is upgraded, the node where Canvas is located will automatically add Widget components. (No problem upgrading from a 1.0 project)

Upgrade from < v2.2.0

Starting from 2.2.0, we have strengthened the memory management mechanism, and now require users to dynamically create cc.Node which is independent of the scene node tree through code must be released through destroy(), otherwise the engine cannot know when to recycle this type The memory of the node will cause a memory leak.

• In addition, the nodes that are manually removed from the scene need to be unified when they are not needed.

// Assuming testNode is a node in the scene, if it was manually removed 
//from the scene before, such as
testNode.parent = null;
// or
testNode.removeFromParent(true);
// or
parentNode.removeChild(testNode);
// If testNode will be used again in the future, there is no need to 
// manually destroy the node otherwise it should be called manually
testNode.destroy();

• If a node is managed via cc.NodePool, it is not affected.

Upgrade from < v2.0

If you open the 1.x project, all resources such as scenes will be upgraded automatically. If there are warnings or errors in the code, you can refer to v1.10.0 Resource Upgrade Guide and the v2.0.0 Upgrade Documentation.

Just in case

Note: If you prefer not to use Dashboard now, you may still download Cocos Creator v2.3.4 for MacOS and Windows.

Cocos Creator v2.3.3 is here! This update brings more new features, optimizes performance and improves stability. Efficiency is everything!

It is recommended for all v2.3 developers to upgrade! Please perform the necessary technical evaluation and backups before upgrading.

Support PCF soft shadow

Starting from v2.3.3, the Light component can set the shadow type to SOFT_PCF3X3 or SOFT_PCF5X5 to turn on soft shadows. After opening, the shadow will not have hard edges, the effect is more soft and natural.

Support zooming Sprite by 9-sliced SpriteFrame in TILED mode

Starting with v2.3.3, the image will be repeated to fit the size of the Sprite when using TILED mode. If the SpriteFrame is 9-sliced, the corners will also remain unscaled while the other areas will be repeated.

Improve web page loading speed during preview

In order to further improve development efficiency, we optimized the loading speed of scripts during web page preview in both the engine and in project code. When the custom engine feature is turned on, or when using a mobile phone to preview, developers get a really smoother experience.

Engine

• [Core] Fix the problem that hidden nodes will not trigger touch events when touching with single touch [#6395]
• [Core] Fix the problem that the AudioSource component setting Play On Load is invalid when the scene starts with Async Load Assets [#6412]
• [Core] Fixed Spine resource rendering error if defaultSkin is not set [#6432]
• [Core] Fix the warning when Label is empty when using BITMAP mode [#6315]
• [Core] Fixed RichText unable to input single angle bracket text [#6314]
• [Core] Fix the problem that the current time obtained by VideoPlayer on different platforms may be inconsistent [#6360]
• [Tween] Tween adds stopAll, stopAllByTag, stopAllByTarget and other interfaces to facilitate playback control [#6338]
• [Tween] Added bezierTo, bezierBy, flipX, flipY, blink interfaces [#6327]
• [Tween] Optimized the intelligent hints of the API code of Tween.to and Tween.by, which can intelligently display the target attribute
• [3D] Added Node.forward, Node.right, Node.up APIs to get all directions of nodes in the world coordinate system [#6287]
• [3D] Fix the problem that the Sprite node may render incorrectly when switching 3D node settings [#2335]
• [3D] Fix the issue that ROTATION_CHANGED event is not triggered when Node.eulerAngleschanges [#6325]
• [3D] Fix the incorrect rotation of cc.Rotate3DBy [#6377]
• [3D] Fix the calculation error of vertex tangent conversion to world coordinate system in built-in Effect [#6358]
• [3D] Fix the problem of data failure when the number of vertices set by Mesh exceeds the original number [#6359]

Native

• Fix the problem that the native SocketIO may make a request error when the server is closed [#2338]
• Fix the problem that the return value of jsb.fileUtils.listFilesRecursively is incorrect [#2337]
• Fix the calculation error of cc.sys.getSafeAreaRect on Android devices [#2145]
• Fix the problem of incorrect line-breaking effect after using emoji on native platform Label [#6353]
• Fix the problem that the native platform Graphic cannot be drawn if there are too many vertices [#1935]
• Fix the problem of getting wrong devicePixelRatio in the initialization stage of Windows and Mac platforms [#2309]
• Fixed trailing material error when 3D particles did not open TrailModule on native platform [#6413]

Mini Game

• Adapt to the numeric keyboard keys of PC WeChat games [#98]
• Fixed an issue where the Baidu game VideoPlayer was hidden after entering text
• Fix OPPO fast game Label text truncated at the top [#6441]

Web

• Fix the problem that the EditBox input box is misaligned after screen resize [#6347]
• Fix the problem that the mobile terminal keyboard does not respond to touch events when pulling up the status button [# 6337]
• Fix the problem of incorrect interface adaptation after EditBox editing on UC browser of iOS [# 6471]

Editor

• Support displaying the attributes information of the grid in the Properties Panel
• Added case verification of require path in project script
• Fixed the issue of block blocking when previewing particles in the editor
• Fixed the issue that the component @menu decorator is invalid
• Fixed an issue where the editor could not be opened after setting the language on Cocos Dashboard
• Fixed an issue where a progress bar sometimes appears in the editor
• Fixed an issue where clicking the 3D toggle button is invalid when selecting multiple nodes in the property panel
• Fix the problem of error report when importing ccs project
• Fixed an error when deleting 3D particle materials in the editor
• Fixed an issue where rename animation clips and nodes is invalid when adding a recording animation editor
• Fixed an issue where the animation editor reported an error when animating the camera backgroundColor
• Fixed an issue where deleting a script after the script reported an error still failed to clear the console error
• Fix the problem that the custom component menu is not sorted alphabetically
• Fix the problem that the paste menu is invalid when no node is selected
• Fixed the issue of material error after deleting texture attribute
• Fixed an issue where the EditBox node reported an error after selecting the Reset All menu item in the properties panel
• Fixed an issue where importing materials with the same name in the model would cause the import to fail
• Fixed an issue where Prefab cannot automatically synchronize to the original Prefab when deleting child nodes after setting automatic synchronization
• Fixed an issue where using the wrong custom engine would cause the editor to not start

Upgrade Tips

Upgrading a project from a previous version of Cocos Creator is irreversible. Please backup the old version of the project before upgrading.

Projects under development can usually be upgraded seamlessly, but because of the uniqueness of each project, developers should conduct a technical evaluation based on their project’s own needs. If developers encounter difficulties in upgrading, please feel free to give us feedback and we will try our best to assist. In addition, due to stability considerations, it is recommended that projects that are about to be launched or already launched be upgraded with caution.

Upgrade from < 2.3.3 version

• The CCTexture2D and CCTexture2DRGB methods in the Effect have been abandoned.
• Vec3.FRONT has been abandoned, please use Vec3.FORWARD instead.

Upgrade from < v2.3.0 version

Since v2.3.0, Android and Android Instant use the same build template, please note:

• If the code is used solely by the Android platform, please put it in the app/src directory, and the third-party library used by itself, please put it in theapp/libs directory.
• If the code and third-party libraries used by Android Instant are separate, please put them in the game/src, game/libs directories.
• For code and third-party libraries shared by Android and Android Instant, please place them in the src and libs directories under the proj.android-studio root directory, respectively.
• proj.android-studio under the root directory jni/CocosAndroid.mk, jni/CocosApplication.mk, mainly used to configure engine-related configuration, developer configuration, it is recommended that Android be placed in app/jni/Android.mk and app/jni/Application.mk, Android Instant, please put in game/jni/Android.mk and game/jni/Application.mk.
• When Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling for Android Instant, it will execute instant: assembleRelease/Debug.

In addition, when Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling Android Instant, it will executein``stant:assembleRelease/Debug.

If you have customized the pause logic when switching between audio background and background, please remove it after upgrading to 2.3.0 Currently Cocos Creator games automatically pause and resume audio internally when switching between front and back on all platforms. If the developer has customized this block before, and listens for and performs audio operations like cc.audioEngine.pause() and resume(), it may conflict with the engine’s default behavior. If you encounter related audio issues, simply remove the corresponding custom code.

Upgrade from version v2.0 – v2.3.0

Starting from 2.3.0, the Canvas component is no longer responsible for setting the Canvas node size to the screen size. This behavior will be implemented in conjunction with the Widget component. To ensure compatibility, after the 2.0 project is upgraded, the node where Canvas is located will automatically add Widget components. (No problem upgrading from a 1.0 project)

Upgrade from < v2.2.0

Starting from 2.2.0, we have strengthened the memory management mechanism, and now require users to dynamically create cc.Node which is independent of the scene node tree through code must be released through destroy(), otherwise the engine cannot know when to recycle this type The memory of the node will cause a memory leak.

• In addition, the nodes that are manually removed from the scene need to be unified when they are not needed.

// Assuming testNode is a node in the scene, if it was manually removed //from the scene before, such as
testNode.parent = null;
// or
testNode.removeFromParent(true);
// or
parentNode.removeChild(testNode);
// If testNode will be used again in the future, there is no need to
// manually destroy the node otherwise it should be called manually testNode.destroy();

• If a node is managed via cc.NodePool, it is not affected.

Upgrade from < v2.0

If you open the 1.x project, all resources such as scenes will be upgraded automatically. If there are warnings or errors in the code, you can refer to v1.10.0 Resource Upgrade Guide and the v2.0.0 Upgrade Documentation.

Cocos Creator v2.3.2 is officially released! This update, brings accesses the new Cocos Dashboard system, which can uniformly help upgrade and manage multiple versions of engines and projects at the same time! It is recommended for all v2.3 developers to upgrade! Please perform the necessary technical evaluation and backups before upgrading.

Cocos Dashboard

The Cocos Dashboard serves as a unified downloader and launch portal for Cocos Creator and Cocos Creator 3D engines. Everyone can upgrade and manage multiple versions of Cocos Creator. In addition, unified project management and a creation panel is integrated, which is convenient for everyone to develop projects with different versions of engines at the same time.

Manage projects developed under different versions:

You can choose to use a different version of Cocos Creator when creating a new project:

Improvements

Bug Fixes

• [Editor] Fix the problem of importing TiledMap resources when related pictures do not exist
• [Core] Fixed 3D particle patch facing incorrectly [#6304]
• [Core] Fix the issue that the textures property of MeshRenderer is invalid after the version upgrade [#6311]
• [Core] Fixed the issue where the size of the node where Canvas may not be refreshed in time during scene initialization [#6308]
• [Native] Fix occasional white blocks on native images [#2258]
• [Native] Fix the issue that the memory of the 3D model rendering component of the native platform may not be released [#2262]
• [Mini game] Fixed the problem that a large number of audio files failed to load at the same time on the Alipay mini game [#97]

Known Issues

• An error will occur when importing Cocos Studio projects into Cocos Creator v2.3.2. This issue will be fixed in v2.3.3. Developers can temporarily import the project into an old version, if needed, and then upgrade to v2.3.2 for use, or use a custom engine and incorporate this change [#6278]

Deprecation

• Starting with v2.2.0, we no longer recommend using the Skew feature of Nodes. Skew is usually used to simulate 3D effects in 2D engines. With Cocos Creator’s in-depth support for 3D nodes, Skew effects can be completely achieved by using 3D nodes. Backward compatibility will be maintained for a period of time, developers can continue this original practice, in the old project. In the future, we will further improve the compatibility method and upgrade cases, and officially choose to remove the Skew function.

Upgrade Tips

Upgrading a project from a previous version of Cocos Creator is irreversible. Please backup the old version of the project before upgrading.

Projects under development can usually be upgraded seamlessly, but because of the uniqueness of each project, developers should conduct a technical evaluation based on their project’s own needs. If developers encounter difficulties in upgrading, please feel free to give us feedback and we will try our best to assist. In addition, due to stability considerations, it is recommended that projects that are about to be launched or already launched be upgraded with caution.

Upgrade from < v2.3.0 version

If a Can not find module.module for path… loading warning occurs:

After upgrading to 2.3, this warning may be due to the stricter case detection of the import/requirepaths in the script. In the old version, if the case of the path does not match the actual file, there may be some potential errors which may not be manifested. We recommend that projects experiencing this issue correct the capitalizations.

Since v2.3.0, Android and Android Instant use the same build template, please note:

• If the code is used solely by the Android platform, please put it in the app/src directory, and the third-party library used by itself, please put it in theapp/libs directory.
• If the code and third-party libraries used by Android Instant are separate, please put them in the game/src, game/libs directories.
• For code and third-party libraries shared by Android and Android Instant, please place them in the src and libs directories under the proj.android-studio root directory, respectively.
• proj.android-studio under the root directory jni/CocosAndroid.mk, jni/CocosApplication.mk, mainly used to configure engine-related configuration, developer configuration, it is recommended that Android be placed in app/jni/Android.mk and app/jni/Application.mk, Android Instant, please put in game/jni/Android.mk and game/jni/Application.mk.
• When Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling for Android Instant, it will execute instant: assembleRelease/Debug.

In addition, when Cocos Creator compiles for Android, it will execute assembleRelease/Debug by default, and when compiling Android Instant, it will executein``stant:assembleRelease/Debug.

If you have customized the pause logic when switching between audio background and background, please remove it after upgrading to 2.3.0 Currently Cocos Creator games automatically pause and resume audio internally when switching between front and back on all platforms. If the developer has customized this block before, and listens for and performs audio operations like cc.audioEngine.pause()/resume(), it may conflict with the engine’s default behavior. If you encounter related audio issues, simply remove the corresponding custom code.

Upgrade from version v2.0 – v2.3.0

Starting from 2.3.0, the Canvas component is no longer responsible for setting the Canvas node size to the screen size. This behavior will be implemented in conjunction with the Widget component. To ensure compatibility, after the 2.0 project is upgraded, the node where Canvas is located will automatically add Widget components. (No problem upgrading from a 1.0 project)

Upgrade from < v2.2.0

Starting from 2.2.0, we have strengthened the memory management mechanism, and now require users to dynamically create cc.Node which is independent of the scene node tree through code must be released through destroy(), otherwise the engine cannot know when to recycle this type The memory of the node will cause a memory leak.

• If a node is managed via cc.NodePool, it is not affected.

Upgrade from < v2.0

If you open the 1.x project, all resources such as scenes will be upgraded automatically. If there are warnings or errors in the code, you can refer to v1.10.0 Resource Upgrade Guide and the v2.0.0 Upgrade Documentation.

Improvements

• Adapted for WeChat PC game [[#87]
• Further optimize engine package size on mini-games and web platforms
• Improve API documentation and creator.d.ts declaration
• Added support for TiledMap Object layer Top-Down and Manual rendering order and horizontal and vertical flip (thanks @大城小胖) [[#6157] 
• Support using Backspace button to delete nodes in the scene
• Lock built-in resources to avoid misuse
• Disable evalString calls in native non-JS threads to avoid V8 crashes

Editor

• Fixed the issue that npm module cannot be used after upgrading to 2.3
• Fixed an issue where VS Code could not break after upgrading to 2.3
• After upgrading to 2.3, it may cause the script to depend on the cycle and an “TypeError: Object prototype may only be an Object or null” error occurs.
• Fixed the problem that plugin path may be wrong when building only scripts on Windows platform (thanks to shengyong)
• Fixed the problem of incomplete node display after importing some models (thanks C_Tsang)
• Fixed the issue that Spine binary files cannot be uploaded on WeChat mini games
• Fixed the issue that the signing certificate generated by Xiaomi to the default path will be deleted during the build

Engine

• [Core] Optimize the initialization process when dynamically creating Label nodes [#6173] 1
• [Core] Fixed the problem that dynamically modifying the material in Prefab will cause other same materials to be changed [#6201]
• [Core] Fix the rendering level problem that may be caused by repeatedly setting zIndex repeatedly (thanks @大城小胖) [#6227]
• [Core] Fixed the issue that the EditBox input box was misplaced after the CanWidth component was checked for fitWidth [#6233]
• [Core] Fix RichText’s modification and typographical errors when active is false [#6231]
• [Core] Fix the first Burst display of 3D particles is incorrect. [#6269]
• [Native] Fix the error caused by destroying Mask in event callback [#6186]
• [Native] Fixed the problem of invalid material switching technology (thanks inkfood.com 1) [#250]1
• [Native] Fix incorrect width and height obtained after window size change [#249]
• [Native] Fix the problem that the widget is not updated after the window size is changed [#6224]
• [Native] Fix JS native debugging cannot use Performance and Profiler [#2186]
• [Native] Fix Editbox clicking soft keyboard to collapse triangle, did not trigger edit completion event
• [Native] Fix memory leak when restarting the game [#2215]
• [Native] Fix the problem that the Android audio module will prevent the device from entering the power saving mode after entering the background [#2137]
• [Native] Fix window adaptive problem when split screen in Android [#2142]
• [Native] Fix window size error after Windows platform restart [#2129]
• [HTML] Fixed the problem that audio cannot be played when safari returns to the game from the background [#6198]
• [Mini game] Fix the problem that Audio is not destroyed [#6221]

Known Issues

• An error can occur when importing a Cocos Studio project in v2.3.1. This issue will be fixed in v2.3.2. Developers can temporarily import projects in the old version editor if needed, and then upgrade to v2.3.1 for use.

Upgrade Tips

Upgrading a project from a previous version of Cocos Creator is irreversible. Please backup the old version of the project before upgrading.

Projects under development can usually be upgraded seamlessly, but because of the uniqueness of each project, developers should conduct a technical evaluation based on their project’s own needs. If developers encounter difficulties in upgrading, please feel free to give us feedback and we will try our best to assist. In addition, due to stability considerations, it is recommended that projects that are about to be launched or already launched be upgraded with caution.

• Upgrade from < v2.3.0 versionSince v2.3.0, Android and Android Instant use the same build template, please note:
  • If the code is used solely by the Android platform, please put it in the app/src directory, and the third-party library used by itself, please put it in theapp/libs directory.
  • If the code and third-party libraries used by Android Instant are separate, please put them in the game/src, game/libs directories.
  • For code and third-party libraries shared by Android and Android Instant, please place them in the src and libs directories under the proj.android-studio root directory, respectively.
  • proj.android-studio under the root directory jni/CocosAndroid.mk, jni/CocosApplication.mk, mainly used to configure engine-related configuration, developer configuration, it is recommended that Android be placed inapp/jni/Android.mk and app/jni/Application.mk, Android Instant Please put in game/jni/Android.mk and game/jni/Application.mk. When Cocos Creator compiles Android, it will execute assembleRelease/Debug by default, and when compiling Android Instant, it will execute instant: assembleRelease/Debug.
• Upgrade from version v2.0 - v2.3.0Starting from 2.3.0, the Canvas component is no longer responsible for setting the Canvas node size to the screen size. This behavior will be implemented in conjunction with the Widget component. To ensure compatibility, after the 2.0 project is upgraded, the node where Canvas is located will automatically add Widget components. (No problem upgrading from a 1.0 project)
• Upgrade from < v2.2.0Starting from 2.2.0, we have strengthened the memory management mechanism, and now require users to dynamically create cc.Node which is independent of the scene node tree through code must be released through destroy(), otherwise the engine cannot know when to recycle this type The memory of the node will cause a memory leak.In addition, the nodes that are manually removed from the scene need to be unified when they are not needed. If a node is managed via *cc* NodePool, it is not affected.// Assuming testNode is a node in the scene, if it was manually removed from the scene before, such as testNode.parent = null; // or testNode.removeFromParent(true); // or parentNode.removeChild(testNode); // If testNode will be used again in the future, there is no need to manually destroy the node // otherwise it should be called manually testNode.destroy();
• Upgrade from v<2.0If you open the 1.x project, all resources such as scenes will be upgraded automatically. If there are warnings or errors in the code, you can refer to v1.10.0 Resource Upgrade Guide and the v2.0.0 Upgrade Documentation.

After a long period of development and preparation, and after a memorable Spring Festival, Cocos Creator v2.3 is officially released. v2.3 is a very important version that officially integrates support for 3D physics, collisions, and 3D particles, and is capable of developing more types of 3D games! At the same time, the material system has been upgraded from the experimental version to the official version, which can greatly improve the expressiveness of a game. It is recommended that all developers upgrade! Please perform the necessary technical evaluation and backups before upgrading.

Support publishing to Qutoutiao (QTT) mini games

Cocos Creator v2.3 officially supports publishing to a brand new platform: Qutoutiao Mini Games. For detailed steps on platform access, please refer to Publish to Qutoutiao Mini Games.

Support 3D physics system

Like Cocos Creator 3D, Creator’s physics engine is based on cannon.js and provides users with an efficient, componentized workflow with convenient usage methods. Currently, supported functionality is: rigid body, Box/Sphere collision components, trigger and collision events, physical materials, ray detection and many other features.

For detailed information, please refer to the Physics 3D documentation.

Supports 3D collision system

Like Cocos Creator 3D, Creator provides a lightweight collision detection system called Builtin. Builtin is a physics module with only a collision detection system. Compared to other physics engines, it does not have complicated physics simulation calculations, which will make the game’s package smaller and provide better performance.

For detailed information, please refer to the Physics Select documentation.

Support 3D particle system

The implementation of 3D particles is basically the same as Cocos Creator 3D. It is powerful and supports debugging in the editor.

There are currently dozens of modules to choose from, including Shape, Color, Velocity, Size, Sequence Frame, Trailing, and so on.

Currently provided are a variety of parameter settings such as: Constant, Curve, Two Constant, Two Curve, Gradient, etc.

For detailed information, please refer to the Particle System 3D documentation.

Upgrade the material system to the official version

Creator’s material system was originally added in v2.1.1, but has been marked as an experimental feature in the editor and lacked relevant documentation. After a few iterations, it has upgraded to the official version! This version of the Effect compilation syntax is consistent with Cocos Creator 3D. It can be written using VS Code’s Cocos Effect plugin, but the built-in shader variable names are slightly different. Developers who have customized materials in the previous version of Creator can try to upgrade to the official version according to the documentation. If you encounter difficulties, you can post on the forum for help. The features of the new version of the material system are as follows:

• Support real-time preview of modified results in the scene when modifying materials.
• Supports material variants and effect variants, making it more friendly to 2D games.
• Supports multiple techniques.
• Supports setting Technique, Pass, Property names.

For detailed information, please refer to the Materials documentation and the Effects documentation.

Support Spine and DragonBones mount nodes

When playing skeletal animations, developers often need to mount nodes on a certain part of the skeletal animation to achieve the effect of linking the node with the animation. In Creator v2.3, only a single, very simple operation is needed to mount any node to the bone animation. The node will follow the animation and transform it to achieve the effect of the hanging point. You can also add collision components to the node to achieve collision detection!

For detailed information, please refer to the Spine documentation.

Support Spine binary resource format

In Cocos Creator v2.3, the Spine runtime was upgraded to v3.8. v3.8 supports the skel binary format for importing from Spine. The usage of the skel format is the same as the original JSON format, but the file is smaller and loads faster!

Only recompile scripts when building

In the build panel, if you have successfully built the project before, you can check Build script only for the second build. The checked build will reuse the engine and resources that were built last time, and only recompile the scripts, which will greatly facilitate debugging! This is a very popular feature in the community, thank you very much for suggesting it.

Scene Editor adds 3D viewing options

Other Important Features

• Property inspector supports multi-select batch setting of resources
• Support switching single and multi-touch, use cc.macro.ENABLE_MULTI_TOUCH macro for setting [#5847]
• Label component supports bold, italic, and underline settings when using ttf or system font
• Added the vertical alignment property align and offset property offset of <img> in RichText, see the RichText documentation (Thanks RazgrizHsu [#6017]

Engine Fixes

• Optimize node performance when setting zIndex [#5899]
• Reduce the package size of WeChat, Baidu, Xiaomi, and Alipay mini game platforms by 100KB
• Removed the minimum size limit of dynamic photos, and minimized DrawCall [#5944]
• Optimize the performance of loading images natively (thanks wbenlong) # 2035
• Load subpackage API loadSubpackage supports incoming progress callback [#15]
• RichText supports setting the cache mode of Label, which can reduce DrawCall and optimize performance
• Optimized performance of Label when OverFlow is set to SHRINK [#5914]
• Toggle Modify the isChecked state by script. 2.3 New projects will not trigger events, and old projects will not change their behavior.
• Support Spine part map splitting, enhanced dressing function [#5711]
• Engine code supports writing in TypeScript
• Optimize private cache mode for bone animation [#6133]

• Fixed shadow rendering error of 3D objects [#5940]
• Fixed the problem that it is impossible to force logout of all listening events when node is destroyed (thanks to ssyyhm) [#5985]
• Fixed cc.game.once firing multiple times [#6055]
• Fixed the problem of incorrect node matrix after calling getBoundingBoxToWorld [#6108]
• Fixed Label unable to dynamically batch when using BMFont [#5860]
• Fix the problem of low performance when Label node Overflow is NONE, using Widget component at the same time [#5908]
• Fix RichText memory leak when using stroke
• Fixed the problem of TiledMap surface rendering error caused by texture compression [#5999]
• FixTiledMap incorrect calculation of bounding box when map is asymmetric shape [#5916]
• Fix the problem that API getPositionAt return value of TiledMap is incorrect [#5880]
• Fix Mask penetration problem of click event when nesting [#5749]
• Fix ScrollView wrong rotation direction detection after rotation [#6102]
• Fixed scrolling ScrollView cannot trigger scroll-end event [#5814]
• Fix PageView fast second drag when the border is exceeded, which will cause the page to jump disorderly [#6015]
• Fix PageView Indicator display error [#6123]
• Fixed the problem that the particle system image was stretched to a square [#5897]
• Fixed the problem of particle file parsing positionType error [#5946]
• Fix the problem that Graphic points drawn in the middle coincide with the starting point, the points drawn later will close automatically (thanks to chocolate) [#6002]
• Fix WheelJoint component setting frequency error report [#6000]
• Fixed the problem of incorrect calculation of orthoHeight when Align With Screen of Camera was false [#6139]
• Fix VideoPlayer Invalid local aspect ratio when displaying local video [#6138]

Native

• Fixed the problem that frequent creation of 3D models caused crashes [#2056]
• Fix the problem that there is no callback after the image fails to load [#2077]
• Fixed the problem of using local cache when loading remote audio with the same name [#219]
• Fixed the issue that Spine, DragonBones, and particles fail in batches after switching parent nodes [#1993]
• Fixed camera rendering error for multiple Stage [#1897]
• Fix Spine setAttachment interface is invalid [#1992]
• Fix EditBox input emoji crash [#2021]
• Fixed TiledMap rendering abnormally during dynamic loading [#229]
• Fixed the issue that the text layout of the iOS platform and the Mac platform are inconsistent with the web [#1960]
• Fixed the problem that iOS does not pause the game when double-clicking the home button [#1947]
• Fixed iOS crashing background when switching glContext from background [#2083]
• Fix the issue that files are not updated during Android Instant build [#2067]
• Fixed WebSocket crash on Android 64 models [#2074]

Mini Games

• Fix the problem that VideoPlayer cannot play when the scene is delayed loading [#72]
• Fix EditBox’s length is invalid when it is set to negative value [#60]
• Fixed the issue that the audio is not responding when loading on WeChat [#52]
• Fixed the problem of rendering errors using cartoon materials on WeChat [#6008]
• Fixed the problem that the hidden video is not paused when playing the WeChat mini-game VideoPlayer
• Fix issue with languageCode undefined on vivo platform

Web

• Fix the problem that the widget does not adapt correctly after the browser automatically rotates [#6061]
• Fixed the problem that the finger cannot be zoomed with UC browser full screen [#5863]
• Fixed the problem that VideoPlayer was in the wrong position after exiting full screen on IE browser
• Fix the problem that QQ browser gets wrong mouse position [#5604]
• Fix the problem of wrong touch event after scrolling in Safari [#5907]
• Fix the problem that Safari displays the wrong navigation bar [#5926]

Editor

• Scene editor supports focus node with F shortcut
• Added backspace shortcut for animation editor to delete animation frames
• Improve node multi-select batch setting, add multi-select add component function
• Fixed an animation error when the animation editor switches nodes with the same name
• Fixed the problem that the preview panel could not be displayed when switching to the game preview panel under animation editing
• Fixed the problem of calculating the center point of the rectangle change tool
• Fixed the problem that the resolution property of Canvas is not updated immediately in the scene
• Fixed the issue that the Canvas wireframe of the scene editor would be blocked by other nodes
• Fixed the problem that the node cannot be switched using the keyboard
• Fixed an issue where the animation editor displayed incorrectly when switching to a node without an animation component
• Fixed an issue where Color Picker could not save color presets
• Fixed the issue that the simulator resolution does not switch after running after switching projects
• Fixed issue where build failed using command line
• Fixed the problem that the native platform cannot build the audio module
• Fixed the problem that the build fails when there is no texture in the auto atlas
• Fixed build failure after copying project
• Fix the effect that the name of the Effect file is wrong when it starts with a number
• Fixed the issue of splash screen when switching editors
• Fixed TypeScript import failure
• Fixed the problem that the editor cannot be opened when the editor is installed on the Chinese path
• Fixed the problem of failed import model
• Fixed the problem that failed to build a new certificate for Xiaomi game on Windows
• Fixed the problem that nodes cannot be dragged after adding collision body components
• Fix the picture distortion caused by pvrtc-4bits-rgb-seprate-a when the texture has only three channels
• Fix ShowFPS button status not saved during webpage preview

BREAKING CHANGES

• cc.Mat4.translate method no longer supports rotation transformation, only pure displacement transformation is supported. If you need to support rotation, please usecc.Mat4.transform instead.

KNOWN ISSUES

• Requiring node_modules directly is not available in v2.3.0 temporarily. It will be fixed in the next version. It is currently recommended that external libraries be compiled separately and imported using the Plugin Scripts.

Deprecation

• Starting with v2.2.0, we no longer recommend using the Skew feature of nodes. Skew is usually used to simulate 3D effects in the 2D engine. With Cocos Creator’s deep support for 3D nodes, the Skew effect can be completely realized by 3D nodes. Inorder to unify the user experience and further optimize the underlying implementation of the engine, we discarded the Skew attribute. However, we will still maintain backward compatibility for a period of time, developers can continue the original practice in the old project. In the future, we will further improve the compatibility method and upgrade cases, and officially choose to remove the Skew function.

Upgrade Tips

Upgrading a project from a previous version of Cocos Creator is irreversible. Please backup the old version of the project before upgrading.

Projects under development can usually be upgraded seamlessly, but because of the uniqueness of each project, developers should conduct a technical evaluation based on their project’s own needs. If developers encounter difficulties in upgrading, please feel free to give us feedback and we will try our best to assist. In addition, due to stability considerations, it is recommended that projects that are about to be launched or already launched be upgraded with caution.

• Upgrade from < v2.3.0 version
  Since v2.3.0, Android and Android Instant use the same build template, please note:
  • If the code is used solely by the Android platform, please put it in the app/src directory, and the third-party library used by itself, please put it in theapp/libs directory.
  • If the code and third-party libraries used by Android Instant are separate, please put them in the game/src, game/libs directories.
  • For code and third-party libraries shared by Android and Android Instant, please place them in the src and libs directories under the proj.android-studio root directory, respectively.
  • proj.android-studio under the root directory jni/CocosAndroid.mk, jni/CocosApplication.mk, mainly used to configure engine-related configuration, developer configuration, it is recommended that Android be placed inapp/jni/Android.mk and app/jni/Application.mk, Android Instant Please put in game/jni/Android.mk and game/jni/Application.mk. When Cocos Creator compiles Android, it will execute assembleRelease/Debug by default, and when compiling Android Instant, it will execute instant: assembleRelease/Debug.

• Upgrade from version v2.0 - v2.3.0
  Starting from 2.3.0, the Canvas component is no longer responsible for setting the Canvas node size to the screen size. This behavior will be implemented in conjunction with the Widget component. To ensure compatibility, after the 2.0 project is upgraded, the node where Canvas is located will automatically add Widget components. (No problem upgrading from a 1.0 project)

• Upgrade from < v2.2.0
  Starting from 2.2.0, we have strengthened the memory management mechanism, and now require users to dynamically create cc.Node which is independent of the scene node tree through code must be released through destroy(), otherwise the engine cannot know when to recycle this type The memory of the node will cause a memory leak.In addition, the nodes that are manually removed from the scene need to be unified when they are not needed. If a node is managed via cc NodePool, it is not affected.
  
  // Assuming testNode is a node in the scene, if it was manually removed from the scene before, such as
  testNode.parent = null;
  // or
  testNode.removeFromParent(true);
  // or
  parentNode.removeChild(testNode);
  // If testNode will be used again in the future, there is no need to manually destroy the node
  // otherwise it should be called manually
  testNode.destroy();

• Upgrade from v<2.0
  If you open the 1.x project, all resources such as scenes will be upgraded automatically. If there are warnings or errors in the code, you can refer to v1.10.0 Resource Upgrade Guide and the v2.0.0 Upgrade Documentation.

Cocos Creator v2.2.2 is intended to fix defects and improve product stability. Please see below for a subset of improvements.

Upgrade Instructions

• If you open the 1.x project, all resources such as the scene will be automatically upgraded. If there is a warning or an error, please refer to 1.10.0 Resource Upgrade Guide and 2.0.0 Upgrade Documentation to make adjustments.
• 2.0, 2.1 Projects can be upgraded directly and seamlessly.
• Starting with 2.2, we have enhanced the memory management mechanism. Now the cc.Nodethat is dynamically created by the code and independent of the scene node tree must be released by destroy(), otherwise the engine doesn’t know when to recycle such nodes. In addition, nodes that are manually removed from the scene need to unify destroy when they are not needed. If the node is managed via cc.NodePool, it is not affected.

    // Suppose testNode is a node in the scene, if it was manually removed from the scene, such as
    testNode.parent = null;
    // or
    testNode.removeFromParent(true);
    // or
    parentNode.removeChild(testNode);
    // If testNode will be used again later, there is no need to manually destroy the node.
    // Otherwise it should be called manually
    testNode.destroy();

Bug Fixes

• Fix a possible memory leak issue with Spine, DragonBones, and particle systems on native platforms [#5905]
• Fix possible memory leak when using RichText with Outline [#5906]
• Fix the problem that WeChat mini game may not end when loading multiple audios at the same time [#57]
• Fix the problem that calculateDeltaTime may endlessly loop after the WeChat mini game is cut back from the background [#e222465]

The Cocos Creator team has worked hard to release v2.2.1. A big THANK YOU! to all the developers that upgraded to previous versions of v2.2 and provided feedback to help continue to make Cocos Creator a preferred tool is creating multi-platform games. Your encouragement and feedback keep us motivated and provide confidence to make the decisions to move Cocos Creator in the direction to become the number 1 choice in game development environments. Cocos Creator allows developers to enjoy creating amazing games and distributing them to a variety of platforms. Cocos will, as always, optimize the performance and user experience of our products.

This release brings a large number of experience optimizations, defect repairs, and performance optimizations. At the same time, support for Alipay Mini-Games has been added.

It is recommended that all developers upgrade after performing the necessary technical evaluations and after upgrading their existing projects for safe-keeping. Please do not skip these steps.

Support for Alipay Mini-Games

Mini-Games are insanely popular and many platforms are starting to support them. This opens up many new revenue opportunities. Alipay, an e-commerce giant recently added support for mini-games. Cocos Creator v2.2.1 is the first platform to release support for Alipay Mini-Games. For more information, please refer to《Alipay Mini-Games》.

Support WeChat mini game engine plugin

The game engine plug-in is a new feature of WeChat version 7.0.7. This can greatly reduce the download time of games. This plug-in is now integrated into Cocos Creator v2.2.1 as part of the environment and will be more convenient to use. Developers only need to check Allow engine separation in the Build panel, and then build the release normally, without any other manual operations.

For more information, please refer to《WeChat Engine Plugin》.

Upgrade Instructions

• If you open the 1.x project, all resources such as the scene will be automatically upgraded. If there is a warning or an error, please refer to 1.10.0 Resource Upgrade Guide and 2.0.0 Upgrade Documentation to make adjustments.
• 2.0, 2.1 Projects can be upgraded directly and seamlessly.
• Starting with 2.2, we have enhanced the memory management mechanism. Now the cc.Nodethat is dynamically created by the code and independent of the scene node tree must be released by destroy(), otherwise the engine doesn’t know when to recycle such nodes. In addition, nodes that are manually removed from the scene need to unify destroy when they are not needed. If the node is managed via cc.NodePool, it is not affected.

    // Suppose testNode is a node in the scene, if it was manually removed from the scene, such as
    testNode.parent = null;
    // or
    testNode.removeFromParent(true);
    // or
    parentNode.removeChild(testNode);
    // If testNode will be used again later, there is no need to manually destroy the node.
    // Otherwise it should be called manually
    testNode.destroy();

Cocos Creator v2.1.4 adds support for Alipay games.

Support for Alipay games

Cocos Creator officially supports releasing to the new Alipay platform. Since Cocos Creatorsmoothes the transition between platforms for developers, it’s easy for developers to publish to Alipay games. For detailed steps refer to Publish to Alipay. Alipay is currently being opened and is a prime target for future opportunities.

Other changes (relative to 2.1.3)

• Fixing a disabled Label node may cause Prefab to fail to roll back in the editor [#5460]
• Fixed UA information recognition issue in Safari browser after iPad update to iPadOS 13.1.1+
  (thanks to krapnikkk)[#5636]

Version Updates

Cocos Creator v2.2.1 is coming soon. please view the Welcome Experience topic. This version will integrate Alipay games.

The Cocos Creator team has been hard at work ensuring that your games perform very well on each platform we support. Cocos Creator v2.2.0 greatly enhances the performance of the native platform, and includes a large number of feature enhancements and experience improvements. All Cocos Creator developers should consider upgrading to this latest version.

Greatly improve native platform rendering performance

In this version, we have significantly upgraded the rendering engine and achieved tremendous performance improvements on native platforms, surpassing the speeds of all previous versions of Cocos Creator, Cocos2d-js and Cocos2d-x.

Cocos Creator v2.2 can meet all the performance needs of every game, small to large, simple to complex, few gaphics to 1,000’s of graphics. To help gauge performance, low-end devices, such as the OPPO A57 and the iPhone 6S+ were used. We also compared previous versions of Cocos Creator, Cocos2d-js, Cocos2d-x and Cocos2d-lua to ensure we were testing in a broad spectrum, to provide the most accurate data. The results:

• On Android native, the performance of Cocos Creator v2.2.0 is 1.5x - 1.7x Cocos2d-lua and Cocos Creator v1.9.3.
• On iOS native, the performance of Cocos Creator v2.2.0 is flush with
  Cocos2d-lua, which is 3x - 4x Cocos Creator v1.9.3.

In addition, Cocos Creator v2.2.0 running on iOS not only improves the frame rate, but also greatly reduces any possibility of jittering when garbage collection occurs. This means the actual game play experience will be really smooth. Here is detailed performance data：

Support 3D model rendering batch

Cocos Creator v2.2.0 adds support for rendering batches of 3D models, which effectively reduces the drawcalls for 3D games. To enable this feature, you simply check the enableAutoBatch attribute on the Mesh Renderer and the engine will automatically batch based on the material used, as well as the Mesh vertex format and Primitive Type. For better optimization, it is recommended that you enable this option only for models that can be batched and have a small number of vertices.

Support for alpha channel separation of PVR compressed textures

Alpha channel separation format (RGB+A) for PVR compressed textures has been added. This format uses a similar method to etc. to separate and compress the transparent channel of the texture. After compression, the texture height will be twice that of the original image, thus avoiding the problem of low image quality in the conventional PVR RGBA format.

Support for custom browser preview templates

Allow users to customize the webpage used for browser preview in a way similar to custom build templates. Support for 3 formats: HTML, Jade, EJS. See: Custom Preview Templates.

Support for ambient light settings

We have added an ambient light setting to the Light component for basic lighting of 3D scenes. This is often used to solve the problem of blackout of the back surface of the model. Just select Create Light → Ambient in the Node creation menu. You can also add a Light component to the Node and set the type to be created for AMBIENT.

Further improve the performance of Spine and DragonBones

Cocos Creator v2.2.0 optimizes the performance of 2D skeletal animation on various platforms.

• On the native platform, we have added support for Spine and DragonBones SHARED_CACHE and PRIVATE_CACHE. When the acceleration mode is enabled, the Spine performance of the Android platform is 2x that of the original, and the DragonBones performance
  is 7x the original. iOS platform Spine performance is 3x the original,
  DragonBones is 5x the original.
• After enabling acceleration mode on the web platform, Android Spine performance is 3x the original, and DragonBones performance is 4x the original. iOS Spine performance is 1.25x the original, DragonBones performance is 1.39x the original.

Here is a breakdown of the detailed performance data:

To enable acceleration mode, simply set the Animation Cache Mode to SHARED_CACHE or PRIVATE_CACHE on the Spine or DragonBones component. For more detailed information acceleration mode, refer to the property descriptions in the documentation.

• Spine reference documentation
• Dragonbones reference documentation 

Spine runtime upgraded to 3.7

• Support Spine partial reloading, please refer to Spine Component Reference, see SpineSkin in the engine’s own example.
• Support Spine vertex effect, please refer to Spine Component Reference: Spine Vertex Effect, please refer to SpineMesh in the engine’s own example.

Significantly enhanced TiledMap support

Cocos Creator v2.2.0 further improves the support of TiledMap. Grid rotation, grid animation, image layers, layer offsets, and object group text are now supported. Supporting multiple Tilesets in a single layer is also now possible. It also supports adding child nodes to the scene and creating an occlusion relationship with the map. And fixed the problem of rendering errors after a single map vertex exceeds 65535. For details, see TiledMap Component Reference. For details on use cases, see ShieldNode in the engine’s own example.

Property inspector tag supports width adjustment

We added a width adjustment function to the Property inspector to solve the problem of incomplete display of attribute names on some components. Now users do not need to greatly adjust the size of the entire panel, just drag the dividing line to the right of the property name to freely adjust the split ratio.

Improvements

• Optimize the editor and the startup speed of each panel
• Avoid every time the WeChat game build will overwrite the configuration file in the target project in order to retain the user’s custom configuration
• Change the margin property in the SpriteFrame resource panel and Sprite Editor from the trimmed margin to the original margin. Make it consistent with the data given in the art drawing, and have no effect on the old project data.
• Automatically remove the open domain components of other small game platforms during the build process, users do not need to manually configure in the module settings
• The native platform package name in the build panel will be stored separately according to different platforms
• Upgrade the editor’s Electron to 5.0.8, V8 to 7.3, node.js to 12.0.0
• Optimized Spine Initialization problem after enabling acceleration mode
• Officially supported on iOS platform etc2 Compressed texture
• Enable OpenGLES3 by default on iOS
• Adaptation macOS Catalina

Editor Fixes

• Fixed an issue where the scene name could not be obtained during preview after exiting Prefab edit mode
• Fixed 3D node in scene editor may show confusion after exiting Prefab edit mode
• Fixed an issue where the animation editor was being deleted and the animation editor would report an error.

Engine Fixes

• Fixed an issue where events polled with once could not be logged off
• Fixed cc.systemEvent listening for invalid once events (thanks to Zty)
• Fixes DragonBones and Spine textures do not support the problem of scene resource lazy loading [#4299]
• Fix part DragonBones The animation is not playing correctly
• Fixed an issue where warnings were not raised when the type was set to JavaScript’s native Number, String, etc. when using the decorator to declare CCClass
• Fixed a problem where the default value is incorrect when the CCClass is declared as the default value of cc.String, cc.Boolean, etc.

Native

• Fixed a problem with music being paused from the background after the music was paused on the native platform [#141] [#1875]
• Fix Android After playing multiple Audio instances in succession, there is a random problem with some sounds [#1869]
• Fixed Audio for lazy loading on native platforms, unable to stop after playback [#180]
• Fix iOS or Mac When the native platform reloads Font, it may cause memory leaks [#1761]
• Fix iOS 13 Dark mode causes EditBox white fonts are not visible [#1866]

Web

• Fix IE11 VideoPlayer Can’t full screen issue [#4879]

Mini Game

• Fixed AudioSource’s playOnload may not work
• Avoid iOS on Baidu game cut scenes may be black screen problem

REMOVED

• Removed Visual Studio 2015 support for building Windows platforms for unified use of 2017.

BREAKING CHANGES

• Adjust cc.winSize from cc.Vec2 to cc.Size

KNOWN ISSUES

• v2.2.0 does not support the Skew effect on nodes for the time being. We will provide documentation to guide you to manually enable Skew support. For new projects it is suggest ed to use 3D Sprite directly instead of Skew. For old projects please refer to [#5564] and [#1889] to match js and native engines to support Skew.
• After publishing to Windows/Mac, to resize the screen, please manually follow [#1930] to accommodate.
• Some old projects may have referred to this [forum post], which implements screen rotation on iOS and Android. This is now old information. Please manually follow [#1930] to accommodate.
• On some macOS machines, `Label` will appear in the CHAR mode with a white border. This problem has a small impact and will be fixed in 2.2.1. For more follow-up version plans, please refer to the [roadmap].

Upgrade Instructions

• If you open the 1.x project, all resources such as the scene will be automatically upgraded. If there is a warning or an error, please refer to 1.10.0 Resource Upgrade Guide and 2.0.0 Upgrade Documentation to make adjustments.
• 2.0, 2.1 Projects can be upgraded directly and seamlessly.
• Starting with 2.2, we have enhanced the memory management mechanism. Now the cc.Nodethat is dynamically created by the code and independent of the scene node tree must be released by destroy(), otherwise the engine doesn’t know when to recycle such nodes. In addition, nodes that are manually removed from the scene need to unify destroy when they are not needed. If the node is managed via cc.NodePool, it is not affected.

// Suppose testNode is a node in the scene, if it was manually removed from the scene, such as
testNode.parent = null;
// or
testNode.removeFromParent(true);
// or
parentNode.removeChild(testNode);
// If testNode will be used again later, there is no need to manually destroy the node.
// Otherwise it should be called manually
testNode.destroy();

Since the release of Cocos Creator 2.1.0, after six months of update iterations, the version has stabilized, and the new users of 2.1 are now in the mainstream. Therefore, we plan to reduce the maintenance of the 2.0 version, focus our efforts on 2.1 and 2.2 development, and strive to make Cocos Creator a more focused, open and healthy open source platform.

Cocos Creator v2.1.3 optimizes the experience and fixes bugs. It is recommended for all v2.0 and v2.1 projects in development. to upgrade.

Support iOS 13

To support the upcoming iOS 13 operating system, we replaced the underlying VideoPlayerimplementation on iOS native with the MPMoviePlayerController for AVPlayerContoller [#1831], at the same time, the underlying WebView with UIWebView for WKWebView was replaced. [#1837].

Improvements

• Add fault tolerance to the component’s onLoad, start, update, lateUpdate functions to better handle exceptions thrown by user scripts. [#4941]
• When you preview particles in the editor, the particles in the child nodes under the current node will be played synchronously, which is convenient for art. (In the editor, the particles in the child nodes under the current node are played simultaneously for easy art viewing).
• Improve the behavior of dragging resources into the scene for creation (Improve the behavior of dragging resources into the scene for creation)
• Add the option Packable in the Property inspector to see if the image can be dynamically combined. It solves that custom shaders can’t get the original UV. For details, see Texture:packable.
• Allow double-click on the json asset in Assets panel in the resource editor
• Set the texture type to RAW by default when importing the plist atlas when importing plist atlas
• Add Vec4 type support to Properties panel in the Property inspector.
• Improvements creator.d.ts Type hints (Improve some creator.d.ts type hints)
• Optimized Label’s SHRINK dynamic layout, while supporting CHAR mode (Optimize the SHRINK dynamic layout of Label and support CHAR mode)[#5223]
• Avoid performance overhead when calling Texture2D.update multiple times [#5198]
• Upgrade V8 to 7.5 on Android.
• VideoPlayer is available to WeChat Mini Game.

Editor Fixes

• Fixed an issue that rotation data in AnimationClip will be lost after upgrading from v2.0
• Fixed an issue where the rotation of the scene and nodes in Prefab at a certain angle was lost after upgrading from v2.0
• Fixed an issue where some items open on the machine and stopped at the Is importing resources, please wait interface
• Fixed a problem that compressed texture may be missing after project build (thanks to xu.lidong)
• Fixed a problem that when a compressed texture’s quality is 100, the builder cannot generate the image file correctly.
• Fix an issue where script may be misreported after it is moved or renamed
• Fix Animation editor issue where the timeline editor can’t set Node’s z value
• Optimized Animation editor Optimized the error handling of the Timeline editor when the state of components, assets, etc. changes
• Fix an issue where the gizmo is not located correctly in the scene editor
• Fix the problem where the node rotation can not be undone.
• Fixed attribute checker settings Camera’s Rect has no effect) [#5294]
• Fixed an issue where a scene or prefab could not be opened normally after something went wrong with their data in some cases
• Fixed an issue where RichText or Label components may generate a space at the beginning of a line when after the text that the RichText or Label component fills in the editor is automatically wrapped. The text filled in in the editor is wrapped.
• Fixed an issue where content is not displayed when the NodeTree and Assets merge into the same panel when fixing the level manager and the resource manager merged into the same panel.

Engine Fixes

• Fixed an issue where a scene async loading assets can cause the 3D model can not be displayed [#5071]
• Fixed an incomplete rendering issue of 3D skeleton animation [#5349]
• Fixed problems that requestAnimFrame related error may occur when the engine is initializing [#5248]
• Fixed an issue where dynamic stitching would cause texture edge pixel anomalies in certain situations (thanks to unace)[#5242]
• Fixed problems that Animation’s “stop” and “lastframe” don’t trigger under certain situations [#5246]
• Fixed an issue loading a scene with WebView, then the first frame will flash on screen after The scene is switched [#5106]
• Fixed the problem that the Label** text will still show after the text is empt [#5266] [#5284]
• Fixed an issue when a Label used with a LabelOutline, Label Overflow is set to SHRINK or CLAMP, and CacheMode is set to CHAR, the node is not sized correctly)[#5145]
• Fixed an issue where RichText may lose spaces after wrapping [#5116]
• Fixed an issue where the Sprite component does not support MESH mode [#5195]
• Fixed an issue where ScrollView, PageView enables Elastic May not bounce back after sliding beyond the boundary [#4894]
• Fixed an issue with ScrollView’s ScrollBar display unexpected [#5249]
• Fixed an issue where Layout doesn’t work correctly when it’s scaling less than 1)[#5074]
• Fixed an issue that the node where the PhysicsCollider is located may report error by modifying the node’s group property in runtime (thanks to HengHuH [#4949]
• Fixed an issue where the engine’s built-in assets may have been mistakenly released by the user[#4915]
• Fix an issue where memory leaks can occur when a large number of render nodes are added and deleted [#5025]
• Fixed node’s targetOff method may not work [#5052]
• Fixed an issue where an audio instance may have been destroyed by error after more than 32 audio instances are playing At the same time [#5097]
• Fix the problem with particle coordinate errors in Free mode [#5320]

Native

• Fixed Label memory leaks on native platforms [#1783] [#1786]
• Fixed an issue where the EditBox font defaults to white on some Android models [#1778]
• Fixed issues where EditBox characters is overlapping in input state on Mac and Windows [#146]
• Fixed an issue where EditBox input emoji on iOS may crash [#1798]
• Fixed the problem that the EditBox input box position is abnormal when the Canvas adapt mode is SHOW_ALL [ #162]
• Fixed an audio bug on Android that audios are not paused when locking screen while Notification drawer is Showing [#1788]
• Fixed an issue on Android with the program that audio still play in the background when the screen is on. [#1785]
• Fixed an issue where the paused audio is automatically played when game switch from background to foreground [#145]
• Fixed an issue when changing Spine/DragonBones material on native platforms, position go wrong [#148]
• Fixed an issue on native platforms where opacity of Spine/DragonBones incorrect at first Frame. [#148]
• Fixed an issue where VideoPlayer can’t return after fullscreen on iOS [#1800]
• Fixed an issue where the lock screen will get stuck when VideoPlayer plays on Android when playing on Android [#1811]
• Fixed an issue where cc.sys.languageCode can’t get full language area code on Android)[#1784]
• Fixed a problem that failed to call cc.game.setFrameRate() on the Mac Platform when plugin scripts were initializing [#5261]

Web

• Improve support for IE11. [#5033]
• Fixed an issue where clicking the EditBox clear button which comes with Edge browser does not trigger the Input event. [#5088]
• Fixed an issue where EditBox’s text size failed to scale with Node during the input process [#5088]
• Fixed an issue where audio can’t play on Edge and Baidu browsers [#4910]
• Fixed a problem where audio might not play on desktop Chrome and Safari [#4991]
• Fixed an issue where desktop UC browser play WebAudio reports errors [#5048]
• Fixed the error caused by audio call setTargetAtTime when game runs on Crosswalk [#5281]

DEPRECATIONS

• Discard the convertToWorldSpace function on Node, please use convertToWorldSpaceARinstead.
• Discard the convertToNodeSpace function on Node, please use convertToNodeSpaceAR instead.
• Improve the camera’s coordinate conversion API
• getCameraToWorldPoint is changed to getScreenToWorldPoint and supports 3D Camera
• getWorldToCameraPoint is changed to getWorldToScreenPoint and supports 3D Camera
• getCameraToWorldMatrix is changed to getScreenToWorldMatrix2D, only 2D Camera is supported.
• getWorldToCameraMatrix is changed to getWorldToScreenMatrix2D, only 2D Camera is supported.

Six months has passed since the release of Cocos Creator v2.1.0, and the team has been hard at work creating the next releases. Cocos Creator v2.1.0 is our most popular release to date. The development teams effort will be spent on Cocos Creator v2.1.0 and therefore maintenance of v2.0.xwill be discontinued. v2.0.x users should consider upgrading to v2.1.1 when it makes sense to do so.

The v2.1.2 update includes not only general experience optimizations and bug fixes, but also the optimization of pure 2D projects, as well as a decrease in project size. At the same time, this version also incorporates all the changes in v2.0.10, supporting the two new platforms: Xiaomi Mini Gamesand Cocos Play.

Optimizing 2D projects

Previously we had always positioned v2.1 as a 3D predecessor, so v2.1 was lagging behind for the care of pure 2D projects. However, v2.1.2 has been carefully optimized to work well with both 2D and 3Dprojects. Now we officially recommend that all v2.0 projects be upgraded to v2.1.2. Projects upgraded from v2.0 will default to 3D modules, ensuring that there is no impact on the package and performance of 2D projects. To add 3D support, manually check the 3D module in Menu → Project → Project Settings → Module Settings.

Supports Xiaomi Mini Games

Cocos Creator officially supports publishing to Xiaomi Mini Games. For detailed usage, please refer to Publish to Xiaomi Mini Game.

Supports Cocos Play

Cocos Creator officially supports publishing to Cocos Play. For detailed usage, please refer to Publish to Cocos Play.

Improvements

Improve the WeChat game resource loading process

• Fixed a problem where the resource might not load successfully (thanks to snow_storm for feedback) [#97]
• Optimize processing logic when caching fails [#98]
• Fixed a problem with subsequent callbacks of remote images without multiple callbacks [#96]
• Avoid crashes caused by oversized json file parsing (thanks to canghai7789 for feedback)[#101]
• Adjust the cache interval to reduce the impact on the game frame rate [#97]

Editor Fixes

• Complete automatic atlas algorithm, now you can generate the smallest size atlas without manually adjusting max size
• Improve Windows platform support for multiple monitors. Now the editor automatically detects window visibility when it starts, ensuring that the window displays properly
• Increase warning information before project upgrade or downgrade to prevent users from misoperation
• Added DragonBones and Spine’s dressup demo [#725] in the included sample project
• Optimized editor compatibility with GPU devices and reduced false positives due to WebGL compatibility
• Improved the Asset Watcher mechanism. If the type of an accessor(getset) of a component is defined as an array of resources, the setter will be triggered to reset the entire array when the corresponding resource changes

Engine Fixes

• Turn off preserveDrawingBuffer by default on WeChat game, which solves the problem that the game will be stuck for a few seconds from the background to the front desk [#4537]. (The WeChat game must be enabled with preserveDrawingBuffer when it is first released, otherwise the scene switch will be black)
• Improved positioning accuracy of Label on native platform [#4765], [#1764]
• Optimized BMFont Memory usage during rendering [#4651]
• Allow Label to be modified again after setting it to BITMAP mode (although it is still not recommended, resulting in additional memory and performance overhead)
• Reduced the timeout for loading ttf fonts from Web platform from 60s to 3s [#4536]
• Added url attribute to Asset to get the actual url of the current resource. Developers can directly call the platform’s native API to use these urls [#4536]

Bug Fixes

Editor

• Cannot convert undefined or null to object may be reported when fixing a build project
• Fixed rendering problems caused by the offset of some Sprites when importing plist atlas
• Fix gizmo related issues for circle collider
• Fixed an issue where VideoPlayer and WebView were not displaying correctly in the editor
• Fixed an issue where the render component could not save the custom material [#4390]
• Fixed an error when compiling scripts using the command line
• Fixed issue where the scene editor does not display the animation track in the animation editing mode
• Fixed issue where the plugin’s own runtime-resource could not be displayed in the explorer after reloading the third-party plugin reload
• Fixed a problem where the project might fail to build when the image suffix in the automatic collection is named uppercase PNG

Engine

• Fix Input events Respond to problems with hierarchical errors in individual cases [#4522]
• Fixed an issue where the z setting of the 3D node is invalid [#4408]
• Fixed 3D GPU bone count failed to determine correctly, causing problems that the model may not display in some cases [#4772]
• Fixed an issue where releasing remote image release failed [#4536]
• Fixed Spine and DragonBones rendering batch invalidation issues in v2.1.1 [#4645]
• Fix Spine uses rendering problems after clipping [#4744]
• Fix Label When using BITMAP mode, dynamic mapping does not work [#4393]
• Fix Label When using CHAR mode, Label Outline will be cropped [#4550] [#4807] [#4809]
• Fixed PageView Sliding position calculation error when dynamically adding page [#4556]
• Fixed an issue where cc.tween has a value of 0. [#4790]
• Fix the problem that the distance returned by the ray detection will be affected by the node scaling [#4562]
• Fixed an issue where built-in resources would be emptied when restarting the game [#4509]
• After the repair project is directly upgraded from version 2.0 or earlier, the Rotate related Action orientation will be wrong.
• Fixed native platform Label rendering performance degradation problem [#1765] [#143]
• Fix native platform, if you render the 3D model with less bones first and then render the model with more bones, the problem will be rendered incorrectly [#4473]
• Fix native platform after executing cc.game.end() If there are still resources downloaded in the background, it will cause a crash [#1763]
• Fixed Spine on the native platform. Frequent loading and unloading of the resource [#1758]
• Fixed native platform sub-package scripts are not encrypted as jsc files
• Fix Windows platform Label Inconsistent text size [#1766]
• Fixed a problem with WebGL compatibility errors reported on some browsers after version 2.1 [#4394]
• Fix Web platform EditBox occlusion of other UI control touch events (change default stayOnTop to unStayOnTop)[#4705]
• Fix Web on the mobile sideEditBox When cloning the soft keyboard, the problem of adapting the Canvas size multiple times[#4705]
• Fix Web platform EditBox Placeholder shows incorrect question when multi-line input [#4705]
• Fix WebAudio setting the volume may not work immediately [#4767]
• Fixed IE 11 compatibility issue[#4659] [#4701]
• Fixed iOS on WeChat browser EditBox problem with misplaced touch area after soft keyboard [#4705]
• Fixed a problem with the Facebook Live SDK logic exception
• Fix WeChat mini game On iOS Audio may not be replayable [#102] [#107]
• Fix WeChat mini game on background music can not stop the problem [#4793]
• Fix WeChat mini game answer phone after Audio no longer resumes playing [#4757]
• Fix WeChat mini game Open field does not support the error caused by Button Gray Effect [#4474]
• Fix WeChat mini game Open domain does not support WebGL caused an error [#4748]
• Fixed call to WeChat game in version 2.1.1 subContextView.update() Unable to update open domain map issue [#4721]

Since v2.0.0 has been rewritten from the bottom with a 3D renderer, Cocos Creator has evolved into a game engine that can be both lossless and purely 2D and 3D. In the future, Cocos Creator will continue to adhere to the 2D first concept, continue to improve 2D game development experience and basic performance, and gradually introduce 3D features suitable for 2D games.

We are proud of v2.1.2, and we wonder if you are proud too? Good quality is inseparable from careful polishing, and Cocos will continue to improve the quality of its products with a down-to-earth spirit. We welcome our community to continue to submit feedback to us through forums, GitHub, Cocos Enterprise Services and other channels!

Cocos Creator v2.0.10 focuses on improving the stability of the native platform, fixing issues related to Spine, DragonBones, and Label. It is recommended that all v2.0 users upgrade. In addition, v2.0.10 also supports the release of two new platforms, Xiaomi Quick Game andInstant Play Games, which bring new opportunities for developers. Good quality is inseparable from careful polishing. Thank you for the feedback from developers in the community, GitHub, Cocos corporate services and other channels.

Support Xiaomi Quick Games

Cocos Creator officially supports the publishing to Xiaomi Quick Games. For detailed usage, please refer to Publish to Xiaomi Quick Games.

Support Instant Play Games

Cocos Creator officially supports publishing to Instant Play Games. For detailed usage, please refer to Publish to Instant Play Games.

Editor Fixes

• Optimize the build speed of very large projects
• Improve error handling when resources uuid conflicts
• When the build release is removed, the Auto Atlas is empty warning, allowing the auto atlas to be empty
• Added package name options for iOS and Mac platforms in the build panel

Engine Fixes

• Optimize the node's zIndex refresh performance #4060
• Added global timeScale options for Spine and DragonBones, set via API sp.timeScale and dragonBones.timeScale
• Optimized Spine and DragonBones initialization speed in acceleration mode
• Added getArmatureKey method to DragonBones's ArmatureDisplay for indexing as a dressup #4100
• Added BlendFactor support for MotionStreak
• The cc.macro.CLEANUP_IMAGE_CACHE flag is enabled by default on the native platform to reduce texture memory usage
• Optimized Native platform Spine memory footprint
• Optimized instant game open domain performance
• Added fps attribute to the instant game open domain component SubContextView to control the open domain refresh rate, default 60
• Disable the main loop of the open domain by disable instant game open domain component SubContextView, reducing performance overhead, see WXSubContextView Tips
• Upgrade WeChat game resource loading speed
• Fixed an error in the engine when Rect width exceeds maximum margin was reported when importing a fully transparent image

Bug Fixes

Editor

• Fixed an issue where the build of OPPO, vivo, and Huawei games might encrypt the script to JSC and cause the build to fail.
• Fixed an issue where the Android Studio SDK path would report an error under Windows
• Fixed an issue with compiling errors when using the link template when building a Mac platform
• Fixed an issue where a very large project might be reported on the Windows platform (when the number of resources > 100,000)
• Fixes Auto Atlas may export more unused SpriteFrame or SpriteAtlas resources when building
• Fix Auto Atlas Warning message may be incorrect when building
• Fixed an issue where the particle system could not be previewed in the editor after enabling Custom mode
• Fixed an issue where if the font name had parentheses when importing BMFont
• Fixed object already destroyed warning when it appears repeatedly in Prefab edit mode
• Fixed an issue where returning to the scene when entering Prefab edit mode from a scene with DragonBones or Particle
• Fixed removing the TiledLayer node, then Undo, will report the material is empty
• Fixed a problem with data corruption when exporting multiple resources in batches
• Fixed an issue where child nodes could still be selected in the scene after locking the parent node in the hierarchy manager
• Fixed an issue where resources could not be dragged to the hierarchy manager when there were no nodes in the scene
• Fixed an issue where renaming file operations in Resource Manager might not work
• Fix the problem that after the animation editor finishes playing the animation, manually skipping one frame and then playing it will cause an error.
• Fixed an issue where the project could not be opened when the configuration file was corrupted
• Fixed an issue where a new project could not be created when the custom engine did not exist

Engine

• Fixed DragonBones Parent bone transparency has no problem with sub-bones transparency #4068 #1704
• Fix DragonBones The original animation monitor failed after the skinning operation
• Fix Spine, DragonBones When pre-multiplication is enabled, modify the transparency of the node and the problem of exposure #4068#1704
• Fixed an issue where manually created Assets would report an error when remotely loading DragonBones or Spine resources#4020#122
• Fix Spine, DragonBones Cache update issue in SHARED_CACHE mode #4457
• Fix Spine In Cached mode, there is no default value for the delay parameter of addAnimation
• Fix Spine In Cached mode, setting skeletonData will warn you
• Fix Spine In Cached mode, the animation may be abnormal when changing. #4488
• Fixed an issue where Spine's json file would report an error without a skeleton field #4029
• Fix Spine Problems with multiple skins that are not displayed in speed mode #4091
• Fixed AudioSource The problem of getting the state state error during the second play #3974
• Fixed texture not dynamically set mipmap problem #4201
• Fix Label Problem with text positioning may be garbled when CHAR mode is enabled #4007
• Fix Label Problem with dynamic mapping does not work after BITMAP mode is enabled #4392
• Fix Label When the text rendered too much is off the screen Canvas size may be too large #4047
• Fixed an issue where the opacity setting of the node where the Label is located exceeds 255. #4161
• Fix Label Problems with BMFont may not be rendered when using shrink mode #4099
• Fix LabelOutline A memory leak may be caused when a component is destroyed #4220
• Fixed LabelOutline Exceptional transparency when cascading components #4495
• Fixed ScrollView or Mask where node Scale is 0, flat nodes may not be able to respond to clicks #4456
• Fixed an issue where the scrolling position was incorrect when the page of PageView was dynamically updated #4050
• Fixed a memory leak issue that could be caused by too many particles in the particle system #4256 #4262
• Fix Particle System After playing, hide and display the problem of residual particles #4243
• Fixed a problem where the Scale 0 node Instantiate three times in Prefab would cause the Scale value to become 1#4454
• Fix native platform resources Download, XMLHttpRequest, WebSocket, SocketIO Possible crash after request #1721 #1716
• Fix native platform GC may cause crash problem #1744
• Avoid native platform initialization process if evalString is called in native code to crash
• Fix Native platform Label shows possible black border issues #130
• Fix Native platform Spine A problem that can cause a crash when resource acquisition or parsing fails #1745
• Fix Native platform Spine Destroy possible crashes when not fully loaded #1711
• Fix Native platform DragonBones Set the displayIndex attribute of the slot to have no effect #4339
• Fix iOS 12 Unable to load the correct ttf file issue #1700
• Fix iOS Problems that may crash when AudioClip is released #1714
• Fix Android The problem that the native platform can't load the sub-package correctly #1701
• Fix Android EditBox The problem of inputting decimal points and other symbols is not supported under number inputType#1695
• Fix Android Instant platform loading Spine Resource error reporting #3999
• Fix Windows may report an error when switching between the front and back of the platform
• Fix Web platform VideoPlayer Set currentTime invalid question #4049
• Fix Web platform VideoPlayer Listening for problems with invalid ready-to-play events #4049
• Fix WeChat mini game On Android platform Audio Unable to start over again when replaying #92
• Fix Baidu game saveFile causes tempFilePath to expire #14

Since the release of Cocos Creator 2.1.0, we have received a lot of valuable suggestions from users. Based on previously announced plans, we will continue to speed up the iteration of the v2.1 series to implement user suggestions as quickly as possible. At the same time, in order to prevent these changes from affecting the stability of old projects, we only recommend upgrading projects with 3D requirements to v2.1. Other projects can continue to use v2.0, and wait until v2.2 is released before upgrading. This v2.1.1 upgrade mainly supports 3D scene editing, camera preview, lighting system, and also incorporates the latest 2.0.x changes.

Support 3D scene editing

The Scene Editor allows you to switch to 3D editing mode with one click, making it easy to edit 3D objects, cameras, and lights. See the 3D Scenes document 1 for details.

Add game preview panel

A separate preview panel has been added to visually preview the images seen by the camera during scene editing. Panel Open: Main Menu → Panel → Game Preview, the preview panel can be placed in a separate window or dragged into the main editor window.

Add 3D lighting and shadows

A Light component has been added to lay out lights in the scene, and a shadow effect can be set in conjunction with MeshRenderer. See the Light Source Component Reference documentation.

Upgraded EditBox component

Now, developers can set the Text Label, Placeholder Label and Background nodes separately, making them more flexible, simple, and more in line with the component development. See the EditBox Component Reference documentation.

Add text shadow rendering component

A new LabelShadow component has been added to add a shadow effect to the Label component, similar to the LabelOutline usage. See the Label Component Reference documentation.

Support for dynamically creating 3D Primitive models

Added cc.primitive module to dynamically create 3D models at runtime, including: box, cone, cylinder, plane, etc. See the Basic 3D Objects documentation.

Integrated Material System (Beta)

Added support for material systems, allowing users to create Material and Effect (Shader) resource types. It should be noted that the current material system is mainly provided to the internal use of the engine and is only for developer preview. We plan to upgrade the material system in v2.1.2, however it will not be back-ported to this version.

Editor Fixes

• Added shortcut Ctrl/Cmd + Shift + F to align the currently selected node to the perspective of the scene editor.
• When you click in the scene editor, you can hold down Ctrl/Cmd for multiple selections at the same time.
• Improve fault tolerance processing for custom engines to avoid editor startup failure
• Improve the search performance of the resource manager under very large projects
• Add menu File -> Open project in new window to support simultaneous opening of multiple projects on Mac
• Hide the component’s enabled checkbox when the component does not define the enabledassociated lifecycle function
• Upgrade the TypeScript version to 3.3.3333

Engine Fixes

• Make cc.Vec3 compatible with related APIs of cc.Vec2
• Improved Label positioning accuracy in the editor and on different browsers (thanks to “Dacheng Xiaopeng” for advice)
• Optimization 3D skeletal animation performance and volume
• The cc.macro.CLEANUP_IMAGE_CACHE flag is enabled by default on the native platform to reduce texture memory usage
• Native platform automatically verifies the maximum supported texture size of the current device
• Add WeChat Mini game XMLHttpRequest support for timeout event [#87]
• Added cc.sys.HUAWEI_GAME enumeration to determine if it is currently Huawei’s fast game platform
• Optimized Android 5 system’s WebView compatibility
• Allow iOS browser to play automatically when VideoPlayer is muted

Bug Fixes

Editor

• Fixed an issue where BuildResults.getNativeAssetPath might not get the texture path
• Fixed removal animation editor error message caused by the animation frame being edited
• Fixed an object already destroyed warning that appears when you repeatedly enter Prefab edit mode

Engine

• Fixed an issue where enabledInHierarchy is always false when the component does not define onEnable
• Fixed an issue where ToggleGroup is not fully disabled when the active node is false
• Fix Label’s opacity is not working
• Fix Slider’s anchor settings will affect clicks [#4163]
• Fix Particle System after playing, hide the node and display the problem of residual particles [#4243]
• Fixed a memory leak issue that could be caused by too many particles in the particle system[#4256]
• Fix native platform resources Download, XMLHttpRequest, WebSocket, SocketIO possible crash after request [#1721] [#1716]
• Fix native platform XMLHttpRequest may crash due to timeout [#1724]
• Fix native platform loading via IPV6 under the telecom network (WeChat avatar) file may fail [[#1713]] (https://github.com/cocos-creator/cocos2d-x-lite/pull/1715)
• Fix native platform OpenGL draw error #4017
• Fix native platform Label there may be black border issues when rendering system text [#130]
• Fixed an issue where the audio file on the Android platform could not be loaded when it was not in OBB[#1611]
• Fixed an issue where the Android platform received a touch event before the engine initialization was completed could cause a crash [#1715]
• Fix Windows platform window may report an error when minimizing restore [#129]
• Fixed Windows platform error when opening window [#1732]
• Fixed an issue where the volume setting to 0 is invalid on Browser
• Fix 3D Project incompatibleWeChat game Open Data Domain issue
• Fix 3D model bone penetration problem [#4188]

Removed

• Removed the creation entry for the CoffeeScript script. CoffeeScript scripts can still be created manually, and we plan to remove full support for CoffeeScript in v3.0.

Follow-up version plan

(The version plan is for reference only, the final version content and release order are subject to actual conditions)

• 2.0.x
  • Continuously optimize performance and improve stability
  • Support for more small game platforms
• 2.2.0
  • Optimized Auto Atlas
  • Enhanced compression texture support
  • Further optimize the platform compatibility of the EditBox
  • Support skeletal animation resource lazy loading
  • Optimize the small game platform build process
• 2.3.0
  • Greatly optimize native platform base rendering performance
  • Greatly optimized TiledMap support
• 2.3.x
  • Support for 3D physical systems and collision detection
  • Upgrade the material system added in 2.1.1 from the experimental version to the official version

Cocos Creator v2.0.9 support for greatly optimizes the performance of DragonBones/Spine on small games and web platforms. WeChat mini games also brings improved resource loading performance and dynamic text refresh efficiency. At the same time, we have further improved the compatibility and stability of the engine and editor, so that everyone can get a better development experience. Good quality is inseparable from careful polishing. Thanks to the feedback from developers on the community, GitHub, Cocos corporate services and other channels.

Improving the performance of DragonBones and Spine on non-native platforms

Cocos Creator v2.0.7 greatly optimized the performance of DragonBones and Spine on native platforms, with performance optimized to more than twice as fast as 1.9 and 1.10. This release, v2.0.9, for Web platforms and non-native platforms. SHARED_CACHE and PRIVATE_CACHE acceleration modes, have improved DragonBones performance by 15 times, and Spine’sperformance has improved by 3 - 6 times.

Performance test results after acceleration mode is enabled:

• The score of the test is converted from the frame rate and the number of animations. The higher the value, the better the performance.

When playing more than three animations on the same screen, SHARED_CACHE acceleration mode can also greatly reduce memory overhead. The following is a memory comparison of one hundred animations on the same screen:

• The lower the score of the test, the less memory is occupied. The more animations SHARED_CACHE saves more memory.

To enable Extreme Mode, simply set the Animation Cache Mode to SHARED_CACHE or PRIVATE_CACHE on the DragonBones or Spine components. For more detailed information on speed modes, refer to the Dragonbones reference documentation and Spine reference documentation.

Support for publishing as Android App Bundle

In Build panel, publishing to Android App bundles has been added. When checked, Android native games can be published as App Bundles. After submitting the App Bundle to Google Play, Google Play will dynamically download different versions of the APK based on the differences in the player’s phone parameters to reduce the game’s package size.

Editor Fixes

• Disable setting the node width to negative in the Property inspector
• Add a sort mode toggle button in the Explorer to choose to sort by name or type
• Add the search empty button of the level manager, which will jump to the previously selected node
• Add the function of finding the referenced resource by UUID in the drop-down search box of the hierarchy manager
• Node selection status in the synchronization level manager and animation editor
• Move the service panel that is docked next to the Property inspector to the build release window
• Remove Blend Factor properties on render components other than Sprite and Particle
• Improved support for particle system import and export plist
• Display a progress bar in the system tray when building a project
• When you import CCB and Cocos Studio projects repeatedly, the original folder will be overwritten and no more copies will be retained.
• When building a WeChat game, the code obfuscation function of the WeChat Developer tool is turned off by default, using the confusing function that Creator comes with.

Engine Fixes

• Improve the rendering of Label dynamic fonts, avoiding the problem of black edges on the edges of the text
• Upgrade Spine runtime to 3.6
• Introduced a new easing API: cc.tween, which provides a more concise syntax and greater flexibility, as described in API - tween
• Add the Awake On Load property on the RigidBody component to set whether the rigid body wakes by default
• Native platform adds jsb.copyTextToClipboard API for copying text to clipboard
• Module clipping for native platforms no longer culls XMLHttpRequest module
• Upgrade Android build tool configuration Gradle to 4.10.3, plugin to 3.2
• Upgrade Android’s lowest Target/Compile SDK Version from 16 to 23, and the Min SDK Version is still 16
• The http protocol is supported by default in Android 8 #1664
• Improved VideoPlayer component support on X5 browser
• Cancel the blocking of Dynamic Atlas in Chrome 69+ (there will be white afterimages so the dynamic gallery is blocked)

Bug Fixes

Editor

• Fixed an issue where the animation editor could not be used on user scripts
• Fixed an issue where auto atlas could not be packaged into sub-packages
• Fix Command line When building a project, the project will generate problems directly into the build directory
• Fix Command line Do not load custom plugin when building project
• Fix Command line The issue where the excludeScenes parameter does not take effect when building the project
• Fixed a problem where the mesh background in the scene editor would penetrate above some translucent images, causing some differences in color and runtime
• Fixed automatic syncing of Prefab when saving scenes, in some cases, you will be prompted to save the reference.
• Fixed a problem where the nativePath of the resource is incorrect when the custom build plugin gets the subpackage resource in BuiltResults during the “build-finished” phase
• Fixed an issue where the Physics Collider’s gizmo showed an exception after changing the node hierarchy
• Invalid error in project build may occur when fixing custom engine
• Adjust code auto-compilation strategy to prevent plugins from failing to import when modifying project scripts

Engine

• Fixed a problem with rendering errors when there were a lot of scene display objects
• Fixed an issue where the color of the node is not valid after the Button component is set to COLOR mode
• Fixed an issue where setting Button' s  interactable to false would cause node scale to become 0 before onload
• Fix Report when the Label component is destroyed when it is not activated #3769 
• Fix Label issues that may flash when used with faceIn action
• Fixed an issue where applying Particle action would cause particles to be offset
• Fix Particle component will repeatedly parse the textureData embedded in plist
• Fixed a loss of parts in the scene when loading 1.x old projects Particle Problems with custom data
• Fixed ScrollView parent node scale 0 ScrollView layout exception problem
• Fix DragonBones If you include a sound file, the animation will report an error.
• Fixed DragonBones problems that may not be rendered when the bone contains multiple textures
• Fixed DragonBones cache cap not taking effect, causing the cache not to be automatically emptied
• Fixed an issue where Spine’s premultipliedAlpha settings were lost when loading 1.x old projects
• Fix Mask component does not update the hit test after enabling inverted
• Fixed an issue where the adjustment of the node zIndex and the hit test area may not be refreshed #3895
• Fixed an issue where different shaders use the same uniform name, but the data is incorrect when the types are different
• Fixed an issue where fields in some scenes in the WeChat game subdomain were subject to MD5 interference
• Fixed a potential crash on WebSocket GC on native platforms #1681
• Fix native platform Spine Problems with flashback and rendering exceptions after switching parent nodes #1659
• Fixed an issue that could crash during iOS** native platform cc.log #1687
• Fixed Android platform XMLHTTPRequest Crash problem caused when statusText is not obtained #1629
• Fix Android Unable to play remote video #1661
• Fixed an issue where native and web platforms could not load resources in a subcontract
• Fixed an issue where Vec3 and Rect deserialization might not be correct
• Fixed an issue where different shaders use the same uniform name, but the data is incorrect when the types are different

Known Issues

• If this version frequently modifies the node’s zIndex in the code, the performance overhead may be large and we will optimize it in the next version.
• On the Baidu small game platform, there are still some problems for the time being, we are working with Baidu engineers to fix it.
• There is an audio compatibility issue on Android
• Does not support gravity sensing
• XMLHttpRequest does not support timeout callbacks
• Remote loading of resources on Android will report an error

Documentation

Cocos Creator 2.0.x Documentation

Change List

• A reset method has been added to the cc.WXSubContextView component to allow the user to properly reset the view size by calling this API when switching between subdomain views. PR 
• Fixed that on some Android WeChat 7.0.3 models, Retina will still be blurred.
• Fixed frame rate instability caused by listening to Device Motion on Android WeChat 7.0.3
• Fix the problem that the WeChat game sub-package will load when it does not contain any resources.
• Fix an issue where BMFont is not available in WeChat open data domain
• Fix RichText’s use of the font tag is invalid
• Fix an issue where RichText can’t pass arguments when using the on tag
• Fix the problem that the editor can’t build a project from the command line
• Adapting scene scaling issues after downgrading from Creator 2.1 to 2.0

Description of changes in this version

• Improve the font loading method on the web platform and fix the problem that individual TTF fonts must be loaded for a long time #3708
• Fixed an issue where audio might not play after multiple reloads #3702
• Fixed an issue where calling cc.view.setFrameSize does not take effect on the web platform  

Also fixed the following new issues in 2.0.7

• Fix native platform WebView, VideoPlayer related issues
• The rpk path of the debug platform window popped up after the Huawei small game platform clicks is inconsistent with the actual
• If the fast game tool is not closed, the project will be opened after the project is switched.
• Fixed an error caused by the failure of loading ttf in WeChat open data domain
• Fixed a problem of not generating a web-mobile folder when building a web-mobile platform
• Fix ios platform empty packet compilation error (ios)

Documentation

Cocos Creator 2.0.x Documentation 

Cocos Creator v2.0.6 is based on the v2.0.5 upgrade, providing fast access to Facebook Audience Network and Facebook Live Video on Android and iOS, while maintaining v2.0.5 stability. Facebook Audience Network is an advertising platform launched by Facebook that provides powerful advertising monetization capabilities. Facebook Live Video is an SDK from Facebook that allows players to play live games directly and share them on Facebook’s social network, effectively improving the game’s ability to spread. For specific access procedures for these two SDKs, please refer to the document Facebook Live and Advertising. In addition, this version also optimizes the build process of for Vivo and OPPO Mini Games. It is recommended to upgrade to this release if you are releasing Vivo and OPPO Mini Games.

Change List

• Added Facebook Audience Network and Facebook Live Video integration options to the service panel
• Fixed an issue that Facebook Instant Games could not upload
• Fixed a problem with zip compression for zip packages from Facebook Instant Games
• Optimized the build panel for the vivo game:
• Removed npm path input box
• The app icon is modified to any path, no longer limited to the path of the game project, and a button for selecting the image path function is added to the right of the app icon input box.
• Removed the use of certificate.pem, private.pem certificates fixed in [game project]／build-templates/jsb-link, and modified them to choose their own path. At the same time, the certificate is added to the rightmost button of certificate.pem. (Note that using Windows systems requires installing the openssl software and configuring its environment variables beforehand)
• Optimized OPPO mini-game build panel:
  • Removed the npm path input box and the quickgame input box, and Cocos Creator has a built-in quickgame.
  • The app icon is modified to any path, no longer limited to the path of the game project, and a button for selecting the image path function is added to the right of the app icon input box.
• Removed the use of certificate.pem, private.pem certificates fixed in [game project]／build-templates/jsb-link, and modified them to choose their own path. At the same time, the certificate is added to the rightmost button of certificate.pem. (Note that using Windows systems requires installing the openssl software and configuring its environment variables beforehand)
• The output path of the packaged rpk is adjusted to be the same as the path when the packet rpk is not set, in the [game project]／build/quickgame/build/ directory. And when you package the packet rpk, only one rpk file will be generated, and no other sub-package directories will be generated.
• WeChat mini game is not enabled by default after ES6 to ES5
• Limit the maximum number of concurrent downloads (cc.macro.DOWNLOAD_MAX_CONCURRENT) to less than 10 by default on WeChat games.
• Fixed an error when WeChat game called cc.game.end( )
• QQ light game build allows direct packaging of zip files for easy uploading of the server
• Fixed a problem with Mask rendering on QQ Light Games
• Fixed an issue where Android Instant platform crashed after compiling Android + AnySDK

Follow-up version notice

v2.0.7 will be released soon, focusing on optimizing native platform performance

We will soon be beta testing v2.0.7. In this version we optimized the rendering performance of the engine, especially the Spine and DragonBones of the native platform, and the performance has been greatly improved.

v2.1 iterations will be more aggressive

Compared with v2.0, the upgrade of v2.1 will mainly focus on the 3D field. We recommend upgrading new projects with 3D requirements to this version, and establishing contact with us in forums and other channels. Our responsible 3D partners will provide relevant support. . Since v2.1 is a very new version, we will speed up the iteration and try to meet the needs of developers. We will be releasing v2.1.1 in the near future to support 3D scene editing, camera preview and material systems, and to optimize the 3D development process.

Cocos Creator v2.1, adds support for 3D features such as: 3D model rendering, 3D Camera, 3D skeletal animation, and 3D point selection. The Cocos Creator editor now natively supports parsing 3D model files in FBX format. It’s that simple, no additional workflow is required!

In the previous version, v2.0, Cocos Creator had used a Cocos3D based 3D renderer to officially introduce 3D support. The addition of 3D features can greatly enrich the expressiveness of 2D games, reduce the resource overhead of 2D games, and bring more imagination and ideas to expand games.

However, it should be emphasized that the target users of Cocos Creator is still 2D game development, and the 2D game is still the core service of Cocos Creator 2.x. We will continue to optimize the development experience and basic performance of 2D games, and gradually increase the 3D functions suitable for integration into 2D games. Therefore, Cocos Creator does not allow a pure 3D game, which is the goal of Cocos3D. Cocos Creator’s development path is closer to 2.5D.

This is not the first time Cocos has upgraded the engine from 2D to 3D. A few years ago, Cocos2d-xexpanded to the 3D space and accumulated a lot of experience. It also produced a very good game concept like Sword and Home. However, at that time, 3D functions were piled up on a very heavy 2D renderer, and there was no editor support. It was not widely recognized by the market. This time, Cocos Creator is based on Cocos3D’s 3D renderer, which has a lot of 3D stability and guarantees a seamless editor experience.

Follow-up Version Notice

v2.0 will continue to be maintained, native platform performance will be optimized as soon as possible

v2.0 and v2.1 will grow together over a period of time.v2.0 will continue to be maintained, adding more performance optimizations and bug fixes. We will soon be beta testing v2.0.7. In v2.0.7 the rendering performance of the engine has been optimized, especially Spine and DragonBones. Also, the performance has been greatly improved.

v2.1 iterations will be more aggressive

Compared with v2.0, the upgrade cycle of v2.1 will mainly focus on 3D features. We recommend upgrading new projects with 3D requirements to this version, and establishing contact with us on our forums. This allows us and our 3D partners to provide support.Since v2.1 is a very new version, we will speed up the iteration and try to meet the needs of developers. In particular, currently v2.1.0 version still does not support 3D scene editing, only the 3D parameters can be set in the property inspector. We will be releasing v2.1.1 in the near future to support 3D scene editing, material systems and optimizing the 3D development process.

Complete list of changes (compared to v2.0.5)

3D Node

In v2.1, newly created Node objects are still 2D by default. When needed, you only need to click the 2.5D button at the top right of the Node to switch to 3D mode. After switching, you can edit the z axis. See 3D Node .

3D Camera

Like Node, Camera is also divided into two modes. When you add a Camera component to a normal 2D node, it becomes a 2D Camera. When you switch Node to 3D mode, Camera will also enter 3D mode, and then you can edit Camera's FOV and other parameters in 3D mode.

3D model import

Currently, Cocos Creator supports importing 3D model formats for a very wide range of .fbx files. .fbxis the de-facto standard in 3D modeling software. The process of importing is very simple, just drag the .fbx model into the Explorer and wait a few moments for the import to complete. After the import is completed, you can see that the imported model is a folder that can be expanded in Explorer. When importing the model, the editor will automatically parse the content of the model and generate a Prefab, a Grid, a Bone Animation and other resources. See Import Models

Mesh Renderer Component

Mesh Renderer is used to draw grid resources. See Mesh Renderer .

Bone Animation Component

The Skeletal Animation component inherits from the Animation component. The Skeletal Animationcomponent is not much different from the Animation component. The exception is the Skeletal Animation component uses a clip that can only be a Skeletal Animation clip. The Skeletal Animationcomponent is automatically added to the model’s Prefab when it is imported. See Bone Animation Component  for details.

For more 3D instructions, please consult the documentation 3D System .

Optimize automatic gallery build speed

v2.1 greatly optimizes the speed of auto-atlas construction. If the atlas has not changed, the results of the last build are used.

Further improve rendering performance

Between v2.0 compared to v1.x, there are some cases where the engine does not render batches, resulting in an increase in draw calls. v2.1 re-optimized these conditions. If the previous color or opacity cannot be batch processed, sliced and non-sliced share the same texture and cannot be batched. The problem that the opacity 0 node still occupies the draw call is solved.

Add simulator debugging function

In the Project Settings -> Preview Run Panel, the Open simulator debugger panel option and the Wait for debugger connect option have been added. The purpose of the Open simulator debugger panel option is to automatically open the debug window when the simulator previews the project. The Wait for debugger connect option is used to suspend the boot process until the debugger connection is complete for debugging the load process.

Texture Auto Compression

The compression required by the texture can be set directly in the editor, and Cocos Creator will automatically compress the texture when the project is published. Exporting multiple image formats simultaneously on the web is supported. The engine will automatically download the appropriate format according to the different browsers. See Compressed Textures  for details.

Enhancements

Editor

• Dashboard is closed when the project is opened, and automatically opened when the project is closed.
• Dashboard will automatically record the last created project path.
• Optimize the preview of the Button under the editor.
• Optimize the way Button Click Event indexes components, avoiding the loss of indexes after scripts are renamed.
• QQ light game construction allows direct packaging of zip files for uploading servers.
• The new plug-in mall automatically prompts the user to install after the plug-in download is completed.
• When building a WeChat mini-game main domain project, the subdomain will not be emptied again.
• Modify the API Level selected by default when building the Android platform to the current highest level (Target API Level).
• The node path bar in the scene editor is removed, and the node path can be obtained through the node right-click menu of the hierarchy manager.
• The animation editor defaults to Constant curves for values ​​of type cc.Enum and cc.Integer, without interpolation.
• Animation editor key frame addition and deletion experience optimization.
• The optimization engine automatically compiles the experience.
• Added a series of other experience optimizations.

Engine

• [UI] Added the affectedByScale property to the Layout component. If the developer wants the scaling of the Layout subnode to affect the layout, you can turn it on manually.
• [UI] supports fnt files in XML format.
• [UI] The Content Size of the node will be refreshed immediately when the Label node is onEnable.
• [UI] When the target of Button is not defined, the current node will be used by default.
• [UI] ToggleContainer adds a checkEvents event property similar to Toggle, which fires only when Toggle’s isChecked state becomes true.
• [Action] Added support for four actions of cc.Rotate3DTo, cc.rotate3DTo, cc.Rotate3DBy, cc.rotate3DBy.
• [Native] Rejoined WebView and VideoPlayer support removed in v2.0.0 on iOS and Android platforms.
• [Native] The Mac native platform switches to the V8 engine. If you need to use JSC, you need to manually modify the macro. For details, see #1515 .
• [Native] Add the missing key and length properties of the native platform LocalStorage, see #1371.
• [Native] Adopts Pinyin input behavior unified with Android on iOS native platform, does not retain input of unfinished pinyin.
• [Android] Upgrade Android compilation to NDK r16+ Clang, and compile Android pre-compiled library with Clang.
• [Android] Upgrade the Android build tool to configure Gradle to 4.4, plugin to 3.1.4. (Gradle 4.6 has a known issue that will cause resource packaging to fail).
• [Android] Optimize Android input box experience.
• [Android] Squeeze Android empty package body, the minimum package body is reduced from 7.0MB to 6.3MB.
• [Web] Increase transparency support for WebView on the web platform.
• [Web] Optimized display position of WebView components.
• [Web] Optimizing the performance of VideoPlayer on the X5 browser.
• [Wechat] Supports getting the res and referrerInfo parameters passed to the platform when responding to the cc.game.EVENT_SHOW event on WeChat games.
• [VideoPlayer] Optimized the performance of VideoPlayer full-screen playback.

Bug Fixes

Editor

• Fix an issue where the animation editor node list may not be updated.
• Fix the problem of selecting the RichText subnode in the scene editor.
• Fixed an issue where the error code always returned 0 when building a project using the command line, whether or not an error occurred.
• Fixing the background of the mesh in the scene editor will penetrate above some translucent images, causing some differences in color and runtime.
• The editor will report an error when repairing an external drag resource to an invalid location in the resource manager.
• Fixed remote server ip getting error when publishing Android Instant platform.

Engine

• [Core] Problem with activeInHierarchy being true after fixing node destroy.
• [Core] Fix filter in RenderTexture, premultiply alpha setting is invalid.
• [Core] Fixed an issue where the scene introduced by the plugin could not be loaded.
• [Web] Fixed a problem with white afterimages on Chrome 69, 70. (Since 2.0)#3357.
• [UI] Fix Button may have some state invalidation when multiple states are superimposed on each other.
• [UI] Fix LabelOutline setting invalid color problem.
• [UI] Fixed an issue where setting Toggle.isChecked to be invalid in the start method.
• [UI] Fix the problem that the LabelOutline component is not synchronized when the state is modified.
• [Animation] Fixed an issue where the parameters of AnimationState might be parsed as a string type.
• [QQPlay] Fix the problem that QQ light game does not respond to the background background switching event.
• [QQPlay] Fix the problem that the font will become very small if you use italics on QQ light games.
• [QQPlay] Fix the problem that the QQ light game can’t replay when the lock screen re-enters or the front and back switches.
• [QQPlay] Fixes the problem of the ended event after the audio setCurrentTime is fixed #3373.
• [Native] Fix native platform connection socket.io  server may report Bad Request error.
• [Native] Fix iOS and Android can’t detect gravity sensor.
• [Native] Fix iOS call cc.game.restart Restart the game and then enter text will crash.
• [Native] Fixing the problem that the opacity attribute of Label on Windows native platform does not work.
• [Native] Fixed an issue where Android could not listen to onKeyUp.
• [Native] Fix the problem that the Android phone will fail to load if the built-in SSL certificate expires.
• [Native] Fixed an issue where server redirection was not supported when downloading images from Android native platform #PR.
• [Physics] Fixed an issue where MouseJoint failed to respond to touch cancel.
• [Spine] Fixes the problem that textures may be lost when Spine is reloaded under Mask.

MIGRATION GUIDE

v2.1 upgrade considerations

• Node’s rotation related API has been marked as deprecated, and the runtime will prompt to upgrade to angle. See 3D Node - Node API Upgrade .
• The NDK version of Android needs to be upgraded to r16 or the compilation will fail.

WeChat game open data domain

Starting with v2.0.1, Cocos Creator upgraded the open data domain solution, see Access Game Open Data Domain .

v2.0 Upgrade Guide

See the v2.0 Upgrade Guide .

Resource upgrade

Since v1.10, Cocos Creator has refactored the underlying resource types. Most projects are not affected, but some projects may receive some warnings. For details, please refer to v1.10 Resource Upgrade Guide .

3D Example

After downloading v2.10, create a new example project and open the case under assets/cases/3d to experience the 3D features.

Compared with v2.0.2 released recently, v2.0.5 provides support for publishing to OPPO Mini Gameand Vivo Mini Game platforms, as well as a bug fix release. It is strongly recommended that all 2.0 users updateto v2.0.5. Good quality is inseparable from careful polishing. Thank you for the feedback from developers through the community, GitHub, Cocos technical services and other channels.

Editor

• [Auto Atlas] Fix Auto Atlas default BestAreaFit algorithm can’t calculate correct atlas size problem
• [Auto Atlas] Fixing the auto-atlas catalogue when nesting, the album in the parent directory will repeatedly pack the images in the sub-directory into the problem
• [Auto Atlas] fixes black border problems after auto-satellite packaging (old auto-atlas needs to be deleted and re-created to take effect)
• [Auto Atlas] Fixes the problem that the Auto Atlas Force Squared option does not work
• [Wechat] Fixed an issue where subdomain directory names could not be modified when building WeChat games
• [QQPlay] Fix v2.0.2 Unable to export plugin script on QQ light game
• [Google Play Instant] Allows Default URL to be empty when building Android Instant

Engine

• [Core] The second argument to cc.loader.loadResArray supports passing in a type array (thanks @caochao) #3312
• [Native] Add cc.sys.getSafeAreaRect( ) API to get the screen security area of ​​the phone (in design resolution)
• [Core] Fix v2.0 screen rendering effect is slightly blurred
• [Core] Fixed an issue where the component might still be activated if the node was not added to the scene when it was destroy( )
• [Core] Fixed an issue where SpriteFrame didn’t work correctly after calling setRect( )
• [Core] Fix an error when calling cc.Texture2D initWithData() in v2.0
• [Core] Fix issues that render components in v2.0 may still render when the node is not activated
• [UI] Fixed an issue where the state was not updated when the Toggle component set the isChecked property
• [UI] Fix an error when the ScrollView.content object is modified
• [UI] Fix some problems in RichText in v2.0 may not be displayed
• [UI] Fixed issue where the start event of PageView did not fire
• [UI] Fixing invalid segments in Mask
• [UI] Fixed an issue where the Stencil state was incorrect when Mask was nested
• [UI] Fixed an issue where WebView did not trigger the load event when reading the default page
• [UI] Fixed an issue where EditBox may report an error when switching between horizontal and vertical screens frequently
• [UI] Fix the problem that the click event registered by once will still penetrate to other nodes in the level after the response
• [Audio] Fix Audio’s operation on effect may affect music issues
• [Spine] Fix Spine transparency and pre-multiplication in ScrollView in v2.0
• [Animation] Fix an issue with animation quickFindIndex
• [Animation] Fixes invalid issue with animation registration lastframe event
• [Particle] fixes particle system call resetSystem( ) will fail
• [Wechat] Fixed an issue where resources could not be loaded when the WeChat game cache was full.
• [Wechat] Fix WeChat game to switch the foreground from the background, it will play the problem of unreleased audio
• [Facebook Instant Games] Fix an issue where Retina is not enabled on Facebook Instant Games
• [iOS] Fix v2.0 error on iOS 9 due to lack of support for ES6
• [QQPlay] Fix the problem that the font display is too small when the font size is float type on QQ light game
• [Google Play Instant] fixes a black screen issue caused by probabilistic jsb-adapter reloading when editing the split first package interface

Resources

• Creator v2.0 API docs
• v1.10 Resource Upgrade Guide 

The Playtime Conference hosted by Google Play was held in Germany on October 18th, 2018. The BIG NEWS: In partnership with Google, Cocos Creator v2.0.4 was released, supporting Google Play Instant games.

Google Play Instant and Cocos

In March of this year, Google showed Google Play Instant, a game store-based distribution solution called Search Instant. For the player, they are allowed to try the game before deciding to download the full version of the game, which greatly saves their device storage space. For developers, it means they can offer a demo experience to players who wouldn’t have installed these games, which in turn will increase the game download conversion rate.

Google Play Instant offers a higher APK size limit (10MB), support for progressive downloads for both executable code and game assets, allowing developers to use the NDK and game engine with existing toolchains. In order to make instant apps and games easier to build, as a Google Play Instanttechnology access partner, in May of this year, the Cocos engine began to do integration testing with Google and beta users of the Cocos community.

Developers only need to select Google Play Instant as the publishing platform to automate all technical docking of the Google Play Instant platform. The output is compatible with Google Play Instant. Technically-standard games, quickly launched on Google Play Instant for testing, greatly reducing development costs.

Release Notes

v2.0.4 only adds Google Play Instant Support, no other changes from v2.0.2.

Documentation is here.

Compared to v1.9, the v1.10 version adds a lot of features, refactoring the resources of the engine, and greatly optimizing the size of the settings.js file. In addition, v1.10 also supports game code subcontracting on WeChat games, web and native platforms. This will break through the 4MB limit of WeChat’s first package and increase the game loading speed. See Code Subcontract Loading . At the same time, v1.10 has rewritten a lot of editor code, improving the editor’s experience and performance. If your project is planned to be upgraded to v2.0 later, please upgrade to v1.10 in advance to ensure that the entire upgrade process is as smooth as possible.

Resource upgrade

Since v1.10, Cocos Creator has refactored the underlying resource types. Most projects are not affected, but some projects may receive some warnings. For details, please refer to v1.10 Resource Upgrade Guide.

Editor

• Greatly optimize the size of the settings.js file after the release
• Added script subcontracting settings in the property inspector for the folder
• Allow each project to set a custom engine separately
• Add a node lock function in the hierarchy manager. When the mouse is moved to the node, there will be a lock button on the left side. After the node is locked, the node cannot be selected in the scene editor.
• Added an “Optimization Policy” option in the Property inspector of the Prefab resource file to optimize Prefab creation time. See Prefabricated Resources: Setting Optimization Strategies
• Optimize the main menu under Windows
• Add auto-refresh to the list of scenes in the build panel
• When publishing to the native platform, it also supports adding MD5 to file naming for hot update
• Script compilation will automatically skip all .d.ts files to avoid TypeScript error reporting
• The Console panel adds a Clear on Play option to automatically clear the log before the game previews
• Adjust the text font and color of the Console panel
• Added search option button in the search bar of the hierarchy manager and explorer
• Added plugin management feature in the plugin store
• Allow changes to custom control icons in the control library
• Resource Manager adds recognition of aac and pcm extension audio files
• Supports direct search of compressed uuid format when Explorer searches for uuid
• Allow the right mouse button to drag and drop the timeline of the Timeline editor
• Added exit menu on Dashboard’s system tray icon

Engine

• Support game script subcontract loading, see Code Subcontract Loading
• The align mode attribute is added to the Widget component. When set to ON_WINDOWS_RESIZE, it will be automatically refreshed when the window size changes.
• Official support for text and JSONLoading of resource types
• The native platform adds cc.sys.getBatteryLevel interface for getting device power and network status
• When the native platform is hot updated, it will actively delete the old version of the resource file.
• VideoPlayer adds volume adjustment and mute function
• Added DragonBones native platform binding interface getSlots, replaceSlotDisplay and Slot.name (thanks @feijing566)
• TiledMap supports rendering and cropping of ortho maps in any direction on the web platform
• Layout component will only typeset active nodes
• Retina rendering enabled by default on Android UC browser
• Enable Webgl on UC browser version 11 or higher
• Increased recognition of UCBS browsers
• Gravity sensing is adjusted to only get when the developer has a registration event

Bug Fixes

• [Editor] Fixes the settings when setting SpriteFrame in the collection
• [Editor] Fix simulator configuration save related issues
• [Editor] Fixed an issue where the error message output from the emulator to the console was displayed in white.
• [Editor] Fix the error when the resource export tool encountered the same parent folder name
• [Editor] Fixed an issue where copying the automatically synchronized Prefab subnode under the editor may be wrong
• [Editor] fixes the problem that the fragment texture in the automatic map set will be reported incorrectly if it is directly referenced by other resources.
• [Editor] Fixed plugin script not correctly parsing CC_WECHATGAME and CC_QQPLAY keywords
• [Engine] Fixed an issue where the animation may not stop playing when the scene is switched or the node is destroyed.
• [Engine] [Wechat] Fix some versions of WeChat games to get the problem of each frame interval
• [Engine] [Wechat] Fix RenderTexture related issues on Android WeChat games
• [Engine] [QQPlay] Fix QQ Play and play resources will be downloaded repeatedly
• [Engine] Fixed an issue where the slider of the Slider component might not be right when dragged
• [Engine] Fixed an issue where the audio load event could be triggered repeatedly
• [Engine] Fixed a problem where the user changed the level while dectivating the node without any error.
• [Engine] Fix issues that WebView can’t hide in Safari browser on some platforms (iOS 9/10 or Mac)
• [Engine] Fixed native platform BMFont rendering pitch problem
• [Engine] Fixed an issue where the button’s touch area would be offset when Canvas was unchecked Fit Width and Fit Height

Upgrade Android SDK

Starting with v1.10, the API Level in the Android build panel specifies the minimum Android version supported by the compiled apk. targetSdkVersion, compileSdkVersion, buildToolsVersion have all been upgraded to 26. If the developer has other needs, you can manually modify proj.android-studio/app/build.grade and proj.android-studio/gradle.properties.

REMOVED

• Removed support for Eclipse and Ant build Android platform
• Removed support from Chipmunk
• Removed cc.loader.loadRes to directly load the support of the child SpriteFrame in the collection. Please load the atlas first and then call atlas.getSpriteFrame(name)

DEPRECATION

• Since v1.10.0, Texture2D.releaseTexture is no longer recommended, please use Texture2D.destroy instead.
• As of v1.8.2, cc.eventManager is no longer recommended. Use cc.EventTarget or cc.systemEvent instead. The original API will be removed in 2.0.
• As of v1.8.2, cc.inputManager is no longer recommended. Replace it with the same interface of cc.systemEvent. The original API will be removed in 2.0.
• Since v1.8.2, dragonBones.CCFactory.getFactory is no longer recommended. Use dragonBones.CCFactory.getInstance instead. The original API will be removed in 2.0.

KNOWN ISSUES

• When copying and pasting a resource in Explorer, the resource property will not be copied. (Since 1.9.0)
• Android native platform does not support playing remote video.

Cocos Creator v2.0.0 is a brand new version that has undergone a lot of low-level refactoring. Some developers have encountered some annoying problems in the process of upgrading the project. We collect and do our best to solve these problems in v2.0.1. In addition to greatly improving the stability and the friendliness of project upgrades, this version also brings new open data domain solutions for WeChat games to developers, greatly improving the performance and flexibility of open data domains.

Main Features

• Update the best use of open data domain solutions in history
• Provides WeChat platform cleanup cache API
• Support WeChat games and play a platform to set the frame rate via cc.game.setFrameRate
• Add a View menu for the simulator to set the resolution
• Modular RenderTexture and DynamicAtlas

Editor Fixes

• Fixed issue with particle resource import in editor
• Fixed an issue where Label was not affected by node anchor changes in the editor
• Fix BMFont font error in the editor editor
• Fixed an issue where the color of some Particles could not be displayed and set in the inspector
• Fixed an issue where the simulator resizing interface would not fit
• Fixed curve editor state residual problem in animation editor
• Fixed an issue where the particle system’s svg flag was missing in the editor
• Fixed Editbox editing fontColor does not work
• Fixed an issue where the animation editor switched WrapMode while playing the animation, causing the node in the scene editor to not be dragged
• Fix the problem that the node _localZOrder keeps changing when the data is saved
• Fixed an issue where the keyboard direction key could not be fine-tuned after the editor selected the node
• Fixed an issue where the scene editor would not automatically locate in the hierarchy manager after selecting a node
• Fixed an issue where the node tree was automatically expanded after the node was deleted
• Fixed an issue where clicking the node level manager in the inspector panel does not automatically locate
• Optimize the Console automatic scrolling experience
• Fixed an issue where all child nodes were expanded when the parent node active state was switched
• Fixed flashing issues when clicking on Hierarchy nodes
• Fix Auto Atlas preview invalidation issue

Engine Fixes

• Fix rendering issues with Spine animations
• Fixed animation jitter caused by shader precision
• Fixed an issue where setting the property in the inactive state does not take effect on the Sprite
• Fixed rendering of Tiled type Sprite in the case of texture rotation
• Fixed an issue where the background in the open data domain could not be transparent
• Fixed rendering errors when Graphics has too many vertices
• Fixed an issue where Camera does not respond to events after zooming
• Fixed clipping of Tilemap after Camera zooming
• Fixed a status error caused by multiplexing of RichText child nodes
• Fix IE11 support
• Fixed qqplay does not support Particlemap issue in base64 format
• Fixed an issue where the Spine debug slot is not available in the Release version
• Fixed issues with background switching events in front of each platform
• Fixed rendering error caused by blend function when Label was switched to BMFont type
• Fixed a black screen on the qqplay platform under Android P
• Fixed an issue with the Windows platform XMLHttpRequest GET result of timeout
• Fixed an issue where AudioClip does not support lazy loading
• Supplement the missing deprecation API to fix missing API documentation issues
• Fixed an issue where Stencil would be overwritten by the last Mask when multiple Masks coexist
• Fixed black border issue with Mask component in open data domain
• Fixed Mask does not support lazy loading when using image stencil
• Fixed an issue where Spine could not display debug slots in non-debug mode
• Fixed an issue where the audio could not be played when the Native platform checked MD5
• Enhance fault tolerance of Particle resources and support resource formats exported by effecthub
• Fix resume can directly play unplayed audio
• Fixed a missing GUI issue caused by including the Mask module and culling the Graphics module
• Fixed Native platform button can still receive touch events when active is false
• Fixed web platform VideoPlayer has no hidden issues when switching visibility
• Fixed an issue where windows & mac emulator window size does not automatically adapt when changing
• Fixed parsing problem with Tilemap parser
• Fix Camera does not support mask when using RenderTexture screenshots
• Fixed an error caused by multiple Graphics switching between each other
• Fixed an issue where the final alpha was invalid when the particles in the particle system finally disappeared (opaque)
• Optimize the performance of small text rendering on the Native platform
• Fixed Android platform return key listener failure
• Fixed an issue where clicking the input box will disappear after the iOS platform pops up the input box
• Fixed garbled problem when inputting Chinese characters on iOS platform
• Optimized input box completion button design
• Fixed an issue where the input emoticon was abnormal in WeChat game
• Optimize the API design of TiledTile (do not allow layer to be set, get it automatically)
• Fixed hexagonal tileMap offset problem when using TiledTile
• Fixed a crash on the native platform FileUtils writeStringToFile call

Deprecation and Removals

• A large number of private and non-core APIs of v1.x have been removed or discarded. For details, please refer to the upgrade guide .

Related Resources

• Creator v2.0 API doc 
• WeChat game open data domain usage documentation 
• Material use case

2.0.0 is a brand new version that has undergone a lot of low-level refactoring. Some developers have encountered some annoying problems in the process of upgrading the project. We collect and do our best to solve these problems. Now we will bring you the 2.0.1 version. . In addition to greatly improving the stability and the friendliness of project upgrades, this version also brings developers a new Open Data Domain solution for WeChat games, which greatly improves the performance and flexibility of open data domains.

FEATURES

• Update open data domain solution
• Provide WeChat platform to clean up the cache API
• Support WeChat games and play a platform to set the frame rate through cc.game.setFrameRate
• Add a View menu for the simulator to set the resolution
• Modular RenderTexture and DynamicAtlas

Editor Fixes

• Fix problem with particle resource import in editor
• Fix the problem that Label is not affected by node anchor changes in the editor
• Fix BMFont font error in the editor editor
• Fixed an issue where the color of some Particles could not be displayed and set in the inspector
• Fix the problem that the simulator change size interface will not be adapted
• Fix the curve editor state residual problem of the animation editor
• Fix the problem that the particle system's svg flag is missing in the editor
• Fix Editbox Edit fontColor does not work
• Fixed an issue where the animation editor switched WrapMode while playing an animation, causing the node in the scene editor to be unable to drag
• Fix the problem that the node _localZOrder keeps changing when the data is saved
• Fix the problem that the keyboard direction key cannot be fine-tuned after the editor selects the node
• Fix the problem that the scene editor will not automatically locate in the hierarchy manager after selecting the node
• Fix the problem that the node tree is automatically expanded after the node is deleted
• Fix an issue where clicking the node level manager in the inspector panel does not automatically locate
• Optimize the Console automatic scrolling experience
• Fixed an issue where all child nodes were expanded when the parent node active state was switched
• Fix flashing issues when clicking on Hierarchy nodes
• Fix Auto Atlas preview invalidation issue

Engine Fixes

• Fix rendering issues with Spine animations
• Fix animation jitter caused by shader precision
• Fix the problem that setting the property in the inactive state does not take effect on the Sprite
• Fix Tiled type Sprite rendering error in texture rotation
• Fix the problem that the background in the open data domain cannot be transparent
• Fix rendering errors when Graphics has too many vertices
• Fix an issue where the camera does not respond to events after zooming
• Fix clipping of Tilemap after Camera scaling
• Fixed a state error caused by multiplexing of RichText subnodes
• Fix IE11 support
• Fix qqplay does not support particle map problem in base64 format
• Fix an issue where the Spine debug slot is not available in the Release version
• Fix problems with background switching events in front of each platform
• Fix rendering error caused by blend function when Label is switched to BMFont type
• Fix black screen of qqplay platform under Android P system
• Fix the problem with the Windows platform XMLHttpRequest GET result of timeout
• Fix AudioClip does not support lazy loading issues
• Add missing deprecation API to fix discovered API documentation issues
• Fixed an issue where Stencil would be overwritten by the last Mask when multiple Masks coexist
• Fix black border problem with Mask component in open data domain
• Fix Mask does not support lazy loading when using image stencil
• Fix Spine can't display debug slot in non-debug mode
• Fix the problem that the audio cannot be played when the Native platform is checked MD5
• Enhance fault tolerance of Particle resources and support resource formats exported by effecthub
• Fix resume can directly play unplayed audio
• Fix missing graphics caused by including Mask module and culling Graphics module
• Fix Native platform button can still receive touch events when active is false
• Fix the problem when the video platform VideoPlayer switches visibility without hidden video
• Fix an issue where the windows & mac emulator window size does not automatically adapt when it is changed
• Fix parsing problem with Tilemap parser
• Fix Camera does not support mask when using RenderTexture screenshots
• Fix an error caused by multiple Graphics switching between each other
• Fixed an issue where the final alpha was invalid when the particles in the particle system finally disappeared (opaque)
• Optimize the performance of small text rendering on the Native platform
• Fix Android platform return key monitoring failure
• Fix the problem that clicking the input box will disappear after the iOS platform pops up the input box
• Fix garbled characters when typing Chinese characters on iOS platform
• Optimize the completion button design of the input box
• Fix the problem of entering an emoticon in WeChat game
• Optimize the API design of TiledTile (do not allow layer to be set, get it automatically)
• Fixing the offset problem when the hexagonal TileMap uses TiledTile
• Fix native platform FileUtils writeStringToFile crashes when called

REMOVED & DEPRECATION

A large number of private and non-core APIs for v1.x have been removed or discarded. See the upgrade guide for details.

Related Resources

• [Cocos Creator v2.0 Upgrade Guide]
• [Creator v2.0 API doc]
• [WeChat game open data domain usage document]
• [Material use case]

v1.10.1 is a bug fix for the recently released v1.10.0. It is recommended that all v1.10 users update to this version. This version is not an alternative to v2.0, v2.0 is still the current version, and new projects are still recommended to use v2.0. As the last major version before v2.0, we will try our best to maintain stability until we can support users who are temporarily unable to upgrade to v2.0.

Good quality is important to us. Thank you very much for the feedback from developers through the forum, GitHub, Cocos technical services and other channels. Let us look forward to the upcoming 2.0.1!

Editor

• Fix WeChat sub-package related issues
• Fix project.js may be empty after the project is built
• Fix QQ play a build report bkgame related error
• When the repair project contains a large number of broken images, saving the preview when refreshing the preview or previewing will cause the editor to jam.
• WeChat developer tool error when fixing the build panel without checking “Source Maps”
• Fix an issue where vConsole does not display after enabling MD5Cache
• Fixed an issue where the .app program could not be selected within the mac platform preferences
• Added button for new clip on animation editor
• Level manager details are perfect

Engine

• Fix audioEngine’s isLoop always returns false
• Fixed an issue where the Text component was offset when the Label component was using TTF fonts
• Improve the text display of the EditBox under QQ Play
• Fix Android video playback related issues

After a large-scale underlying refactoring and a two-month stability iteration, Cocos Creator v2.0 is finally available. The core goals of the Cocos Creator v2.0 design were twofold:

• Significantly improve the engine performance
• Provide more advanced rendering capabilities and richer rendering customization’s

In order to accomplish this goal, we completely rewrote the underlying renderer, which structurally guarantees performance improvements and upgraded rendering capabilities. At the same time, in order to ensure that user projects can be upgraded more smoothly, we have almost no changes to the API of the component layer. Of course, these changes are not completely transparent to the user, such as the engine loading process, the event system, the streamlining and reorganization of the engine’s overall API, which will have an impact on the user-level API.

Editor

• Implemented premultiply alpha, filter mode, wrap mode configuration of Texture
• Abstract the mixed mode configuration into the RenderComponent component base class, all render components can be configured
• Camera component upgrade, as a direct rendering entry, you can configure various base rendering parameters
• With Quick Compile integration, the custom engine only needs to use the menu’s developer options -> compiler engine to compile quickly in a matter of seconds
• Open the WeChat game open data domain as a publishing platform with a separate publishing panel

Engine

• Add a new renderer based on the 3D engine
• Render component is fully upgraded
• Remove the render tree completely, assemble the render data directly and submit the render by the render component
• Streamlined cc namespace API
• Streamline Director API
• Camera component upgrade
• Start process upgrades, user scripts and plugin scripts can more easily interfere with engine initialization
• Platform-specific startup code is separated and easier to customize
• Event system optimization, distinguishing between system events dispatched by the capture bubbling mechanism on the node tree and normal events directly dispatched
• Fit Width & Fit Height is also compatible with the WeChat game platform.
• The RenderTexture resource type has been officially added to save the rendered content captured in the camera.
• Simplify TiledMap functionality to pave the way for subsequent upgrades
• Physical engine upgrade, performance optimization

Deletions and deprecations

• A large number of private and non-core APIs for v1.x have been removed or discarded. For details, please refer to the upgrade guide and deprecated

Related resources

• Creator v2.0 API doc
• Material use case

Compared to v1.9, v1.10 adds a lot of features, refactoring the resources of the engine, and greatly optimizing the size of the settings.js file. In addition, 1.10 also supports game code subpackaging on WeChat games and Web and native platforms. This will break through the 4MB limit of WeChat's first package and increase the game loading speed. See [Code Subcontract Loading] for details. At the same time, v1.10 has rewritten many editor code to improve the editor's experience and performance. If your project is planned to be upgraded to v2.0 later, please upgrade to v1.10 in advance to ensure the smoothest upgrade process.

Resource Upgrade

Starting with v1.10, Cocos Creator refactored the underlying resource types. Most projects are unaffected, but some projects may receive some warnings. See the [v1.10 Resource Upgrade Guide] for details.

Editor

• Greatly optimize the size of the published js file
• Script subpackage settings have been added to the property inspector for the folder
• Allow each project to set a custom engine separately
• Add the node lock function in the hierarchy manager. When the mouse is moved to the node, there will be a lock button on the left side. After the node is locked, the node cannot be selected in the scene editor
• In the Property inspector of the Prefab resource file, the Optimize Policy option has been added to optimize Prefab creation time. See [Prefabricated Resources: Setting Optimization Strategies] for details
• Optimize the main menu under Windows
• Add an auto-refresh feature to the list of scenes in the build panel.
• When publishing to the native platform, MD5 is also added to the file naming to facilitate hot updates
• Script compilation will automatically skip all .d.ts files to avoid TypeScript error reporting
• The Console panel adds the Clear on Play option to automatically clear the log before the game previews
• Adjust the text font and color of the Console panel
• A search option button has been added to the search bar of the Hierarchy Manager and Explorer
• Added plugin management features in the plugin store
• Allows you to change the custom control icon in the control library
• The resource manager adds recognition of aac and pcm extension audio files
• Supports direct search of the compressed uuid format when the resource manager searches for uuid
• Allow the right mouse button to drag and drop the timeline of the Timeline editor
• An exit menu has been added to the Dashboard's system tray icon

Engine

• Support game script subcontract loading, see [Code Subcontract Loading] for details
• The align mode property is added to the Widget component. When set to ON_WINDOWS_RESIZE, it will be automatically refreshed when the window size changes
• The loading of the [text] and [JSON] resource types is officially supported
• The native platform adds the [cc.sys.getBatteryLevel] and [cc.sys.getNetworkType] interfaces to get device power and network status
• When the native platform is hot updated, the old version of the resource file will be deleted
• VideoPlayer adds volume adjustment and mute functions
• Add DragonBones native platform binding interfaces getSlots, replaceSlotDisplay and Slot.name (thanks @feijing566)
• TiledMap supports rendering and cropping of ortho maps in any direction on the web platform
• The Layout component will only typeset active nodes
• Retina rendering is enabled by default on the Android UC browser.
• Enable Webgl on UC Browser 11 or later
• Increase the recognition of the UCBS browser
• Gravity sensing is adjusted to only be available when the developer has a registration event

 Bug Fixes

• [Editor] Fixes the jam when setting the SpriteFrame in the set
• [Editor] Fixes the simulator configuration to save related issues
• [Editor] Fixed an issue where the error message output from the emulator to the Console was displayed in white
• [Engine] Fixed an error when the resource export tool encountered the same parent folder name
• [Engine] Fixed an issue where copying the automatically synchronized Prefab subnode under the editor might be wrong
• [Engine] Fixed a problem where the fragment texture in the automatic map set was incorrectly referenced by other resources
• [Engine] Fixed a bug where the plugin script did not correctly parse the CC_WECHATGAME and CC_QQPLAY keywords
• [Engine] When fixing scene switching or node destruction, the animation may not stop playing
• [Engine] [Wechat] Fixes some versions of WeChat games to get the problem of each frame interval
• [Engine] [Wechat] Fixes RenderTexture related issues on Android WeChat games
• [Engine] [QQPlay] Fix QQ The problem of repeated downloads when playing a resource
• [Engine] Fixed an issue where the slider of the Slider component might not be right when dragged
• [Engine] Fixed an issue where the audio load event could be triggered repeatedly
• [Engine] Fixed a problem where the user changed the level while dectivating the node without any error
• [Engine] Fixed an issue where WebView could not be hidden in the Safari browser on some platforms (iOS 9/10 or Mac)
• [Engine] Fixed BMFont rendering pitch problem for native platforms.
• [Engine] Fixed an issue where the button's touch area would be offset when Canvas was unchecked for Fit Width and Fit Height

Upgrade the Android SDK

Starting with v1.10, the API Level in the Android build panel specifies the minimum Android version supported by the compiled apk. It is recommended to select 14. targetSdkVersion, compileSdkVersion, buildToolsVersion have all been upgraded to 26. If the developer has other needs, you can manually modify proj.android-studio/app/build.grade and proj.android-studio/gradle.properties

REMOVED

• Removed Eclipse and Ant to build support for the Android platform
• Removed support from Chipmunk
• Removed loader.loadRes to directly load the support of the child SpriteFrame in the collection, please load the gallery first and then call atlas.getSpriteFrame(name)

DEPRECATION

• As of 10.0, Texture2D.releaseTexture is no longer recommended, please use Texture2D.destroy instead
• As of 8.2, cc.eventManager is no longer recommended, please use cc.EventTarget or cc.systemEvent instead, the original API will be removed in 2.0
• As of 8.2, cc.inputManager is no longer recommended, please replace it with the same interface of cc.systemEvent, the original API will be removed in 2.0
• As of 8.2, dragonBones.CCFactory.getFactory is no longer recommended, please use dragonBones.CCFactory.getInstance instead, the original API will be removed in 2.0

 KNOWN ISSUES

• When you copy and paste a resource in the Explorer, the resource property will not be copied. (Since 1.9.0)
• The Android native platform does not support playing remote video

Cocos Creator v1.9.3 is a minor upgrade to the recently released v1.9.2. It mainly improves the support for WeChat games and QQ play. It is recommended that all 1.9 users update the engine version to get a better experience as this release also improves quality and careful polishing. Thank you very much for the feedback from developers on the forums, GitHub, Cocos technical services and other channels.

Animation Editor

• Fix where the data may be incomplete when the animation editor saves the animation.
• Fix where directly editing the texture animation will report an error
• Fixed an issue where the animation editor could not add width and height properties under size

WeChat Game

• Fixed an issue where only a single audio can be played on WeChat games and the number of audio plays is limited.
• Fix that WeChat mini game audio can’t stop
• Fix gravity sensing direction and wrong value in Android WeChat game
• Fix not being able to submit a TypedArray format texture in WeChat games
• Fix that the frame rate is abnormal on the old WeChat
• Improve WeChat mini game video playback support
• Downward compatible with WeChat games 1.7.4 version base library

QQ Play

• Fix only play a single audio and the number of audio playback is limited
• Fix unable to operate the engine object during the game loading process
• Fix particle play card dead problem
• Fix a semi-transparent text will be rendered into a black question

DragonBones

• Fixing DragonBones’ repeated assignment of bones on native platforms can cause crashes
• Fix manually clearing the texture data of Dragon DragonBones

Others

• Fix text box for Web and Android platform Input Flag is invalid
• Fix Label rendering related issues
• Fix cc.game’s EVENT_HIDE and EVNET_SHOW callbacks may be called multiple times

Cocos Creator v1.9.2 is a minor upgrade to the recently released v1.9.1. This release mainly improves the support for WeChat games and QQ games. If you release on WeChat or QQ it is recommended that you upgrade to this release.

• This version fixes the problem where a ZERO blending mode is invalid. If the image color is incorrect after the upgrade, check if the blending mode of the Sprite component is set to ZERO. If so, change it back to the default value.
• This version rewrites the animation editor. If you encounter any errors please create a topic on our forums.

Features

• [Editor] [Timeline] Animation Editor can edit “missing nodes” and allow node data to be migrated
• [Editor] [Timeline] Animation Editor supports copying and pasting keyframes on multiple nodes at the same time
• [Editor] [Timeline] Animation Editor Several Experience Optimizations
• [Editor] Place the adaptation layer code of QQ Play and Wechat games into the Contents/Resources/builtin directory of the editor for users to upgrade
• [Engine] Upgrade Facebook Instant Games SDK to 6.2
• [Engine] Optimizing Label’s Memory Usage on Non-native Platforms

WeChat Games

• Fixed an issue where the AudioSource component may report an error when it is destroyed
• Optimize the implementation of sounds on WeChat games
• Use openDataContext to define the open data field in the game.json of the WeChat game. Change the entry file of the open data field to index.js
• Fix the issue of loading remote resources in the WeChat open data domain
• Fix errors that may occur when loading plist particles on WeChat games
• Fix gl.texImage2D error caused by calling cc.RenderTexture.create in WeChat game
• Fixed an error on WeChat getting old WeChat game open data domain on old version
• Allows simulation of system information obtained through cc.sys.os on the WeChat mini game developer tools
• Fixed an issue where the subdomain could not be correctly identified on the old version of WeChat

QQ Play

• Optimized QQ to play a sound on the realization
• Fix QQ playing a problem with the following blue screen in iOS 10
• Repair QQ may play an error when loading plist particles
• Fixed plug-in script loading exception when posting to QQ to play with Windows
• Improve header processing in XMLHttpRequest for QQ
• Perfect userAgent for QQ
• Fixed QQ playing a text stroke effect

Bug Fixes

• [Editor] Fix Documentation Links for AudioSource and MotionStreak Components
• [Editor] Fix the problem that the editor might preview the animation if the animation changes the node’s active
• [Editor] Fixed an issue where the editor could not be accessed when the login server went down
• [Editor] Fix the issue that when you repeatedly drag to the same prefab as a child of other prefab
• [Engine] Fixed an issue where the sprite’s blend mode could not be set to ZERO on the web platform
• [Engine] Fixed a problem in cc.sequence where nesting other calls to the repeat method’s action would cause abnormal speeds in special cases
• [Engine] Fix Sprite error after scene change
• [Engine] [JSB] Fixed an issue that triggered assertions after creating cc.GLProgram in the JS layer and adding it to cc.shaderCache
• [Engine] [JSB] Fix Native Platform Physics Engine Binding Problem
• [Engine] [Native] Fixed cc.Sprite.FillType enumeration error on native platform
• [Engine] [UI] Fixed a positioning issue that may be caused when the scroll view is enabled with vertical, horizontal scrolling, and the inner size is too small.
• [Engine] [Audio] Fixed an issue where playing audioEngine.resume repeatedly would start from scratch.

Cocos Creator v1.9.1 is a minor upgrade to the recently released v1.9.0. The detailed changes are:

WeChat Games

• Support for publishing the entire project to the WeChat mini game sub-domain. For details, please refer to document.
• Support WeChat game configuration in the build panel Remote server address option to facilitate the download of remote resources
• Support for using TTF fonts on WeChat mini games
• Switch the adaptation layer of the WeChat game from ES6 to ES5, users can not enable ES6 to ES5
• Fix potential audio memory leak in WeChat game

QQ Play

• Support QQ to play in the build panel to configure the remote server address option to facilitate the download of remote resources.
• Fix some minor bugs in XMLHttpRequest with QQ
• Fixed an issue where the js path could not be resolved during QQ build
• Perfect QQ play with multi-touch support
• Added QQ support for base64 encoded images
• Perfect QQ Play Adaptation Layer
• Perfect audio support for QQ
• Fixed black screen issue after QQ checked MD5 Cache

Other Updates

• [Editor] [Build] Bug fix for custom project build template functionality not working on the Facebook Instant Games platform
• [Editor] [Build] Add build-start event to make it easier for users to do some processing before they build
• [Engine] [Wechat] Fixed an issue where WeChat game audio could not be stopped
• [Engine] [iOS] Fix the issue that the isTypedArray method fails on iOS 8-9
• [Engine] [Web] Fixing particle system will remove memory if it is not activated yet
• [Engine] cc.isValid adds an optional argument. Passing true will return false at the beginning of the destroy frame.
• [Engine] [Android] Fix a Memory Leak on jni

DEPRECATION

• As of v1.8.2, cc.eventManager is no longer recommended. Use cc.EventTarget or cc.systemEvent instead. The original API will be removed in 2.0.
• As of v1.8.2, cc.inputManager is no longer recommended. Use the same interface as cc.systemEvent instead. The original API will be removed in 2.0.
• As of v1.8.2, dragonBones.CCFactory.getFactory is no longer recommended. Please use dragonBones.CCFactory.getInstance instead. The original API will be removed in 2.0.

KNOWN ISSUES

• When copying and pasting resources in the explorer, the resource properties will not be copied. (Since 1.9.0)

QQ Play known issues

QQ is still playing in the grayscale test, developers also need to obtain internal testing qualifications for development, and only supports compiling on Mac for the time being. In addition, our adaptation work for QQ has not been completely completed yet. The following modules are currently not supported:

• Label: TTF is not supported, system font can only use the default font
• Particle system: Map data is not stored in plist. Only support map URL
• WebView
• VideoPlayer
• DeviceMotion

The above functions are expected to be supported one by one in future updates. We will also continue to closely communicate with the Play engineers and continue to optimize the fitting effect.

As of March 14, 2018, Facebook officially launched the Instant Games platform, worldwide, giving all developers an equal chance to enter and expand their overseas markets.

Many game studios have chosen Cocos Creator as their game development engine. Rapid development and continuous iteration make Cocos Creator the perfect choice. It has already formed a competitive advantage in the field of small games. The Cocos Creator editor is a powerful tool for developers to create excellent content and innovative games.

Cocos Creator is the best tool to create Facebook Instant Games. Already there are 24 games available produced by Chinese domestic companies and Cocos Creator already is sitting on 54% market share. The Cocos team is familiar with the workflow of online games and the requirements of the Facebook Instant Games platform. In order to help game studios successfully release their games on the Facebook Instant Games platform, and help them seize the opportunity opened up by the huge overseas HTML5 market, the engine team continuously worked overtime.

Cocos Creator 1.9 is released today with integrated Facebook Instant Games Support! Cocos Creator provides major features including:

• Integrated Facebook Instant Games SDK and game templates, allowing users to quickly integrate features of Facebook Instant Games
• A one-click packaging process in the Cocos Creator Build Panel. Games can be packaged directly into Facebook Instant Games.
  Developers only need to do a few simple steps. Cocos Creator handles all the technical aspects, you just need to code your game.

For more detailed technical documentation please refer to this link.

Features

• Support for Facebook Instant Games, see Documentation
• Support QQ Play, See Documentation
• [Editor] Assets panel directly supports copy and paste resources (via right-click menu or shortcut keys)
• [Editor] In the scene editor’s Rect edit mode, support for dragging a node’s white space, easy to change the value of the anchor
• [Editor] Added “Sync” button to the particle component’s Property inspector. Clicking Sync will set the Custom parameter to be the same as File. (Synchronize button is only available if you check Custom and set File)
• [Editor] Adds scale property to Timeline to facilitate editing of both scaleX and scaleY
• [Engine] PhysicsManager Adds FIXED_TIME_STEP and MAX_ACCUMULATOR Parameters

Bug Fixes

• [Engine] [Web] Fixed an issue where the input box could not pop up in some MIUI browsers
• [Engine] Fix the issue that the audio may not stop after checking MD5 build
• [Engine] Fixed issue where Label’s stroke may be truncated by one pixel
• [Engine] Fixed an issue with exception-free messages in the cc.Class constructor
• [Engine] [Animation] Fixed issue where one frame would be played less when the Animation component switched animations or manually set the AnimationState time
• [Engine] [Wechat] Fixes Failed to Use Remote Service Loading After iOS Wechat Mini Game Native Code Pack Exceeding 4MB

DEPRECATION

• As of v1.8.2, cc.eventManager is no longer recommended. Use cc.EventTarget or cc.systemEvent instead. The original API will be removed in 2.0.
• As of v1.8.2, cc.inputManager is no longer recommended. Use the same interface as cc.systemEvent instead. The original API will be removed in 2.0.
• As of v1.8.2, dragonBones.CCFactory.getFactory is no longer recommended. Please use dragonBones.CCFactory.getInstance instead. The original API will be removed in 2.0.

KNOWN ISSUES

• When copying and pasting resources in the Assets panel, the resource properties will still not be copied. (Since 1.9.0)
• On a native platform, calling the action.easing(cc.ease) method may cause the node’s logical data to be out of sync. Please use new cc.Ease(action) instead. (Since 1.8.2)

QQ Play Known Issues:

At present, QQ Play is still in AB Test. Developers are also required to obtain internal beta qualification in order to develop, and currently only support compiling on Mac. In addition, our adaptation work on QQ Play has not been completely completed yet. The following modules are still not supported at present:

• Label: ttf is not supported, system font can only use the default font
• Particle system: Map data is not supported in plist. Only texture urls are supported.
• WebView
• VideoPlayer
• DeviceMotion

The above functions are expected to be supported one by one in future updates. We will also continue to closely communicate with QQ Play’s engineers to continuously optimize the matching effect.