Skip to content

Commit b36ca8c

Browse files
PatriceJianghuangwei1024
authored andcommitted
Update changelog and release note (cocos2d#19264)
* add ReleaseNotes
1 parent 96e4458 commit b36ca8c

File tree

3 files changed

+34
-128
lines changed

3 files changed

+34
-128
lines changed

CHANGELOG

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ cocos2d-x-3.17.1 Nov.19 2018
2525
[REFINE] CMake: remove un-elegant prebuilt feature at internal cmake build scripts
2626
[REFINE] 3rd: upgrade libwebsockets to 2.4.2 with libuv enabled
2727
[REFINE] 3rd: improve cmake build scripts for external libs
28-
[REFINE] 3rd: upgrade luajit to 2.1.0-beta3
28+
[REFINE] 3rd: upgrade luajit to 2.1.0-beta3, fix random crash in Android release mode
2929
[REFINE] 3rd: external/lua/lua is not referenced in cmake and it will be removed in the near future
3030
[REFINE] Tests: add websocket latency test
3131
[REFINE] Tests: add download multi task test case
@@ -70,11 +70,13 @@ cocos2d-x-3.17.1 Nov.19 2018
7070
[FIX] Android: fix crash caused by JNIEnv null pointer in getStringUTFCharsJNI function
7171
[FIX] Android: use 'Binary names' style on JNI for ClassLoader.loadClass
7272
[FIX] Android: allow cleartext HTTP traffic by default
73+
[FIX] Windows: Support VS2017 in release mode
7374
[FIX] Action: fix repeat CallFunc for some times, may never stop
7475
[FIX] Physics: fix PhysicsJointMotor setRate and getRate Bad Access Crash
7576
[FIX] FileUtils: fix removeDirectory() failure on win32
7677
[FIX] FileUtils: let getContents return an error code when the filename is a directory
7778
[FIX] FileUtils: let isFileExistInternal return false when folder as parameter on Linux
79+
[FIX] LUA: performance drop bug introduced in 3.17
7880
[FIX] CMake: fix project name always be "TemplateCpp" when create a new project
7981
[FIX] Tests: fix auto test stop in cpp-tests project
8082
[FIX] cocos console: do uninstall only when that app is installed for android

docs/RELEASE_NOTES.md

Lines changed: 15 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -2,69 +2,26 @@
22
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
33
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
44

5-
- [Cocos2d-x 3.17 Release Notes](#cocos2d-x-317-release-notes)
6-
- [Android requirements](#android-requirements)
5+
- [Cocos2d-x 3.17.1 Release Notes](#cocos2d-x-3171-release-notes)
76
- [Highlights](#highlights)
8-
- [added support for iPhone X](#added-support-for-iphone-x)
9-
- [added support Android Studio 3.0+](#added-support-android-studio-30)
10-
- [CMake is now supported on all platforms](#cmake-is-now-supported-on-all-platforms)
11-
- [upgrade 3rd-party libraries](#upgrade-3rd-party-libraries)
12-
- [remove outdated](#remove-outdated)
13-
- [misc bugs fix and stability improvements](#misc-bugs-fix-and-stability-improvements)
147

158
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
169

17-
# Cocos2d-x 3.17 Release Notes #
18-
The 3.17 release focuses on stability and increased performance with some under the hood enhancements that will make cross-platform development easier.
10+
# Cocos2d-x 3.17.1 Release Notes #
1911

20-
## Android requirements
21-
22-
v3.17 has been tested using Android Studio (3.0, 3.1, 3.1.1) with NDK r16
12+
The 3.17.1 release focuses on bug fixing.
2313

2414
## Highlights
2515

26-
- added support for iPhone X
27-
- added support Android Studio 3.0+
28-
- CMake is now supported on all platforms
29-
- upgraded Spine runtime to v3.6.39
30-
- upgraded GLFW to 3.2.1
31-
- misc bugs fix and stability improvements
32-
33-
### added support for iPhone X
34-
35-
3.17 brings support for iPhone X including supporting full screen mode, using Storyboards for launch images, __safe area__ API and support for auto hiding the Home indicator. It is important to note exactly what and where the safe area is:
36-
37-
<p align="center">
38-
<img width="400" src="https://raw.githubusercontent.com/cocos2d/cocos2d-x-docs/master/en/installation/iOS-img/iPhoneXSafeArea.png">
39-
</p>
40-
41-
Developers can get the safe area easily by calling: `Director::getSafeAreaRect()`.
42-
43-
### added support Android Studio 3.0+
44-
45-
Android Studio is the only official IDE for Google's Android operating system.
46-
Cocos2d-x supports Android Studio using NDK version r16 to r16. Gradle configurations have been updated, including simplifying Gradle PROP_* values, changing the deprecated `compile` to the new `implementation`in dependency declaration, and added Proguard configuration to reduce Release package size.
47-
48-
### CMake is now supported on all platforms
49-
50-
CMake is now supported on all platforms, including Android(NDK), iOS, macOS, Windows (VC++ compiler), Linux. Supports precompile libraries for engine, and reusing precompiled libraries in the new build process. Your projects build time will be greatly reduced. For detailed usage, please refer to [CMake Doc](https://github.com/cocos2d/cocos2d-x/blob/v3/cmake/README.md)
51-
52-
### upgrade 3rd-party libraries
53-
54-
Spine skeleton animation is widely used in games developed by Cocos2d-x. Spine runtime has been upgraded to 3.6.39 to keep current.
55-
56-
GLFW has been upgraded to 3.2.1 to help fix joystick issues. You can also now use GLFW as a precompiled library.
57-
58-
Box2D hasn't been updated in quite some time. A new production version has yet to be released so far in 2018. We felt GitHub commit f655c603ba9d83 was stable. You can also now use Box2D as a precompiled library.
59-
60-
Each Cocos2d-x release comes with a specific version of third-party libraries. If you want to upgrade third-party libraries due to your projects needs, please refer to: [3rd-party Doc](https://github.com/cocos2d/cocos2d-x-3rd-party-libs-src/blob/v3/README.md)
61-
62-
### remove outdated
63-
64-
Google officially deprecated ant build support starting in [Android SDK Tools 25.3.0](http://tools.android.com/recent/androidsdktoolsrevision2530feb2017). The old ant based `proj.android` and been dropped and now `proj.android` is an Android Studio project. The default architecture is changed from `armeabi` to `armeabi-v7a`.
65-
66-
Visual Studio 2013 support has been dropped. Visual Studio 2015/2017 are still currently supported. The existing win32 project files is quite suitable for 2015. To use 2017, you can open a 2015 project file, modify the configuration to suit your needs, or use CMake (See above).
67-
68-
### misc bugs fix and stability improvements
69-
70-
This release contains more than 51 bugs fixed and 33 misc improvements, please refer to [Changelog](https://github.com/cocos2d/cocos2d-x/blob/v3/CHANGELOG)
16+
- Fix Lua loading performance drop bug introduced in 3.17
17+
- Renderer limit glClear invoke times, reduce power consuming
18+
- optimize CMake script,fix some linking issues
19+
- Android use CMake as default PROP_BUILD_TYPE value
20+
- Android upgrade Gradle to 4.6, SDK 28, android gradle plugin 3.1.0
21+
- upgrade LuaJIT to 2.1.0-beta3, fix random crash in 3.17 Lua release mode
22+
- upgrade libwebsockets to 2.4.2
23+
- FileUtils provide thread-safe implementation and add missing cross-platform interface
24+
- limit Labels text length to fix render error
25+
- add Downloader binding to Lua
26+
27+
This release contains more than 45 bugs fixed and 34 misc improvements, please refer to [ChangeLog](https://github.com/cocos2d/cocos2d-x/blob/v3/CHANGELOG)

docs/RELEASE_NOTES_CN.md

Lines changed: 16 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -2,79 +2,26 @@
22
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
33
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
44

5-
- [Cocos2d-x 3.17 Release Notes](#cocos2d-x-317-release-notes)
6-
- [测试环境](#%E6%B5%8B%E8%AF%95%E7%8E%AF%E5%A2%83)
7-
- [版本特性](#%E7%89%88%E6%9C%AC%E7%89%B9%E6%80%A7)
8-
- [详细介绍](#%E8%AF%A6%E7%BB%86%E4%BB%8B%E7%BB%8D)
9-
- [支持 iPhone X](#%E6%94%AF%E6%8C%81-iphone-x)
10-
- [支持 Android Studio 3.0+](#%E6%94%AF%E6%8C%81-android-studio-30)
11-
- [CMake 支持全平台](#cmake-%E6%94%AF%E6%8C%81%E5%85%A8%E5%B9%B3%E5%8F%B0)
12-
- [升级第三方库](#%E5%8D%87%E7%BA%A7%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%93)
13-
- [移除过时的内容](#%E7%A7%BB%E9%99%A4%E8%BF%87%E6%97%B6%E7%9A%84%E5%86%85%E5%AE%B9)
14-
- [Bugs 修复,提高稳定性](#bugs-%E4%BF%AE%E5%A4%8D%E6%8F%90%E9%AB%98%E7%A8%B3%E5%AE%9A%E6%80%A7)
5+
- [Cocos2d-x 3.17.1 Release Notes](#cocos2d-x-3171-release-notes)
6+
- [版本变动](#%E7%89%88%E6%9C%AC%E5%8F%98%E5%8A%A8)
157

168
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
179

18-
# Cocos2d-x 3.17 Release Notes #
10+
# Cocos2d-x 3.17.1 Release Notes #
1911

20-
Cocos2d-x 3.17 版本着重于工具链的更新,和稳定性的增强
12+
Cocos2d-x 3.17.1 侧重于稳定性的提升, 已有问题的修复
2113

22-
## 测试环境
14+
## 版本变动
2315

24-
Android 平台使用 Android Studio (3.0, 3.1, 3.1.1) 和 NDK r16 进行测试。
25-
26-
## 版本特性
27-
28-
- 支持 iPhone X
29-
- 支持 Android Studio 3.0+
30-
- CMake 支持全平台,支持预编译引擎库
31-
- 升级 Spine runtime 至 v3.6.39
32-
- 升级 GLFW 至 3.2.1,并提供预编译库
33-
- 更新 Box2D,并提供预编译库
34-
- 去除 Android 的 ant 工程
35-
- 去除 Visual Studio 2013 的支持
36-
37-
## 详细介绍
38-
39-
### 支持 iPhone X
40-
41-
3.17 带来对 iPhone X 的支持,包含支持全屏模式,支持自动隐藏 Home 指示器,改用 Storyboard 作为启动屏幕,和增加获取 Safe Area 的接口。在开发支持 iPhone X 的应用时,最需要了解清楚的就是 Safe Area:
42-
43-
<p align="center">
44-
<img width="400" src="https://raw.githubusercontent.com/cocos2d/cocos2d-x-docs/master/en/installation/iOS-img/iPhoneXSafeArea.png">
45-
</p>
46-
47-
开发者可以通过调用 `Director::getSafeAreaRect()` 来获取 Safe Area 区域。
48-
49-
### 支持 Android Studio 3.0+
50-
51-
Android Studio 是 Google 官方唯一支持的 Android 开发 IDE。
52-
53-
该版本增加了对 Android Studio 3.0+ 的支持。在支持的过程中,同时将 NDK 版本从 r14 升级到 r16。对 Gradle 工程配置也进行了诸多改进,包括简化 Gradle 变量 PROP_*,将依赖声明中弃用的 `compile` 改为新的 `implementation`,增加用以削减 Release 包体积的 Proguard 文件。
54-
55-
### CMake 支持全平台
56-
57-
扩展 CMake 构建支持至全平台,包括 Android (NDK)、iOS、macOS、Linux、Windows(VC++ compiler)。支持将引擎部分进行预编译,并在新的构建过程中重用预编译的引擎库。通过使用预编译库,可以极大的缩短工程构建时间。
58-
59-
详细的使用方法请参考 [CMake 文档](https://github.com/cocos2d/cocos2d-x/blob/v3/cmake/README.md)
60-
61-
### 升级第三方库
62-
63-
Spine 骨骼动画广泛用于 Cocos2d-x 开发的游戏,引擎跟进 Spine 的升级,升级 Runtime 至 3.6.39。
64-
65-
升级 GLFW 至 3.2.1 以修复支持游戏手柄时存在的问题,同时提供 GLFW 预编译库。
66-
67-
社区希望引擎升级 Box2D,可 Box2D 的新版本迟迟未发布,根据反馈 GitHub 提交 f655c603ba9d83 是稳定的,升级 Box2D 至该提交,同时提供 Box2D 的预编译库。
68-
69-
每一次版本发布,都会附带特定版本的第三方预编译库,如果由于项目需要想对第三方库进行定制,请参考: [第三方库文档](https://github.com/cocos2d/cocos2d-x-3rd-party-libs-src/blob/v3/README.md)
70-
71-
### 移除过时的内容
72-
73-
由于 Google 官方自 [Android SDK Tools 25.3.0](http://tools.android.com/recent/androidsdktoolsrevision2530feb2017) 就已放弃 ant 支持。移除旧有的 `proj.android` ant 工程,新的 `proj.android` 是 Android Studio 工程。[NDK r16](https://developer.android.com/ndk/guides/abis) 弃用了 armeabi,引擎调整默认的编译架构从 armeabi 为 armeabi-v7a。
74-
75-
在 win32 平台,越来越多的开发者已经使用 Visual Studio 2015/2017 进行开发,移除对年代久远的 2013 的支持。现存的工程配置适合于 2015 ,如果需要使用 2017,可打开现有的 sln 文件,调整配置,或使用 CMake。
76-
77-
### Bugs 修复,提高稳定性
78-
79-
改版本包含 51 项 bugs 修复和 33 项小改进,不再列举,请参考 [Changelog](https://github.com/cocos2d/cocos2d-x/blob/v3/CHANGELOG)
16+
- 修复 3.17 引入的 Lua 加载性能下降的 BUG
17+
- 减少渲染中 glClear 的调用次数,降低电量消耗
18+
- CMake 脚本优化,解决存在的链接问题
19+
- Android 默认启用 CMake 方式编译
20+
- Android 升级 Gradle 到 4.6, SDK 28, plugin 3.1.0
21+
- 升级 LuaJIT 到 2.1.0-beta3,修复 3.17 Lua 项目的闪退问题
22+
- 升级 libwebsockets 到 2.4.2
23+
- FileUtils 内部加锁,增加线程安全,完善接口实现
24+
- 限制 Label 长度,避免绘制错误
25+
- 增加 Downloader 的 Lua 绑定
8026

27+
当前版本包含 45 项 bugs 修复和 34 项小改进,不再列举,请参考 [ChangeLog](https://github.com/cocos2d/cocos2d-x/blob/v3/CHANGELOG)

0 commit comments

Comments
 (0)