sunguangdong / cocos-engine

Cocos Engine is an open-source framework for building 2D & 3D real-time rendering and interactive contents, especially video games, which can be deployed to mobile, desktop and web. It is inherited from the legacy Cocos2d-x with a redesigned modern architecture. To run this engine, please download Cocos Creator.

Engine for Cocos Creator

Cocos Engine is the framework for Cocos Creator editor. Cocos Creator is the new generation of game development tool in Cocos family, it brings a complete set of 3D features and provides an intuitive, low cost and collaboration friendly workflow to game developers.

Cocos Creator inherited many good qualities and cool features from its previous versions, such as cross-platform support including instant gaming platforms like WeChat mini game, asset management, powerful animation editing, etc. Furthermore, Cocos Creator has pushed our technology to a whole new level. Our GFX implementation is designed to adapt to the latest graphic backend APIs, it already supports WebGL 2 and can be seamlessly fall back to WebGL 1, it will support Vulkan and Metal in the native build. The material system is built on our own effect format which uses GLSL 300 and can be easily adapted to lower version on low end devices. Developers can produce high performance, extremely expressive shaders with good compatibility. Along with physical based camera and lighting, high level game graphic can be easily achieved. Our pure GPU driven skeleton animation also make sure your game runs as smooth as possible. Besides all these exciting features, Cocos Creator have builtin physics support, terrain editing support, visual effect editing, ui system, TypeScript support, instant preview etc.

This repo is the engine part of Cocos Creator, it's mainly written in TypeScript and support users to use TypeScript or ES6 to write game logics. The engine itself is mostly self-contained, with full-fledged runtime modules including lighting, material, particle, animation, physical, UI, terrain, sound, resource and scene-graph management, etc. It supports both native and web platforms, including Windows, Mac, iOS, Android, Web. What's more exciting is that it supports rapidly expanding instant gaming platforms like WeChat Mini Game and Facebook Instant Games.

The engine is naturally integrated within Cocos Creator, designed to only be the essential runtime library and not to be used independently.

Developer

Prerequisite

• Install node.js v9.11.2 +
• Install gulp-cli v2.3.0 +

Install

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

# download & build engine dependencies
npm install

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

Build

• If running inside Cocos Creator, the engine will automatically compile and build after the editor window is opened.

• Outside the editor, you need to run the following command to build:

  npm run build

Example Project

• Example Cases: Simple yet expressive demo scenes for baseline testing and topic-specific case study.
• Mind Your Step 3D: Beginner's step-by-step tutorial project repo.
• UI Demo: use cases for various kinds of UI components.
• Test Cases: Unit test scenes for every engine module.

Links

• Official site
• Download
• Documentation
• API References
• Forum
• Road Map: To be announced