SUMMARY.md

Summary

Beginners Guide

Introduction

• Basic Usage
  • About Cocos Creator
  • Installing and Launching
  • Dashboard
  • Hello World!
  • Project Structure
  • Editor Panels
    • Scene
    • Hierarchy
    • Assets
    • Inspector
    • Console
    • Preferences
    • Project Settings
    • Main Menu
    • Tool Bar
    • Editor Layout
    • Preview & Debugging
  • Support
  • Caution!
• Quick Start: First Game
• Upgrade Guide
  • Cocos Creator 3.0 Upgrade Guide
  • Cocos Creator 3.0 Material Upgrade Guide
  • Cocos Creator 3.1 Material Upgrade Guide

Basic Workflow

• Scene Creation

  • Scene Assets
  • Nodes and Components
  • Coordinate Systems and Transformations
  • Node Hierarchy and Rendering Order
  • Build a Scene Image Using the Scene Panel

• Asset System

  • Asset Workflow
  • Images
    • Textures
    • Sprite Frames
      • Auto Trim for SpriteFrame
    • Texture Cube
    • Atlas
    • Auto Atlas
    • Label Atlas
  • Prefab
  • Fonts
  • Audio
  • Material
  • Model
    • Importing Models Exported from DCC Tools
    • glTF
  • Spine Skeletal Animation
  • DragonBones Skeletal Animation
  • TiledMap

• Scripting Guide and Event System

  • Programming Language Support
  • Scripting Basics
    • Script Creation
    • Coding Environment Setup
    • Operating Environment
    • Decorator
    • Property Attributes
    • Life Cycle Callbacks
  • Using Scripts
    • Access Nodes and Components
    • Common Node and Component Interfaces
    • Create and Destroy Nodes
    • Scheduler
    • Components and Component Execution Order
    • Loading and Switching Scenes
    • Obtaining and Loading Assets
    • tsconfig Configuration
  • Advanced Scripting
  • Events
    • Listening to and Launching Events
    • Input Event System
    • Node Event System
    • Event API
  • Modules
    • Engine Modules
    • External Module Usage Case
    • Module Specification
    • Import Maps
  • Plugin Scripts

• Cross-platform Game Publish

  • About the Build Panel
  • General Build Options
  • Publish to Web Platforms
  • Publish to Native Platforms
    • Publish for the Huawei HarmonyOS
    • Setup Native Development
    • Debugging JavaScript on Native Platforms
  • Publish to Mini Game Platforms
    • Publish to HUAWEI AppGallery Connect
    • Publish to Alipay Mini Game
    • Publish to ByteDance Mini Game
    • Publish to Cocos Play
    • Publish to Huawei Quick Game
    • Publish to OPPO Mini Game
    • Publish to vivo Mini Game
    • Publish to Xiaomi Quick Game
    • Publish to Baidu Mini Game
    • Publish to WeChat Mini Game
      • WeChat Engine Plugin
      • Access to the WeChat PC Mini Game
    • Access to Open Data Context
    • Mini Game Subpackage
  • Publish from the Command Line
  • Build Process with FAQ
  • Custom Project Build Process

Function Modules

• Graphics Rendering

  • Render Pipeline
    • Built-in Render Pipeline
  • Camera
  • Lighting
    • Physically Based Lighting
    • Lights
      • Directional Lights
      • Spherical Lights
      • Spotlights
      • Ambient Light
    • Additive Per-Pixel Lights
    • Shadows
    • Lightmapping
  • Meshes
    • MeshRenderer
  • Textures
    • Texture Compression
    • RenderTexture
  • Material System Overview
    • Programmatic Use of Materials
    • Builtin Materials
    • Material System Classes Diagram
  • Shader Overview
    • Effect Asset
    • Effect Syntax Guide
      • Optional Pass Parameters
      • YAML 101
      • Introduction to GLSL Syntax
      • Preprocessor Macro Definition
      • Effect Chunk
        • Built-in Shader Uniforms
    • Built-in Effect
      • Physically Based Rendering - PBR
      • Toon Shading
      • Unlit
    • Custom effect
      • 3D Effect：RimLight
      • 2D Sprite effect：Gradient
  • Effects
    • Billboard
    • Line
  • Skybox
  • Global Fog

