cc.config.json

{
    "$schema": "./cc.config.schema.json",

    "features": {
        "base": {
            "modules": ["base"],
            "dependentAssets": [
                "ff9be190-20a4-4e48-b68c-76e3c7cff085",
                "970b0598-bcb0-4714-91fb-2e81440dccd8",
                "bcd64cc6-2dd9-43f6-abbe-66318d332032",
                "d930590d-bb92-4cc8-8bd1-23cd027f9edf",
                "a3cd009f-0ab0-420d-9278-b9fdab939bbc",
                "9361fd90-ba52-4f84-aa93-6e878fd576ca"
            ]
        },
        "gfx-webgl": {
            "modules": ["gfx-webgl"]
        },
        "gfx-webgl2": {
            "modules": ["gfx-webgl2"]
        },
        "gfx-empty": {
            "modules": ["gfx-empty"]
        },
        "3d": {
            "modules": ["3d"],
            "dependentAssets": [
                "1baf0fc9-befa-459c-8bdd-af1a450a0319",
                "511d2633-09a7-4bdd-ac42-f778032124b3",
                "5d45aa00-e064-4938-b314-4265f0c2258c",
                "28d6d6b8-3f66-4a73-9795-17a0852ba2d4",
                "ec8106fe-05bf-4e94-943c-e0d3b7bb5e45",
                "620b6bf3-0369-4560-837f-2a2c00b73c26",
                "2df0a40b-26c2-47ce-be0d-4d3cd4164737"
            ]
        },
        "animation": {
            "modules": ["animation"]
        },
        "skeletal-animation": {
            "modules": ["animation", "skeletal-animation"]
        },
        "2d": {
            "modules": ["2d", "sorting"],
            "dependentAssets": [
                "60f7195c-ec2a-45eb-ba94-8955f60e81d0",
                "1c02ae6f-4492-4915-b8f8-7492a3b1e4cd",
                "810e96e4-e456-4468-9b59-f4e8f39732c0",
                "efe8e2a3-eace-427b-b4f1-cb8a937ec77d",
                "e9aa9a3e-5b2b-4ac7-a2c7-073de2b2b24f",
                "8bbdbcdd-5cd4-4100-b6d5-b7c9625b6107",
                "50f4348b-c883-4e2f-8f11-ce233b859fa1",
                "fda095cb-831d-4601-ad94-846013963de8",
                "f92806d7-1768-443f-afe8-12bcde84d0f0",
                "dd3a144d-ab7f-41f0-82b8-2e43a090d496",
                "f0416e68-0200-4b77-a926-4f9d16e494da"
            ]
        },
        "ui": {
            "modules": ["ui", "2d"]
        },
        "particle": {
            "modules": ["particle"],
            "dependentAssets": [
                "d1346436-ac96-4271-b863-1f4fdead95b0",
                "971bdb23-3ff6-43eb-b422-1c30165a3663",
                "17debcc3-0a6b-4b8a-b00b-dc58b885581e",
                "711ebe11-f673-4cd9-9a83-63c60ba54c5b",
                "c0143906-9aed-447e-9436-2ae8512d1b6e",
                "14da1725-c4c2-42b4-ab08-ee0aeb6898b3",
                "081cab31-dccd-428e-8652-f2404cc81c47",
                "78e0584a-4343-4727-8f37-e14e65c2a2db"
            ]
        },
        "particle-2d": {
            "modules": ["particle-2d"],
            "dependentModules": ["2d"]
        },
        "physics-framework": {
            "modules": ["physics-framework"]
        },
        "physics-cannon": {
            "modules": ["physics-cannon", "physics-framework"],
            "dependentAssets": ["ba21476f-2866-4f81-9c4d-6e359316e448"]
        },
        "physics-physx": {
            "modules": ["physics-physx", "physics-framework"],
            "dependentAssets": ["ba21476f-2866-4f81-9c4d-6e359316e448"]
        },
        "physics-ammo": {
            "modules": ["physics-ammo", "physics-framework", "wait-for-ammo-instantiation"],
            "dependentAssets": ["ba21476f-2866-4f81-9c4d-6e359316e448"]
        },
        "physics-builtin": {
            "modules": ["physics-builtin", "physics-framework"],
            "dependentAssets": ["ba21476f-2866-4f81-9c4d-6e359316e448"]
        },
        "physics-2d-framework": {
            "modules": ["physics-2d-framework"]
        },
        "physics-2d-box2d": {
            "modules": ["physics-2d-box2d", "physics-2d-framework"]
        },
        "physics-2d-builtin": {
            "modules": ["physics-2d-builtin", "physics-2d-framework"]
        },
        "intersection-2d": {
            "modules": ["intersection-2d"]
        },
        "primitive": {
            "modules": ["primitive"]
        },
        "profiler": {
            "modules": ["profiler"],
            "dependentAssets": ["871c3b6c-7379-419d-bda3-794b239ab90d"]
        },
        "occlusion-query": {
            "modules": [],
            "dependentAssets": ["d9937e59-61fe-4ec6-92ab-7ac5a19c89b0"]
        },
        "geometry-renderer": {
            "modules": ["geometry-renderer"],
            "dependentAssets": ["4bb480dd-8384-4bc9-987f-de67cc53052a"]
        },
        "debug-renderer": {
            "modules": [],
            "dependentAssets": [
                "0835f102-5471-47a3-9a76-01c07ac9cdb2",
                "b5475517-23b9-4873-bc1a-968d96616081",
                "0ed97c56-390e-4dd1-96b7-e7f2d93a98ed",
                "b23391b6-52eb-46a6-8da1-6244d9d315fb"
            ]
        },
        "audio": {
            "modules": ["audio"]
        },
        "video": {
            "modules": ["video"]
        },
        "xr": {
            "modules": ["xr"]
        },
        "light-probe": { 
            "modules": [ "light-probe" ] 
        },
        "terrain": {
            "modules": ["terrain"],
            "dependentAssets": ["1d08ef62-a503-4ce2-8b9a-46c90873f7d3"]
        },
        "webview": {
            "modules": ["webview"]
        },
        "tween": {
            "modules": ["tween"]
        },
        "tiled-map": {
            "modules": ["tiled-map"],
            "dependentModules": ["2d"]
        },
        "spine": {
            "modules": ["spine"],
            "dependentAssets": [
                "c27215d8-6835-4b68-bfbb-bdeac6100c04",
                "b5d6115f-0370-4d7c-aad3-c194cc71cf98"
            ],
            "dependentModules": ["2d"]
        },
        "dragon-bones": {
            "modules": ["dragon-bones"],
            "dependentAssets":[ 
                "c27215d8-6835-4b68-bfbb-bdeac6100c04",
                "b5d6115f-0370-4d7c-aad3-c194cc71cf98"
            ],
            "dependentModules": ["2d"]
        },
        "marionette": {
            "modules": [],
            "intrinsicFlags": {
                "MARIONETTE": true
            }
        },
        "custom-pipeline": {
            "modules": ["custom-pipeline"]
        },
        "websocket": {
            "modules": [],
            "isNativeOnly": true
        },
        "websocket-server": {
            "modules": [],
            "isNativeOnly": true
        }
    },
    "moduleOverrides": [{
            "test": "true",
            "isVirtualModule": true,
            "overrides": {
                "internal:native": "cocos/native-binding/impl.ts"
            }
        },
        {
            "test": "context.mode === 'BUILD'",
            "isVirtualModule": false,
            "overrides": {}
        },
        {
            "test": "context.platform !== 'NATIVE'",
            "isVirtualModule": false,
            "overrides": {
                "cocos/2d/renderer/native-2d.ts": "cocos/2d/renderer/native-2d-empty.ts"
            }
        },
        {
            "test": "context.platform === 'NATIVE'",
            "isVirtualModule": false,
            "overrides": {
                "cocos/rendering/index.ts": "cocos/rendering/index.jsb.ts",
                "cocos/rendering/render-pipeline.ts": "cocos/rendering/render-pipeline.jsb.ts",
                "cocos/rendering/geometry-renderer.ts": "cocos/rendering/geometry-renderer.jsb.ts",
                "cocos/rendering/custom/index.ts": "cocos/rendering/custom/index.jsb.ts",
                "cocos/render-scene/core/native-pools.ts": "cocos/render-scene/core/native-pools.jsb.ts",
                "cocos/render-scene/core/material-instance.ts": "cocos/render-scene/core/material-instance.jsb.ts",
                "cocos/render-scene/core/pass.ts": "cocos/render-scene/core/pass.jsb.ts",
                "cocos/render-scene/core/program-lib.ts": "cocos/render-scene/core/program-lib.jsb.ts",
                "cocos/render-scene/core/render-window.ts": "cocos/render-scene/core/render-window.jsb.ts",
                "cocos/render-scene/core/sampler-lib.ts": "cocos/render-scene/core/sampler.jsb.ts",
                "cocos/render-scene/scene/camera.ts": "cocos/render-scene/scene/camera.jsb.ts",
                "cocos/render-scene/scene/model.ts": "cocos/render-scene/scene/model.jsb.ts",
                "cocos/render-scene/core/render-scene.ts": "cocos/render-scene/core/render-scene.jsb.ts",
                "cocos/render-scene/scene/submodel.ts": "cocos/render-scene/scene/submodel.jsb.ts",
                "cocos/render-scene/scene/index.ts": "cocos/render-scene/scene/index.jsb.ts",
                "cocos/render-scene/scene/reflection-probe.ts": "cocos/render-scene/scene/reflection-probe.jsb.ts",
                "cocos/2d/renderer/native-2d.ts": "cocos/2d/renderer/native-2d.jsb.ts",
                "cocos/gfx/base/pipeline-state.ts": "cocos/gfx/base/pipeline-state.jsb.ts",
                "cocos/gfx/index.ts": "cocos/gfx/index.jsb.ts",
                "cocos/spine/index.ts": "cocos/spine/index.jsb.ts",
                "cocos/dragon-bones/index.ts": "cocos/dragon-bones/index.jsb.ts",
                "cocos/physics/physx/instantiate.ts": "cocos/physics/physx/instantiate.jsb.ts",
                "cocos/scene-graph/node.ts": "cocos/scene-graph/node.jsb.ts",
                "cocos/scene-graph/scene.ts": "cocos/scene-graph/scene.jsb.ts",
                "cocos/scene-graph/scene-globals.ts": "cocos/scene-graph/scene-globals.jsb.ts",
                "cocos/scene-graph/index.ts": "cocos/scene-graph/index.jsb.ts",
                "cocos/root.ts": "cocos/root.jsb.ts",
                "cocos/asset/asset-manager/builtin-res-mgr.ts": "cocos/asset/asset-manager/builtin-res-mgr.jsb.ts",
                "cocos/asset/assets/index.ts": "cocos/asset/assets/index.jsb.ts",
                "cocos/asset/assets/asset.ts": "cocos/asset/assets/asset.jsb.ts",
                "cocos/asset/assets/buffer-asset.ts": "cocos/asset/assets/buffer-asset.jsb.ts",
                "cocos/asset/assets/render-texture.ts": "cocos/asset/assets/render-texture.jsb.ts",
                "cocos/asset/assets/simple-texture.ts": "cocos/asset/assets/simple-texture.jsb.ts",
                "cocos/asset/assets/scene-asset.ts": "cocos/asset/assets/scene-asset.jsb.ts",
                "cocos/asset/assets/effect-asset.ts": "cocos/asset/assets/effect-asset.jsb.ts",
                "cocos/asset/assets/image-asset.ts": "cocos/asset/assets/image-asset.jsb.ts",
                "cocos/asset/assets/texture-base.ts": "cocos/asset/assets/texture-base.jsb.ts",
                "cocos/asset/assets/texture-asset.ts": "cocos/asset/assets/texture-asset.jsb.ts",
                "cocos/asset/assets/texture-2d.ts": "cocos/asset/assets/texture-2d.jsb.ts",
                "cocos/asset/assets/texture-cube.ts": "cocos/asset/assets/texture-cube.jsb.ts",
                "cocos/asset/assets/material.ts": "cocos/asset/assets/material.jsb.ts",
                "cocos/asset/assets/rendering-sub-mesh.ts": "cocos/asset/assets/rendering-sub-mesh.jsb.ts",
                "cocos/3d/assets/mesh.ts": "cocos/3d/assets/mesh.jsb.ts",
                "cocos/3d/assets/skeleton.ts": "cocos/3d/assets/skeleton.jsb.ts",
                "cocos/3d/models/morph-model.ts": "cocos/3d/models/morph-model.jsb.ts",
                "cocos/3d/models/skinning-model.ts": "cocos/3d/models/skinning-model.jsb.ts",
                "cocos/3d/models/baked-skinning-model.ts": "cocos/3d/models/baked-skinning-model.jsb.ts",
                "cocos/3d/misc/create-mesh.ts": "cocos/3d/misc/create-mesh.jsb.ts",
                "cocos/gi/light-probe/light-probe.ts": "cocos/gi/light-probe/light-probe.jsb.ts",
                "cocos/gi/light-probe/delaunay.ts": "cocos/gi/light-probe/delaunay.jsb.ts"
            }
        },
        {
            "test": "context.buildTimeConstants && context.buildTimeConstants.WEBGPU",
            "isVirtualModule": false,
            "overrides": {
                "cocos/gfx/index.ts": "cocos/gfx/index.ems.ts"
            }
        },
        {
            "test": "context.buildTimeConstants && context.buildTimeConstants.HTML5",
            "isVirtualModule": true,
            "overrides": {
                "pal/minigame": "pal/minigame/non-minigame.ts",
                "pal/audio": "pal/audio/web/player.ts",
                "pal/system-info": "pal/system-info/web/system-info.ts",
                "pal/screen-adapter": "pal/screen-adapter/web/screen-adapter.ts",
                "pal/input": "pal/input/web/index.ts",
                "pal/env": "pal/env/web/env.ts",
                "pal/pacer": "pal/pacer/pacer-web.ts"
            }
        },
        {
            "test": "context.buildTimeConstants && context.buildTimeConstants.NATIVE",
            "isVirtualModule": true,
            "overrides": {
                "pal/minigame": "pal/minigame/non-minigame.ts",
                "pal/audio": "pal/audio/native/player.ts",
                "pal/system-info": "pal/system-info/native/system-info.ts",
                "pal/screen-adapter": "pal/screen-adapter/native/screen-adapter.ts",
                "pal/input": "pal/input/native/index.ts",
                "pal/env": "pal/env/native/env.ts",
                "pal/pacer": "pal/pacer/pacer-native.ts"
            }
        },
        {
            "test": "context.buildTimeConstants && context.buildTimeConstants.MINIGAME",
            "isVirtualModule": true,
            "overrides": {
                "pal/minigame": "pal/minigame/{{context.platform.toLowerCase()}}.ts",
                "pal/audio": "pal/audio/minigame/player.ts",
                "pal/system-info": "pal/system-info/minigame/system-info.ts",
                "pal/screen-adapter": "pal/screen-adapter/minigame/screen-adapter.ts",
                "pal/input": "pal/input/minigame/index.ts",
                "pal/env": "pal/env/minigame/env.ts",
                "pal/pacer": "pal/pacer/pacer-minigame.ts"
            }
        },
        {
            "test": "context.buildTimeConstants && context.buildTimeConstants.RUNTIME_BASED",
            "isVirtualModule": true,
            "overrides": {
                "pal/minigame": "pal/minigame/runtime.ts",
                "pal/audio": "pal/audio/minigame/player.ts",
                "pal/system-info": "pal/system-info/minigame/system-info.ts",
                "pal/screen-adapter": "pal/screen-adapter/minigame/screen-adapter.ts",
                "pal/input": "pal/input/minigame/index.ts",
                "pal/env": "pal/env/runtime/env.ts",
                "pal/pacer": "pal/pacer/pacer-minigame.ts"
            }
        },
        {
            "test": "context.buildTimeConstants && context.buildTimeConstants.NOT_PACK_PHYSX_LIBS",
            "isVirtualModule": false,
            "overrides": {
                "cocos/physics/physx/physx.asmjs.ts": "cocos/physics/physx/physx.null.ts"
            }
        },
        {
            "test": "!context.buildTimeConstants.MARIONETTE",
            "isVirtualModule": false,
            "overrides": {
                "cocos/animation/marionette/runtime-exports.ts": "cocos/animation/marionette/index-empty.ts"
            }
        }
    ],
    "includes": [
        "./exports/**/*.{ts,js,json}",
        "./editor/exports/**/*.{ts,js,json}",
        "./cocos/**/*.{ts,js,json}",
        "./pal/**/*.{ts,js,json}"
    ],

    "constants": {
        "HTML5": {
            "comment": "Running in Web platform",
            "type": "boolean",
            "value": false,
            "internal": false,
            "dynamic": true
        },
        "NATIVE": {
            "comment": "Running in native platform (mobile app, desktop app, or simulator).",
            "type": "boolean",
            "value": false,
            "internal": false,
            "dynamic": true
        },
        "WECHAT": {
            "comment": "Running in the Wechat's mini game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "BAIDU": {
            "comment": "Running in the baidu's mini game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "XIAOMI": {
            "comment": "Running in the xiaomi's quick game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "ALIPAY": {
            "comment": "Running in the alipay's mini game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "BYTEDANCE": {
            "comment": "Running in the ByteDance's mini game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "OPPO": {
            "comment": "Running in the oppo's quick game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "VIVO": {
            "comment": "Running in the vivo's quick game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "HUAWEI": {
            "comment": "Running in the huawei's quick game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "COCOSPLAY": {
            "comment": "Running in the cocosplay.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "QTT": {
            "comment": "Running in the qtt's quick game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "LINKSURE": {
            "comment": "Running in the linksure's quick game.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },

        "EDITOR": {
            "comment": "Running in the editor.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false,
            "dynamic": true
        },
        "PREVIEW": {
            "comment": "Preview in browser or simulator.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false,
            "dynamic": true
        },
        "BUILD": {
            "comment": "Running in published project.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false
        },
        "TEST": {
            "comment": "Running in the engine's unit test.",
            "type": "boolean",
            "value": false,
            "ccGlobal": true,
            "internal": false,
            "dynamic": true
        },


        "DEBUG": {
            "comment": "Running debug mode.",
            "type": "boolean",
            "value": true,
            "ccGlobal": true,
            "internal": false
        },
        "SERVER_MODE": {
            "comment": "Running in the server mode.",
            "type": "boolean",
            "value": false,
            "internal": true
        },


        "DEV": {
            "comment": "Running in the editor or preview.",
            "type": "boolean",
            "value": "$EDITOR || $PREVIEW || $TEST",
            "ccGlobal": true,
            "internal": false,
            "dynamic": true
        },
        "MINIGAME": {
            "comment": "Running in mini game.",
            "type": "boolean",
            "value": "$WECHAT || $BAIDU || $XIAOMI || $ALIPAY || $BYTEDANCE",
            "ccGlobal": true,
            "internal": false
        },
        "RUNTIME_BASED": {
            "comment": "Running in runtime based environment.",
            "type": "boolean",
            "value": "$OPPO || $VIVO || $HUAWEI || $COCOSPLAY || $QTT || $LINKSURE",
            "ccGlobal": true,
            "internal": false
        },
        "SUPPORT_JIT": {
            "comment": "Support JIT.",
            "type": "boolean",
            "value": "!(($PREVIEW && !$NATIVE) || $MINIGAME || $RUNTIME_BASED)",
            "ccGlobal": true,
            "internal": false
        },
        "JSB": {
            "comment": "Running in environment where using JSB as the JavaScript interface binding scheme.",
            "type": "boolean",
            "value": "$NATIVE",
            "ccGlobal": true,
            "internal": false,
            "dynamic": true
        },
        "NOT_PACK_PHYSX_LIBS": {
            "comment": "This is an internal constant to determine whether pack physx libs.",
            "type": "boolean",
            "value": false,
            "internal": true
        },
        "NET_MODE": {
            "comment": "The network access mode.\n- 0 Client\n- 1 ListenServer\n- 2 HostServer",
            "type": "number",
            "value": 0,
            "internal": false
        },
        "WEBGPU": {
            "comment": "Running with webgpu rendering backend.",
            "type": "boolean",
            "value": false,
            "internal": true
        }
    },

    "optimizeDecorators": {
        "fieldDecorators": [
            "property", "serializable", "formerlySerializedAs", "editorOnly", "uniquelyReferenced",
            "type", "override", "executeInEditMode", "menu", "playOnFocus", "inspector", "icon", "help",
            "editable", "visible", "readOnly", "displayName", "tooltip", "group", "range", "rangeMin",
            "rangeMax", "rangeStep", "slide", "displayOrder", "unit", "radian", "multiline", "disallowAnimation",
            "requireComponent", "executionOrder", "disallowMultiple", "allowReplicated", "ccclass"
        ],
        
        "editorDecorators": [
            "executeInEditMode", "menu", "playOnFocus", "inspector", "icon", "help", "editable", "visible",
            "readOnly", "displayName", "tooltip", "group", "range", "rangeMin", "rangeMax", "rangeStep", "slide",
            "displayOrder", "unit", "radian", "multiline", "disallowAnimation"
        ]
    }
}