Merge pull request #1568 from pandamicro/develop

Add release docs for v3.4 beta0

Author: pandamicro

CHANGELOG

@@ -1,5 +1,72 @@
 ChangeLog:
 
+Cocos2d-JS v3.4 Beta0 @ March 19 2015
+
+* Added Windows Phone 8.0 platform support.
+* Upgraded SpiderMonkey to v33, greatly improved JS object garbage collection and performance.
+* Bound 3D modules including camera, light, sprite 3d, animation 3d, billboard, etc.
+* Improved `cc.FontDefinition` & `ccui.RichText` in the web engine.
+* Added gradient stops feature to `cc.LayerGradient` [Web exclusive].
+* Upgraded `cc.Scheduler` in the web engine with Cocos2d-x v3.4 implementation.
+* Added a loading screen when scripts are loading.
+* Improved performance by replacing `Object.defineProperties` with `cc.defineGetterSetter`.
+* Supported loading sprite frames from json object.
+* Refactored math library to improve web engine performance.
+* Removed some variables from `cc` namespace to improve web engine performance.
+* Added the Firefox OS Web manifest to support Firefox OS apps.
+* Added `cocos` attr to the script element in templates.
+* Moved loading.js to res folder for Cocos Console release mode.
+* [JSB] Defined properties for TextureData.
+* [JSB] Upgrade auto and manual bindings to SpiderMonkey v33.
+* [JSB] Added 3D object conversions.
+* [JSB] Added full featured 3D test cases including: camera, light, sprite 3d, animation 3d, billboard, effect.
+* [JSB] Improved auto and manual bindings rooting code for creating objects.
+* [JSB] Added 3d transform getter functions to `cc.Node`.
+* [JSB] Added some useful callbacks to XMLHttpRequest.
+
+* Bug fixes:
+    1. Added `getSpriteFrame` to `cc.Sprite` to fix API inconsistency.
+    2. Added `getObejct` to `cc.TMXObjectGroup` to fix API inconsistency.
+    3. Added `addImageAsync` to `cc.textureCache` to fix API inconsistency.
+    4. Fixed a bug of `cc.text` that its default font name is incorrect. 
+    5. Fixed a bug of `ccui.PageView` that its `getPage` doesn't work.
+    6. Fixed a bug of `ccui.ImageView` that its `loadTexture` doesn't work while it's invoked multiple times at the same frame.
+    7. Fixed a bug of `ccui` that its load event callbacks have some mistakes.
+    8. Fixed a bug of `cc.Layer` that its bake function doesn't work when the layer has a parent node.
+    9. Fixed typos in `cc.ClippingNode.WebGLRenderCmd` and `cc.ParticleSystem.WebGLRenderCmd` creation.
+    10. Fixed a bug of `cc.Sprite` in `setTextureRect`. 
+    11. Fixed a bug of `cc.Screen`.
+    12. Fixed a bug of `cc.view` that it doesn't work on iOS 8.1.2.
+    13. Fixed a bug of cc.DrawNode that its lineWidth is always to default value when set linewidth to zero. 
+    14. Fixed a bug in hack for particles performance on canvas. 
+    15. Fixed a bug of `cc.audioEngine` that it doesn't work after minified/compiled.
+    16. Fixed a bug in `CCBoot.js` that WebGL is not activated in web view of iOS 8. 
+    17. Fixed a bug of `cc.CheckBox` that its position is incorrect when its texture isn't preloaded.
+    18. Fixed a bug of `cc.TMXLayer` that it stops to work after `setTileGID` called.
+    19. Fixed a bug of Cocos parser 2.x that it doesn't set widget's LayoutComponent.
+    20. Fixed a bug of `cc.isObject` that it considered function as an object.
+    21. [JSB] Fixed runScript error on win32 platform.
+    22. [JSB] Fixed issues of generated binding codes for spine and ccs.
+    23. [JSB] Fixed char16_t redefinition issue for wp8.
+    24. [JSB] Fixed an issue that string value with line break characters will cause cc.plistParser fail to parse.
+    25. [JSB] Refactored `cc.textureCache.addImageAsync` to support fully asynchronoused remote image loading.
+    26. [JSB] Fixed an issue of `GLProgramState::setVertexAttribPointer` function binding.
+    27. [JSB] Fixed a bug in `GLProgram`'s constructor.
+    28. [JSB] Fixed http response header parsing issue.
+    29. [JSB] Fixed jsc file check issue on windows.
+    30. [JSB] Fixed `jsval_to_long_long` conversion issue.
+    31. [JSB] Fixed `strtoll` undefined error in visual studio.
+    32. [JSB] Fixed an issue that `cc.MenuItem`'s `setCallback` function invoked with wrong this object.
+    33. [JSB] Fixed parameter issue for constructor of `cc.MenuItemImage`.
+    34. [JSB] Fixed `ccs.Armature`'s `setBlendFunc` parameter inconsistency issue.
+    35. [JSB] Fixed `JSStringWrapper` issue on windows platform.
+    36. [JSB] Fixed a chinese character issue on WP8.
+    37. [JSB] Fixed new object failed issue on windows.
+    38. [JSB] Fixed an issue that `cc.Label.createWithTTF` is undefined.
+    39. [JSB] Fixed audio loader absent issue.
+    40. [JSB] Fixed a test case issue of native feature usage.
+    
+
 Cocos2d-JS v3.3 @ Feb.9, 2015
 
 * Upgraded spine runtime to support the latest version and updated its test case.

