Cocos Enhance Kit

This is a community fork of Cocos Creator v2.x, providing numerous new features, performance improvements, and fixes.

We will continue to provide new features, optimizations, and fixes while maintaining the principles of being completely open source and fully compatible.

We warmly welcome you to join us in improving this project!

## Main Features ### Full Compatibility | H5 | WeChat Mini Game | Android Native | iOS Native | TikTok Mini Game | OPPO Mini Game | vivo Mini Game | | ---- | --------------- | -------------- | ---------- | ---------------- | -------------- | -------------- | | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | The community version currently and in the future will ensure: - Compatibility with existing projects, allowing switching to the community version without code modifications - No modifications to the project itself, allowing switching back to the official version at any time - Optional enabling of any features, ensuring project controllability And it's compatible with all platforms! ### Multi-Texture Rendering Support Previously, batch rendering would break when adjacent nodes used different textures. We typically avoided this by adjusting node order and merging atlases. However, this was complex and cumbersome in practice, making it difficult to achieve optimal results. Higher DrawCall counts would lead to performance degradation and device heating issues. Now, with multi-texture rendering support, up to 8 different textures can be rendered without breaking batching. **In the worst case, this can reduce your project's DrawCall count to 1/8 of the original!** Furthermore, this feature is automatically enabled when using dynamic atlas, providing optimization benefits without any modifications. ![demo1.png](https://download.cocos.com/Cocos/CocosStore/markdown/2022/07/eea85d1cde3106b38a527943489c04cc14893.png) ### High-Definition Text Rendering Support Previously, the Cocos Creator engine rendered fonts at 1x resolution by default, causing text to appear blurry on some `Retina` devices. Since the engine didn't support adjusting this, we would solve text rendering blur by doubling the Label's `fontSize` and halving its `scale`. Now, with high-definition text rendering support, you only need one line of code: ```ts cc.sp.labelRetinaScale = 2; ``` to adjust the engine's text rendering resolution and achieve high-definition text rendering effects. ![demo4.png](https://download.cocos.com/Cocos/CocosStore/markdown/2022/07/6df13fd085e9c1c78b1d59533b19d81447302.png) ### Enhanced Dynamic Atlas Besides adding automatic multi-texture rendering support to dynamic atlas, we've essentially rebuilt the entire dynamic atlas module. The current dynamic atlas not only optimizes algorithms but also **supports reuse of discarded space**, which significantly improves project performance optimization potential. Additionally, **Spine can now participate in dynamic atlas**! ![demo2.png](https://download.cocos.com/Cocos/CocosStore/markdown/2022/07/51748d361ee0d921a47f3b227925119a49010.png) ### Enhanced Label Component Label has always been the most challenging aspect of project optimization because it cannot batch render with other rendering components, and in most cases, can't even batch with other Label components. Previously, the `Bitmap` mode could join dynamic atlas for batching, but due to engine limitations preventing reuse of discarded space in dynamic atlas, the available space for dynamic atlas would shrink as the project ran, easily filling up the dynamic atlas. This made it impractical for real projects. The `Char` mode had similar issues - internal character textures couldn't be reused and only supported up to 1 texture, making it easy to fill up the texture and prevent text rendering, making it unsuitable for real projects. But now, Label has received these major improvements: - The rebuilt dynamic atlas supports reuse, making `Bitmap` mode viable! - `Char` mode has been rebuilt, **supporting discarded space reuse, up to 8 character textures, and automatic multi-texture batching**! - RichText receives all the same improvements and now supports custom material settings. ![demo3.png](https://download.cocos.com/Cocos/CocosStore/markdown/2022/07/bfa8b60ae7a155de3b543093fc97b3af24982.png) ### Enhanced Spine Component Besides Label, if your project uses Spine components, it's likely to be the second most challenging optimization point. Now, Spine has also received major improvements, **supporting batching with other components, participating in dynamic atlas, and seamlessly using SpriteFrame for costume changes**! ![demo5.png](https://download.cocos.com/Cocos/CocosStore/markdown/2022/07/ba165e6066c0878edbdd7d5711fd824539554.png) ### TiledMap Component Optimization A single TiledMap component may contain multiple TiledLayers, and with Culling enabled, each Layer needs to calculate Culling data separately. Now, under certain conditions, Culling data can be reused to reduce CPU performance consumption. ### Multi-threading Support **Now, multithreading support is added to the following parts of the engine:** - **Asset pipeline (download and cache)** - **Audio system** - **XMLHttpRequest** When enabled, it can release its occupation of the main thread and reduce the lag phenomenon. In addition, there is **support for custom multithreaded extensions**, which greatly simplifies the steps required to multithread your project logic! And in the wechat small game platform, there are the following improvements: - **High-performance mode for network and audio interfaces is enabled by default** - **Web interface supports HTTP/2, HTTP/3(QUIC) protocols** ## Demo [Web Desktop](https://smallmain.github.io/cocos-enhance-kit/demo/v1.0.0/web-desktop/index.html) [Web Mobile](https://smallmain.github.io/cocos-enhance-kit/demo/v1.0.0/web-mobile/index.html) (Please rotate device to landscape) ## Documentation Please visit the [Documentation](https://smallmain.github.io/cocos-enhance-kit/docs/intro). ## Installation Please read the [One-Click Installation](https://smallmain.github.io/cocos-enhance-kit/docs/installation/installation-auto) in the documentation. ## Changelog Please visit [Github Release](https://github.com/smallmain/cocos-enhance-kit/releases). ## Contribution Guidelines - If you have any questions or ideas, please create new `Issues`. We'll help as much as we can! - If you have new code to submit, please create new `Pull requests` for merging. ## FAQ **Why modify the engine directly?** Official updates for version 2.x have stopped (only maintenance work continues). Modifying the engine won't require extensive adaptation time when new official versions release, nor will it face feature conflicts. Without customizing the engine, native platform compatibility would be impossible. Even without compatibility, implementing certain features using Hack methods would require extensive code copying, increasing package size and reducing maintainability. Finally, we want it to feel like a "native" experience, as if it's just a painless engine upgrade. **Getting "Error: Can not parse this input:undefined" when launching Cocos Creator** You may have forgotten to install the companion engine extension, so the community version's built-in resources weren't found. Please carefully read the documentation and reinstall. **Native platform or simulator error: "Assertion failed: (_type == Type::String), function toString, file Value.cpp, line 496."** You may not have replaced the engine's `jsb-adapter` portion, or haven't restarted to make the replacement effective. For native platforms, note that after upgrading, the first build may require deleting the existing build project to take effect. **Various issues when previewing with simulator** This may be due to the simulator not being recompiled. Please recompile the native simulator following the official [Engine Customization Documentation](https://docs.cocos.com/creator/2.4/manual/zh/advanced-topics/engine-customization.html#25-编译模拟器). **Spine component showing "Uncaught TypeError: Cannot read property 'load' of null, location: src/cocos2d-jsb.b5158.js" and similar issues** This is an engine issue occurring when releasing and then reloading the same Spine resource. See: [Issue Discussion](https://forum.cocos.org/t/topic/137649/148) As of v2.4.12, this issue remains unfixed. There are three temporary solutions: 1. The engine has a PR fixing this issue, but it's not merged yet: [PR #4307](https://github.com/cocos/engine-native/pull/4307) 2. Prevent Spine resources that need releasing from participating in dynamic atlas (control via Spine component's atlas toggle) 3. Don't release Spine resources that need to participate in dynamic atlas This issue has been fixed in v2.4.13, please upgrade the community version to v2.0.0 or above. ## Support Us Developing the community version requires extensive work. Your support is our greatest motivation: - Please give our project repository a [Star](https://github.com/smallmain/cocos-enhance-kit)! - Purchase this extension to sponsor us!