• 2D Objects

  • 2D Render
    • Rendering Order
    • 2D Renderable Component Batching Rules
    • Custom Materials for 2D Rendering Objects
    • 2D Renderable Components
      • Sprite Component Reference
      • Label Component Reference
      • Mask Component Reference
      • Graphics Component Reference
      • RichText Component Reference
      • UIStaticBatch Component Reference
      • Spine Skeleton Component Reference
      • DragonBones ArmatureDisplay Component Reference
      • TiledMap Component Reference
      • TiledTile Component Reference
      • MotionStreak Component Reference
  • UI System
    • UI Components
      • Canvas Component Reference
      • UITransform Component Reference
      • Widget Component Reference
      • Button Component Reference
      • Layout Component Reference
      • EditBox Component Reference
      • ScrollView Component Reference
      • ScrollBar Component Reference
      • ProgressBar Component Reference
      • LabelOutline Component Reference
      • LabelShadow Component Reference
      • Toggle Component Reference
      • ToggleContainer Component Reference
      • Slider Component Reference
      • PageView Component Reference
      • PageViewIndicator Component Reference
      • UIMeshRenderer Component Reference
      • UICoordinateTracker Component Reference
      • UIOpacity Component Reference
      • BlockInputEvents Component Reference
      • WebView Component Reference
      • VideoPlayer Component Reference
      • SafeArea Component Reference
    • UI Practice Guide
      • Multi-Resolution Adaption
      • Widget Alignment
      • Label Layout
      • Auto Layout Container
      • Create a List of Dynamically Generated Content
      • Stretchable UI Sprite

• Animation

  • Animation Clip
  • Animation Component Reference
  • Animation Panel
    • Creating Animation Components and Animation Clips
    • Get Familiar with the Animation Panel
    • Editing Animation Clips
    • Editing Animation Easing Curve
    • Adding Animation Events
    • Using Animation Curves
  • Skeletal Animation
    • Joint Texture Layout Settings
  • Controlling Animation with Scripts
    • Animation State
  • Marionette Animation System
    • Animation Graph Assets
    • Animation Graph Panel
    • Animation State Machine
    • State Transition

• Audio System

  • AudioSource Component Reference
  • AudioSource Playback Example
  • Compatibility Notes

• Physics System

  • Physics 2D
    • 2D Physics Manager
    • 2D RigidBody
    • 2D Physics Collider
    • 2D Contact Callback
    • 2D Physics Joint
  • Physics 3D
    • Physics Engines
    • Physics System Configuration
    • Group and Mask
    • Physics Components
      • Collider
      • Rigidbody
      • Constant Force
      • Constraint
    • Physics Material
    • Physics Event
    • Raycast Detection
    • Continuous Collision Detection
    • Physics Application Cases

• Particle System

  • 2D Particle System
  • 3D Particle System
    • Particle System Module
      • Main Module
      • Shape Module
      • Velocity Overtime Module
      • Force Overtime Module
      • Size Overtime Module
      • Rotation Overtime Module
      • Color Over Life Time Module
      • Texture Animation Module
      • Limit Velocity Overtime Module
      • Trail Module
      • Renderer Module
    • Particle Properties Editor
      • Curve Editor
      • Gradient Editor
      • Particle Editor

• Tween System

  • Tween Interface
  • Tween Function
  • Tween Examples

• Terrain System

• Asset Manager

  • AssetManager Upgrade Guide
  • Asset Bundle Upgrade Guide
  • Asset Loading
  • Asset Bundle
  • Release Of Assets
  • Download and Parse
  • Loading and Preloading
  • Cache Manager
  • Optional Parameters
  • Pipeline and Task
  • Resource Management Considerations --- meta files

Advanced Tutorials

• Editor Extension
  • Extension Manager
  • Generating Extensions using Templates
  • First Extension
  • First Panel
  • First Data Interaction
  • Install and Share
  • Submitting Resources to Cocos Store
  • Extension Panel
    • Compose Panel
    • Panel Message
    • Communicate with the Panel
  • Contributions
    • Message
    • Shortcuts
    • Call the engine API and project script
    • Extending the Main Menu
    • Extending the Assets Panel
    • Extending the Assets Database
    • Extending the Project Settings Panel
    • Extending the Preferences Panel
    • Extend the Build Process
    • Extending Inspector Panel
  • Basic
    • Extension Description
    • Extension
    • Message
    • I18n
    • Profile
    • Editor UI
• Advanced Topics
  • Hot Update Tutorial
  • AssetManager for Hot Update
  • Dynamic Atlas
  • Engine Customization Workflow
  • Web Preview Customization Workflow
  • The Tutorial for JSB 2.0
  • JavaScript to Java Reflection
  • JavaScript to Objective-C Reflection
  • CMake Usage Introduction
  • Native engine memory leak detection system
  • Native Scene Culling
  • WebSocket Server