The engine for Cocos Creator
Clone or download
Permalink
Failed to load latest commit information.
.circleci Fix unit test and circle ci (#2858) Jun 14, 2018
.github Update PULL_REQUEST_TEMPLATE.md Sep 17, 2018
.vscode remove unused code Dec 26, 2017
cocos2d Support switch 2D/3D edit mode (#3266) Sep 18, 2018
docs Improve docs & deprecation (#3053) Aug 8, 2018
editor add subContextVIew helpURL, en version (#3261) Sep 17, 2018
extensions fix spine display bug in mask (#3223) Sep 10, 2018
external Fix beta user reported issues (#3004) Jul 23, 2018
gulp fixed jsb modular (#3080) Aug 13, 2018
licenses updating license Feb 1, 2018
polyfill add IE11 support (#3050) Aug 8, 2018
test Support loading ttf with loader, adapt Label & RichText (#3170) Aug 31, 2018
.editorconfig add editorconfig file Sep 22, 2016
.eslintrc.json add eslint Jul 27, 2016
.gitignore reimplement debugInfos workflow Mar 26, 2018
.jshintrc Fix JSB issues Feb 3, 2016
AUTHORS.txt Modify README and some docs Mar 24, 2016
CHANGELOG.txt Fix typos Mar 10, 2018
EngineErrorMap.md Support loading ttf with loader, adapt Label & RichText (#3170) Aug 31, 2018
MAINTAINERS Integrate lgtm.co Aug 5, 2016
README.md Update README.md Sep 4, 2018
extends.js Merge remote-tracking branch 'refs/remotes/fireball/next' Apr 2, 2018
gulpfile.js remove jsb && jsb_polyfill (#2913) Jun 28, 2018
index.js add IE11 support (#3050) Aug 8, 2018
modules.json improve mesh usage (#3190) Sep 6, 2018
package.json Fix unit test and circle ci (#2858) Jun 14, 2018
predefine.js change CC_WECHATGAME_SUB to CC_WECHATGAMESUB (#3233) Sep 11, 2018

README.md

Cocos Creator Engine Framework

This repo is the engine framework for Cocos Creator, Cocos Creator is a game development tool focused on content creation, which has realized features like thorough scriptability, componentization and data driven, etc. on the basis of Cocos2d-x.

Cocos Creator's in-editor scene view and web runtime share the same framework, which is the content of this repo. It's originally forked from Cocos2d-html5, we build up an Entity Component architecture on it to meet the needs of Cocos Creator.

This framework is a cross-platform game engine written in Javascript and licensed under MIT. It supports major desktop and mobile browsers, it's also compatible with Cocos2d Javascript Binding engine to support native platforms like iOS, Android, Win32, Mac OS X.

The framework is naturally integrated with Cocos Creator, so it's not designed to be used independently.

Developer

Prerequisite

Install

In cloned project folder, run the following command to setup dev environment:

# Initialize gulp task dependencies
# npm is a builtin CLI when you install Node.js
npm install

This is all you have to do to set engine development environment.

Build

gulp build

Test

Prerequisite

  • Install express: npm install express
  • Install gulp-qunit: npm install gulp-qunit

Unit Test

Test in CLI
npm test
Test in browser
  1. Build for testing.

    gulp build-test
  2. Start express in cloned project folder.

    node test/qunit/server.js
    
  3. Open http://localhost:8511/bin/qunit-runner.html in your browser.

DebugInfos

View EngineErrorMap.md
All the debug infos are defined in file EngineErrorMap.md.
The file DebugInfos.json will be generated based on EngineErrorMap.md, when run gulp build* command.

For details below:

  1. Define log in EngineErrorMap.md

    example

    ### 1001  
      
    cocos2d: removeAction: Target not found
          
    
  2. Define deprecated log in EngineErrorMap.md The log should be marked as DEPRECATED when then logId is no longer referenced in the project.

    example

    ### 1000
      
    <!-- DEPRECATED -->
    cc.ActionManager.addAction(): action must be non-null  
    
    

Links