About this project

Cocos Creator is a new-generation game development tool from the Cocos family, offering a complete set of 3D and 2D features with an intuitive, low-cost, and collaboration-friendly workflow. The Cocos Engine serves as the runtime framework for the Cocos Creator editor, designed to be an essential runtime library integrated within the editor. Key features include: - **Modern Graphics**: GFX implementation adapts to modern graphics APIs, using Vulkan on Windows/Android, Metal on macOS/iOS, and WebGL on web platforms. - **High Performance**: Built with half C++ and half TypeScript, with low-level infrastructure, native platform adaptation, renderer, and scene management in C++ for optimal runtime performance. - **Customizable Render Pipeline**: Fully customizable render pipeline supporting built-in forward and deferred pipelines across all platforms. - **Extensible Surface Shader**: Material system based on Cocos effect format using GLSL 300, with automatic shader conversion and customizable surface materials. - **Physically Based Rendering (PBR)**: Standard effects use PBR with physically based camera and lighting for realistic rendering. - **Easy TypeScript API**: User-level APIs in TypeScript, enhancing development efficiency with VSCode support. Additional built-in systems include animation, physics, particle effects, terrain editing, complex UI, and instant preview. Supported platforms: Windows, Mac, iOS, Android, HarmonyOS, Web, Facebook Instant Games, WeChat Mini Game, and TikTok Mini Games. This open-source repository is the runtime engine for Cocos Creator, not intended for standalone use. For development, fork the repository and set up a custom engine in the editor. Prerequisites include Node.js v9.11.2+ and gulp-cli v2.3.0+. Setup involves cloning, running `npm install`, and building with `npm run build` (or automatically within the editor). Contributions are welcome via issue reporting, discussions, pull requests, documentation improvements, and community support. Contribution guidelines include following coding style guides, integrating ESLint and C++ auto-fix tools, linking related issues, passing CI tests, and obtaining approval from engine architects. Example projects include Mind Your Step 3D (beginner tutorial), Test Cases (unit tests), Example Cases (demo scenes), and Awesome Cocos (curated tools and showcases).