Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

13.9 KB
Raw Blame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
import path from 'path';
import { fileURLToPath } from 'url';

const __dirname = path.dirname(fileURLToPath(import.meta.url));

export default {
    paths: {
        root: path.resolve(__dirname, '..'),
        output: path.resolve(__dirname, '../build'),
        cache: path.resolve(__dirname, '../build/.cache'),
        desktop: path.resolve(__dirname, '../desktop/public'),
        sdk: path.resolve(__dirname, '../sdk'),
    },

    optimization: {
        web: { cmakeOpt: '-O2', wasmOpt: '-O2' },
        'web-js': { cmakeOpt: '-O2', wasmOpt: '-O2' },
        wechat: { cmakeOpt: '-O2', wasmOpt: '-O2' },
        'wechat-glx': { cmakeOpt: '-O2', wasmOpt: '-O2' },
        'wechat-lite': { cmakeOpt: '-O2', wasmOpt: '-O2' },
        quickgame: { cmakeOpt: '-O2', wasmOpt: '-O2' },
    },

    wasm: {
        web: {
            buildDir: 'build/cmake/web',
            // WebGPU backend ships in the web SDK only — WeChat/playable have no
            // WebGPU and skip the emdawnwebgpu glue. Variants sharing build/cmake/web
            // (spine*) must carry identical flags or configures would thrash.
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_WEBGPU=ON'],
            targets: ['esengine_sdk'],
            outputs: {
                'sdk/esengine.js': 'wasm/web/esengine.js',
                'sdk/esengine.wasm': 'wasm/web/esengine.wasm',
            },
        },
        // The same engine as plain JavaScript (wasm2js), for a host with no
        // WebAssembly: an exported web page loads it only when `WebAssembly` is
        // absent (gameHost). No SIMD, no BigInt, no WebGPU — a host without wasm
        // has none of the three.
        'web-js': {
            buildDir: 'build/cmake/web-js',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_WASM2JS=ON',
                '-DES_MAIN_DISABLE_SIMD=ON'],
            targets: ['esengine_sdk'],
            // Beside the wasm engine, so the editor's copy and every web export
            // carry both and the page picks at boot.
            outputs: {
                'sdk/esengine.js': 'wasm/web/esengine.asm.js',
            },
        },
        wechat: {
            buildDir: 'build/cmake/wxgame',
            cmakeFlags: ['-DES_BUILD_WXGAME=ON', '-DES_BUILD_TESTS=OFF'],
            targets: ['esengine_wxgame'],
            outputs: {
                'sdk/esengine.wxgame.js': 'wasm/wechat/esengine.wxgame.js',
                'sdk/esengine.wxgame.wasm': 'wasm/wechat/esengine.wxgame.wasm',
            },
        },
        // The WeChat engine without the particle, post-process and tilemap subsystems, for a package whose content uses none
        // of them: the same binary otherwise, ~200 KB smaller against a 4 MB main package. The export picks it from the same
        // evidence it picks the engine's lean entry by (pipeline/src/export/liteEngine.ts).
        'wechat-lite': {
            buildDir: 'build/cmake/wxgame-lite',
            cmakeFlags: ['-DES_BUILD_WXGAME=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_PARTICLES=OFF',
                '-DES_ENABLE_POSTPROCESS=OFF', '-DES_ENABLE_TILEMAP=OFF'],
            targets: ['esengine_wxgame'],
            outputs: {
                'sdk/esengine.wxgame.js': 'wasm/wechat-lite/esengine.wxgame.js',
                'sdk/esengine.wxgame.wasm': 'wasm/wechat-lite/esengine.wxgame.wasm',
            },
        },
        // The WeChat engine with EmscriptenGLX linked in, for a project that turns it
        // on: WeChat publishes the library for emsdk 4.0.10, so this one target
        // builds with that emsdk (build-tools/toolchain/glx.js).
        'wechat-glx': {
            buildDir: 'build/cmake/wxgame-glx',
            cmakeFlags: ['-DES_BUILD_WXGAME=ON', '-DES_BUILD_TESTS=OFF'],
            targets: ['esengine_wxgame'],
            emsdk: '4.0.10',
            glx: true,
            outputs: {
                'sdk/esengine.wxgame.js': 'wasm/wechat-glx/esengine.wxgame.js',
                'sdk/esengine.wxgame.wasm': 'wasm/wechat-glx/esengine.wxgame.wasm',
            },
        },
        // The mini-game engine for vivo's quick-game V8 (8.3), which refuses a SIMD
        // opcode ("Invalid opcode (enable with --experimental-wasm-simd)"). What it also
        // refuses, an i64 in a wasm↔JS signature, no mini-game build carries.
        quickgame: {
            buildDir: 'build/cmake/qgame',
            cmakeFlags: ['-DES_BUILD_WXGAME=ON', '-DES_BUILD_TESTS=OFF', '-DES_MAIN_DISABLE_SIMD=ON'],
            targets: ['esengine_wxgame'],
            outputs: {
                'sdk/esengine.wxgame.js': 'wasm/quickgame/esengine.wxgame.js',
                'sdk/esengine.wxgame.wasm': 'wasm/quickgame/esengine.wxgame.wasm',
            },
        },
        physics: {
            buildDir: 'build/cmake/physics',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_BOX2D=ON', '-DES_PHYSICS_ESM=ON'],
            // ESM variant (EXPORT_ES6=1, `export default`) — the ONE physics build
            // for every realm. The SideModuleHost loader resolves the factory the
            // same way everywhere (fetch / inlined base64 / WeChat require), so
            // there is no separate side-module or playable physics build.
            targets: ['physics_module_esm'],
            outputs: {
                'sdk/physics.js': 'wasm/web/physics.js',
                'sdk/physics.wasm': 'wasm/web/physics.wasm',
            },
        },
        physics3d: {
            buildDir: 'build/cmake/physics3d',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_JOLT=ON', '-DES_PHYSICS_ESM=ON'],
            // The 3D world, on the same one-flavour terms as the 2D module above.
            // A project that never asks for it never pays for it — which is the
            // whole reason physics is a side module rather than engine code.
            targets: ['physics3d_module_esm'],
            outputs: {
                'sdk/physics3d.js': 'wasm/web/physics3d.js',
                'sdk/physics3d.wasm': 'wasm/web/physics3d.wasm',
            },
        },
        'physics3d-physx': {
            buildDir: 'build/cmake/physics3d-physx',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_PHYSX=ON', '-DES_PHYSICS_ESM=ON'],
            // The 3D world over PhysX, for a project that asks for Unity's solver.
            // Same entry points and factory as physics3d; only the file differs.
            targets: ['physics3d_physx_module_esm'],
            outputs: {
                'sdk/physics3d-physx.js': 'wasm/web/physics3d-physx.js',
                'sdk/physics3d-physx.wasm': 'wasm/web/physics3d-physx.wasm',
            },
        },
        basis: {
            buildDir: 'build/cmake/basis',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_BASIS=ON'],
            targets: ['basis_module'],
            outputs: {
                'sdk/basis.js': 'wasm/web/basis.js',
                'sdk/basis.wasm': 'wasm/web/basis.wasm',
            },
        },
        spine: {
            buildDir: 'build/cmake/web',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_WEBGPU=ON'],
            targets: ['spine_module'],
            outputs: {
                'sdk/spine42.js': 'wasm/web/spine42.js',
                'sdk/spine42.wasm': 'wasm/web/spine42.wasm',
            },
        },
        videodec: {
            buildDir: 'build/cmake/web',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_WEBGPU=ON'],
            targets: ['video_module'],
            outputs: {
                'sdk/videodec.js': 'wasm/web/videodec.js',
                'sdk/videodec.wasm': 'wasm/web/videodec.wasm',
            },
        },
        spine38: {
            buildDir: 'build/cmake/web',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_WEBGPU=ON'],
            targets: ['spine_module_38'],
            outputs: {
                'sdk/spine38.js': 'wasm/web/spine38.js',
                'sdk/spine38.wasm': 'wasm/web/spine38.wasm',
            },
        },
        spine41: {
            buildDir: 'build/cmake/web',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_WEBGPU=ON'],
            targets: ['spine_module_41'],
            outputs: {
                'sdk/spine41.js': 'wasm/web/spine41.js',
                'sdk/spine41.wasm': 'wasm/web/spine41.wasm',
            },
        },
        dragonbones: {
            buildDir: 'build/cmake/web',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_WEBGPU=ON', '-DES_ENABLE_DRAGONBONES=ON'],
            targets: ['dragonbones_module'],
            outputs: {
                'sdk/dragonbones.js': 'wasm/web/dragonbones.js',
                'sdk/dragonbones.wasm': 'wasm/web/dragonbones.wasm',
            },
        },
        spine21: {
            buildDir: 'build/cmake/web',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_WEBGPU=ON'],
            targets: ['spine_module_21'],
            outputs: {
                'sdk/spine21.js': 'wasm/web/spine21.js',
                'sdk/spine21.wasm': 'wasm/web/spine21.wasm',
            },
        },
        spine43: {
            buildDir: 'build/cmake/web',
            cmakeFlags: ['-DES_BUILD_WEB=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_WEBGPU=ON'],
            targets: ['spine_module_43'],
            outputs: {
                'sdk/spine43.js': 'wasm/web/spine43.js',
                'sdk/spine43.wasm': 'wasm/web/spine43.wasm',
            },
        },
        // WeChat-targeted side modules: the SAME standalone modules built under
        // ES_BUILD_WXGAME, which forces ENVIRONMENT=web + the wxgame-pre.js shim so
        // they evaluate inside the MiniGame runtime. Web-aligned filenames in a
        // separate wechat dir (synced to desktop/public/wasm-wechat) → exportWeChat
        // require()s `./wasm/physics.js` / `./wasm/spine42.js` exactly as the host expects.
        'physics-wechat': {
            buildDir: 'build/cmake/physics-wechat',
            cmakeFlags: ['-DES_BUILD_WXGAME=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_BOX2D=ON'],
            targets: ['physics_module'],
            outputs: {
                'sdk/physics.js': 'wasm/wechat/physics.js',
                'sdk/physics.wasm': 'wasm/wechat/physics.wasm',
            },
        },
        'basis-wechat': {
            buildDir: 'build/cmake/basis-wechat',
            cmakeFlags: ['-DES_BUILD_WXGAME=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_BASIS=ON'],
            targets: ['basis_module'],
            outputs: {
                'sdk/basis.js': 'wasm/wechat/basis.js',
                'sdk/basis.wasm': 'wasm/wechat/basis.wasm',
            },
        },
        'videodec-wechat': {
            buildDir: 'build/cmake/videodec-wechat',
            cmakeFlags: ['-DES_BUILD_WXGAME=ON', '-DES_BUILD_TESTS=OFF'],
            targets: ['video_module'],
            outputs: {
                'sdk/videodec.js': 'wasm/wechat/videodec.js',
                'sdk/videodec.wasm': 'wasm/wechat/videodec.wasm',
            },
        },
        'spine-wechat': {
            buildDir: 'build/cmake/spine-wechat',
            cmakeFlags: ['-DES_BUILD_WXGAME=ON', '-DES_BUILD_TESTS=OFF'],
            targets: ['spine_module', 'spine_module_43', 'spine_module_41', 'spine_module_38', 'spine_module_21'],
            outputs: {
                'sdk/spine42.js': 'wasm/wechat/spine42.js',
                'sdk/spine42.wasm': 'wasm/wechat/spine42.wasm',
                'sdk/spine43.js': 'wasm/wechat/spine43.js',
                'sdk/spine43.wasm': 'wasm/wechat/spine43.wasm',
                'sdk/spine41.js': 'wasm/wechat/spine41.js',
                'sdk/spine41.wasm': 'wasm/wechat/spine41.wasm',
                'sdk/spine38.js': 'wasm/wechat/spine38.js',
                'sdk/spine38.wasm': 'wasm/wechat/spine38.wasm',
                'sdk/spine21.js': 'wasm/wechat/spine21.js',
                'sdk/spine21.wasm': 'wasm/wechat/spine21.wasm',
            },
        },
        'dragonbones-wechat': {
            buildDir: 'build/cmake/dragonbones-wechat',
            cmakeFlags: ['-DES_BUILD_WXGAME=ON', '-DES_BUILD_TESTS=OFF', '-DES_ENABLE_DRAGONBONES=ON'],
            targets: ['dragonbones_module'],
            outputs: {
                'sdk/dragonbones.js': 'wasm/wechat/dragonbones.js',
                'sdk/dragonbones.wasm': 'wasm/wechat/dragonbones.wasm',
            },
        },
    },

    sdk: {
        esm: {
            input: 'src/index.ts',
            output: 'esm/index.js',
            format: 'esm',
        },
        cjs: {
            input: 'src/index.wechat.ts',
            output: 'cjs/index.wechat.js',
            format: 'cjs',
        },
    },

    eht: {
        inputDir: 'src/esengine/ecs/components',
        entityHeader: 'src/esengine/core/Types.hpp',
        constRoots: ['src/esengine'],
        outputDir: 'src/esengine/bindings',
        tsOutputDir: 'sdk/src',
        script: 'tools/eht.py',
    },

    watch: {
        cpp: ['src/**/*.cpp', 'src/**/*.hpp'],
        ts: ['sdk/src/**/*.ts'],
        components: ['src/esengine/ecs/components/**/*.hpp'],
    },

    sync: {
        wasm: {
            'build/wasm/web': 'desktop/public/wasm',
            // WeChat artifacts go to their OWN dir (main.ts resolves wechatWasm from
            // wasm-wechat first) — web-aligned filenames (physics.js, spine42.js, …)
            // would otherwise overwrite the web modules in desktop/public/wasm.
            'build/wasm/wechat': 'desktop/public/wasm-wechat',
            'build/wasm/wechat-glx': 'desktop/public/wasm-wechat-glx',
            'build/wasm/wechat-lite': 'desktop/public/wasm-wechat-lite',
            'build/wasm/quickgame': 'desktop/public/wasm-quickgame',
        },
        sdk: {
            'build/sdk/esm': 'desktop/public/sdk/esm',
            'build/sdk/cjs': 'desktop/public/sdk/cjs',
        },
    },
};