docs/gradient-color-stop.jpg

@@ -0,0 +1,66 @@
+# Cocos2d-JS v3.4 Beta0 release note
+
+<img src="http://files.cocos2d-x.org/images/orgsite/logo.png" height=180> 
+
+Cocos2d-JS is Cocos2d-x engine's JavaScript version that includes Cocos2d-html5 and Cocos2d-x JavaScript Bindings. It equips your game with cross-browser and cross-platform abilities, accompanied by full Cocos2d-x features and simplified JavaScript friendly APIs.
+
+Cocos2d-JS reinvented workflows for all platforms in v3.x, it provides a consistent development experience for whichever platform you want to distribute to, no matter web and native. "Code once, run everywhere" is incredibly easy and natural in Cocos2d-JS. With one single JavaScript code base, you can run your game on all web browsers and native platforms including Mac OS, Windows, iOS and Android. This will bring your game great opportunities in almost all channels of distribution. On the other hand, if you are only interested in casual games on the web, you can embed directly in your web page the Cocos2d-JS Lite Version which is extremely easy to use and light as a feather.
+
+In addition, Cocos2d-JS v3.x is super powerful along with all these cool new features: Editors Support, Assets Manager, Object Pool, JS to Objective-C/JAVA reflection, etc.
+
+One more thing, Facebook Integration for Cocos2d-JS have brought a huge opportunity for game developers who want to integrate Facebook functionality into their games. With a single code base, they can release fully cross-platform games across Facebook Canvas, iOS and Android.
+
+## Highlights
+
+* 3D feature ready! Bound 3D modules including camera, light, sprite 3d, animation 3d, billboard, etc.
+* Windows Phone 8.0 platform support is finally ready! Thanks to the contribution from Microsoft.
+* Upgraded SpiderMonkey to v33, greatly improved JavaScript memory management and performance.
+* Continuously improved web engine performance.
+
+## Notice
+
+For JSB build, there are some restrictions :
+
+- [Android build] Suggested NDK version is r10c, if you don't need Android 5.0 compatibility, you can also use r9d, other NDKs are not supported.
+- [iOS build] Xcode version must be 5.1.1 +
+- [Web code obfuscation] JRE or JDK version must be 1.6+
+
+## Download
+
+- [Cocos2d-JS v3.4 Beta0](http://www.cocos2d-x.org/filedown/cocos2d-js-v3.4-beta0.zip)
+- [Cocos2d-JS Lite Version](http://cocos2d-x.org/filecenter/jsbuilder/)
+- [Cocos Dev Tool](http://h5.cocos.com/static/cocos-devtools/index-en.html)
+- [Online API reference](http://www.cocos2d-x.org/wiki/reference/)
+- [Downloadable API Reference](http://www.cocos2d-x.org/filedown/Cocos2d-JS-v3.3-API.zip)
+- [Online test cases](http://cocos2d-x.org/js-tests/)
+
+## More information
+
+Read more about all the features and bug fixes
+
+- [Cocos2d-JS v3.4 Beta0 changelog](http://www.cocos2d-x.org/docs/manual/framework/html5/release-notes/v3.4b/changelog/en)
+- [Cocos2d-JS v3.4 Beta0 upgrade guide](http://www.cocos2d-x.org/docs/manual/framework/html5/release-notes/v3.4/upgrade-guide/en)
+
+## Upgrade your project from previous versions
+
+If you want to upgrade your game based on v3.0 previous version to the v3.4, you should follow these steps:
+
+1. Download the Cocos2d-JS v3.4 package.
+2. Upgrade cocos command with `setup.py`.
+3. Create a new project with `cocos new` command.
+4. Replace the "src", "res", "index.html", "project.json", "main.js" etc with your old project.
+5. Then you may need to refer to the upgrade guide to solve some API change issues.
+
+## About Cocos2d family
+
+- Cocos2d-JS v3.4 uses Cocos2d-x v3.4 as base of JSB solution.
+- Cocos2d-JS v3.4 uses SpiderMonkey v33 as builtin JavaScript engine.
+- Cocos2d-JS v3.4 is compatible with Cocos Code IDE v1.1.0, but you need to rebuild the runtime with source code.
+- Cocos2d-JS v3.4 is compatible with Cocos Studio v1.2 - v1.6 and Cocos Studio 2.1+. Cocos Studio 2.x support need JSON export file, and Cocos2d-JS won't support flatbuffer files.
+
+With any problems you might have, our communities are happy to help:
+
+- [Online forum](http://discuss.cocos2d-x.org/category/cocos2d-x/javascript)
+- [Document root](http://cocos2d-x.org/wiki/Cocos2d-JS)
+- [Github repository](https://github.com/cocos2d/cocos2d-js)
+- [Issue tracker](https://github.com/cocos2d/cocos2d-js/issues)

docs/release-note-v3.4.md

@@ -0,0 +1,71 @@
+#Upgrade guide from Cocos2d-JS v3.3 to Cocos2d-JS v3.4
+
+## 0. Upgrade to Cocos2d-JS v3.3
+
+If you are still using Cocos2d-html5 or previous version of Cocos2d-JS, you may need to read the previous upgrade guides first : [Historic upgrade guides](../../en.md)
+
+## 1. Pulish to Windows Phone 8 (Windows Phone 8.1 is not supported yet)
+
+Follow these steps can help you upgrade to v3.4, then create a project and at last working for Windows Phone 8.
+
+1. You need to upgrade cocos console with the `setup.py` in Cocos2d-JS v3.4 package:
+
+    ```
+    $ cd cocos2d-js-v3.4
+    $ ./setup.py
+    ```
+    
+2. Create a Cocos2d-JS v3.4 project:
+
+    ```
+    $ cocos new -l js WinPhone8Game
+    ```
+    
+3. Open the Windows Phone 8 project in `WinPhone8Game/frameworks/runtime-src/proj.wp8-xaml/WinPhone8Game.sln`. Note that you need Visual Studio 2012 to open it.
+
+4. Now you can start to compile or publish the Cocos2d-JS project for Windows Phone 8.
+
+## 2. [Native Exclusive] Create 3D games
+
+The biggest feature in Cocos2d-JS v3.4 is the 3D modules. We have bound Cocos2d-x's 3D modules to JSB, so that you can now code 3D games using JavaScript. Please note that it's a native engine exclusive feature, you can not use 3D classes in the web engine. We are not planning to support 3D for the web in the near future.
+
+Sorry that we don't have a JavaScript document for 3D modules, we will add them as soon as possible.
+
+To know how to use the new 3D modules, please refer to the following documents:
+
+- Cocos [3d module's API reference](http://www.cocos2d-x.org/reference/native-cpp/V3.4/dir_0cec398151724e9e1c180a4e8f99801b.html)
+- Cocos [Camera API reference](http://www.cocos2d-x.org/reference/native-cpp/V3.4/d6/d2b/classcocos2d_1_1_camera.html)
+- Cocos [Light API reference](http://www.cocos2d-x.org/reference/native-cpp/V3.4/d2/d85/classcocos2d_1_1_base_light.html)
+- Test cases in the Cocos2d-JS v3.4 package, run it with projects in `build` folder or using `cocos run` command under `samples/js-tests` folder. You can refer to the following test cases:
+    - BillBoardTest: source code in `samples/js-tests/src/BillBoardTest`.
+    - Camera3DTest: source code in `samples/js-tests/src/Camera3DTest`.
+    - LightTest: source code in `samples/js-tests/src/LightTest`.
+    - Sprite3DTest: source code in `samples/js-tests/src/Sprite3DTest`.
+    
+## 3. [Web Exclusive] cc.LayerGradient with color stops
+
+In the web engine of Cocos2d-JS v3.4, you can now define color stops for a layer gradient. It's a web exclusive feature but it's safe to use the same code in native engine.
+
+API:
+
+```
+new cc.LayerGradient(beginColor, endColor, positionInPercent, colorStops);
+```
+
+Sample code:
+
+```
+// Color stops is represented by an array, where each entry is an object composed by positionInPercent and the color.
+var colorStops = [
+                    {p: 0.25, color: cc.color(0, 0, 255, 128)},
+                    {p: 0.5, color: cc.color(128, 128, 128, 128)},
+                    {p: 0.75, color: cc.color(255, 255, 0, 128)}
+                ];
+
+var gradient = new cc.LayerGradient(cc.color(255, 0, 0, 255), cc.color(0, 255, 0, 255), cc.p(0, 1), colorStops);
+this.addChild(gradient, 10);
+```
+
+Result:
+
+![](gradient-color-stop.jpg)

docs/upgrade-guide-from-3.3-to-3.4.md

@@ -1072,4 +1072,11 @@ var g_spine = [
     "res/skeletons/spineboy.atlas",
     "res/skeletons/spineboy.json",
     "res/skeletons/spineboy.png"
+];
+
+var g_ccs2 = [
+    "res/ActionTimeline/boy_1.csb",
+    "res/ActionTimeline/armature/Cowboy0.plist",
+    "res/cocosui/UIEditorTest/UILabelBMFont_Editor/GUI/missing-font.fnt",
+    "res/cocosui/UIEditorTest/UILabelBMFont_Editor/GUI/missing-font.png"
 ];