Cocos2d-JS Single File Engine User Guide

This guide is for the usage of single file engine of Cocos2d-JS which can be retrieved from the online downloader.

You may have downloaded one of these three versions:

• Full Version: Full Version engine contains all features and all extensions for Cocos2d-JS, it can help you explore its great possibility. You can refer to the feature list in Cocos2d-JS documentation page

• Cocos2d-JS Lite Version: Lite Version contains some core features of Cocos2d-JS, it's extremely easy to use and light as a feather. Its features are listing below:

  • Canvas renderer (No WebGL support)
  • Scene and Layers
  • Event Manager
  • Scheduler
  • Sprite and Texture2D
  • LabelTTF
  • Audio
  • Actions
  • Menu and MenuItems

• Customized Version: Customize your own version of Cocos2d-JS with the features you need, you should know the meaning of these features to construct a suitable version. All the features you chose will be included in the downloaded engine js file.

Usage

The usage have been demonstrated in the downloaded package, you can see the cocos2d-js-v3.0[-lite].js is embeded in the HelloWorld.html, after the window loading you will be able to use Cocos2d-JS API in your custom js code.

You need to host these files on a web server or local web server to see the result.

Useful links

• Online API reference
• Downloadable API Reference
• Document root
• Github repository
• Online forum
• Online test cases

About Closure Compiler

You can use Google Closure Compiler to compress all js files to a smaller size even if you downloaded the compressed version. Steps are showing below:

1. Download Closure Compiler's jar app
2. Configure the build.xml with your own configurations
3. Run ant in the terminal
4. Replace the embeded js files in HelloWorld.html with the single output file game.min.js

Please be noticed that you can not write any js code in your html file, all js codes should be compressed at the same time, otherwise errors will be triggered.

Notice

While openning the HelloWorld.html, you will receive an error: "Failed to load resource: the server responded with a status of 404 (Not Found)" for the file project.json

It's not a problem, you can simply igore it, or you can get rid of this error by creating an empty project.json file.

=========================

Cocos2d-JS单文件引擎使用指引

这篇指引主要介绍如何使用从在线下载工具下载下来的Cocos2d-JS的单文件引擎。

你有可能下载了下面三个版本中的一个：

• Full Version: 完整版引擎包含Cocos2d-JS引擎的所有功能特性以及所有扩展，使用这个版本可以帮助你发掘Cocos2d-JS令人惊艳的创造力和可能性。你可以从官方文档首页中查看Cocos2d-JS所支持的特性列表。

• Cocos2d-JS Lite Version: 精简版本只包含Cocos2d-JS的核心特性，它的优势是稳定，轻量，简单易用。它所包含的特性列表如下：

  • Canvas渲染器 (不支持WebGL)
  • 场景和图层
  • 事件管理器
  • 计时器
  • 精灵和贴图
  • TTF文本
  • 声音
  • 动作
  • 菜单和菜单项

• Customized Version: 如果你选择了定制版本的引擎，引擎脚本文件将包含你所选择的所有特性。

使用方式

单文件引擎的使用方式和其他Web库完全一样，你只需要将脚本嵌入到你的页面中即可，可以参考下载目录中的HelloWorld.html。在window的加载过程结束之后，你将可以在你的用户脚本中使用Cocos2d-JS的API。

你需要将这些文件放到一个本地服务器或在线服务器并通过服务器访问才可以看到正确的结果。

帮助链接

• 在线API reference
• 下载API Reference
• 文档目录
• Github仓库
• 在线论坛
• 在线测试例

关于脚本压缩

你可以使用Google Closure Compiler来将所有js文件压缩成一个文件，Closure Compiler的高级压缩压缩比非常高，即便你下载的是压缩版引擎，也可以获得可观的压缩比。具体压缩步骤如下：

1. 下载Closure Compiler的jar程序文件
2. 按照自己的环境配置build.xml
3. 在控制台运行ant命令
4. 将页面中的所有js引用删除，引入打包出的game.min.js

请注意，你不可以在html页面中写任何js脚本，所有js脚本都必须一起打包起来，否则会引起错误。

注意

当你通过服务器访问游戏页面的时候，你将在控制台中发现一个错误提示： "Failed to load resource: the server responded with a status of 404 (Not Found)"，提示project.json文件找不到

这是正常现象，并不是问题，你可以忽略它。或者可以添加一个空的project.json文件来避免这个错误报告。