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.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright (c) 2024-present ESEngine Team
/**
* @file apiSubsystems.mjs — the tier of each part of Estella, at the size a
* creator thinks in.
*
* The per-symbol tiers answer "is `AudioSource` frozen". Nobody asks that. They
* ask "can I build my game's audio on this", and 1462 experimental symbols answer
* it the same way whether somebody weighed the subsystem or nobody looked at it —
* which is the exact ambiguity this release removed one level down.
*
* So each subsystem carries a verdict and the reason for it. `entry` is what
* carries the verdict in code: the gate reads their tags out of the snapshots and
* refuses a table that disagrees with them, so this cannot become a second answer.
*/
/**
* `tier` is the promise; `why` says what decided it, required for anything not
* frozen — "not frozen" is a decision and has to read like one. Both publish, so
* both carry a `*Zh`. `source` names the `sdk/src/*` a row speaks for, which is
* what makes the table answerable BACKWARDS; the rest is {@link INFRASTRUCTURE}.
*/
/**
* Directories under `sdk/src` that carry no creator-facing verdict: the wiring a
* game runs ON rather than builds WITH. Listed rather than inferred, so adding a
* subsystem cannot be mistaken for adding plumbing.
*/
export const INFRASTRUCTURE = {
gi: 'the dynamic GI\'s scene feed and baked file formats, run by the post-process effect: a creator turns on the effect and an import setting, and builds on neither',
'debug-channel': 'a development build\'s line back to the editor — tooling, never in a shipped game',
diagnostics: 'the engine reporting on itself — a census and a stats overlay, read by tooling',
document: 'document-model diagnostics shared with the editor, not part of a game',
platform: 'the PlatformAdapter implementations; a game meets these through the subsystems above',
openpaas: 'the SUD runtime-profile entry used by the exported boot script; game systems use the shared subsystems',
runtime: 'how an exported project boots — the loader and app factory the pipeline emits',
sideModules: 'fetching and caching the optional wasm modules the subsystems above sit on',
util: 'small shared helpers with no subsystem of their own',
wasm: 'the generated layout and the bridge to the C++ core',
};
export const SUBSYSTEMS = [
{
id: 'mobile-controls',
title: 'Mobile controls & device services',
titleZh: '移动控件与设备能力',
source: ['device', 'ui'],
tier: 'experimental',
why: 'software contracts and exports are verified; physical sensor, haptic and permission acceptance is pending across target devices',
whyZh: '软件契约与导出已验证;目标真机的传感器、震动和授权验收仍待完成',
entry: ['Device', 'VirtualJoystick', 'VirtualButton'],
},
{
id: 'ecs',
title: 'ECS',
titleZh: 'ECS',
source: ['ecs'],
tier: 'public',
entry: ['defineComponent', 'defineSystem', 'Query', 'Mut', 'Res', 'Commands', 'World'],
},
{
id: 'app-lifecycle',
title: 'App lifecycle',
titleZh: '应用生命周期',
source: ['app'],
tier: 'public',
entry: ['Schedule', 'addSystemToSchedule', 'addStartupSystem', 'defineSystemSet', 'Time'],
},
{
id: 'transform',
title: 'Transform & hierarchy',
titleZh: '变换与层级',
source: ['ecs'],
tier: 'public',
entry: ['Transform', 'Parent', 'Children', 'Name'],
},
{
id: 'drawing',
title: 'Sprites & text',
titleZh: '精灵与文本',
source: ['ecs', 'ui'],
tier: 'public',
entry: ['Sprite', 'Text', 'TextAlign'],
},
{
id: 'input',
title: 'Input actions',
titleZh: '输入动作',
source: ['input'],
tier: 'public',
why: 'the action and binding vocabulary is frozen; the raw per-frame state under it is Beta — see InputState',
whyZh: '动作与绑定的词汇表已冻结;它下面的每帧原始状态是 Beta —— 见 InputState',
entry: ['defineInputMap', 'Button', 'Axis1D', 'Axis2D', 'Key', 'GpButton', 'Stick'],
},
{
id: 'layout-units',
title: 'Layout units',
titleZh: '布局单位',
source: ['ui'],
tier: 'public',
entry: ['px', 'percent', 'Dimension'],
},
{
id: 'input-raw',
title: 'Raw input state',
titleZh: '原始输入状态',
source: ['input'],
tier: 'beta',
why: 'per-frame touch state is reachable only as raw collections, with no accessor for started/ended and no write door — freezing it would freeze both gaps',
whyZh: '每帧触摸状态只能通过原始集合拿到,started/ended 没有访问器,也没有写入门 —— 冻结它等于把这两个缺口一起冻进去',
entry: ['Input', 'InputState', 'TouchPoint'],
},
{
id: 'ui',
title: 'UI',
titleZh: 'UI',
source: ['ui'],
tier: 'beta',
why: 'thirty-three of a hundred and fifteen UI symbols reach a certified game, and the newest part of the surface is the part a creator meets first — anchors, insets, theme tokens',
whyZh: '115 个 UI 符号里只有 33 个到得了被认证的游戏,而这套面最新的部分恰恰是创作者最先碰的:锚点、inset、主题 token',
entry: ['UINode', 'UIVisual', 'spawnUIEntity', 'themeColors', 'UICameraInfo'],
},
{
id: 'scene',
title: 'Scenes',
titleZh: '场景',
source: ['scene'],
tier: 'beta',
why: 'one certified project drives scenes at all, against twenty-six SceneManagerState signatures',
whyZh: '只有一个被认证的项目在驱动场景,而 SceneManagerState 有 26 个签名',
entry: ['SceneManager', 'SceneManagerState', 'SceneConfig', 'SceneContext', 'transitionTo'],
},
{
id: 'residency',
title: 'World residency — streaming a world by cells',
titleZh: '世界 residency —— 按格子流送世界',
source: ['residency'],
tier: 'experimental',
why: 'one shape of world proven end to end: a square XZ grid cut at cook time, loaded synchronously. What a game asks for is settled; what a big one needs after it — priority, budget, a level of detail for what is absent — is not',
whyZh: '端到端证明的只有一种世界形状:cook 时切出的方形 XZ 网格,同步加载。一个游戏怎么提要求已经定了;大世界在它之后还需要的东西——优先级、预算、缺席内容的细节层次——还没有',
entry: ['StreamedWorld', 'WorldPersistent', 'WorldStreamingSource', 'WorldStreamer', 'worldResidencyReport'],
},
{
id: 'prefab',
title: 'Prefabs',
titleZh: '预制体',
source: ['prefab'],
tier: 'beta',
why: 'instantiate has not moved, but its result and override shapes are the on-disk format\'s, so the names settled ahead of the shapes',
whyZh: 'instantiate 没有动过,但它的结果和覆盖形状属于磁盘格式,所以名字比形状先定下来',
entry: ['Prefabs', 'PrefabServer', 'SpawnOverride'],
},
{
id: 'assets',
title: 'Assets',
titleZh: '资产',
source: ['asset'],
tier: 'beta',
why: 'one certified project takes Res(Assets), for four of its members, and the host wiring — resolvers, registries, the manifest, device-loss recovery — has to leave the game-facing surface first',
whyZh: '只有一个被认证的项目用 Res(Assets),且只用了 4 个成员;而宿主接线(resolver、registry、manifest、设备丢失恢复)必须先离开面向游戏的这一面',
entry: ['Assets', 'AssetsData'],
},
{
id: 'physics',
title: 'Physics',
titleZh: '物理',
source: ['physics'],
tier: 'beta',
why: 'the corpus reaches three of thirty-seven physics symbols',
whyZh: '语料只触到 37 个物理符号里的 3 个',
entry: ['Physics2D', 'Physics2DEvents', 'CharacterController2D'],
},
{
id: 'camera',
title: 'Camera',
titleZh: '相机',
source: ['camera'],
tier: 'beta',
why: 'clearFlags is a bitmask whose C++ enum has no TypeScript spelling, and cullingMask names layers no exported constant identifies — two fields typed `number` for want of the vocabulary',
whyZh: 'clearFlags 是位掩码,而它的 C++ enum 在 TypeScript 侧没有拼写;cullingMask 指的图层没有任何导出常量能标识 —— 两个字段被打成 number 是因为缺词汇',
entry: ['Camera', 'CameraData'],
},
{
id: 'spine',
title: 'Spine',
titleZh: 'Spine',
source: ['spine', 'skeletal'],
tier: 'beta',
why: 'one certified project plays a skeleton; the runtime is a side module a project opts into',
whyZh: '只有一个被认证的项目在播骨骼;运行时是项目自行选用的 side module',
entry: ['Spine', 'SpineAnimation'],
},
{
id: 'audio',
title: 'Audio',
titleZh: '音频',
source: ['audio'],
tier: 'beta',
why: 'a certified run drives a loop and reads the master bus analyser, so a break is noticed — but the corpus reaches a handful of twenty-three audio symbols',
whyZh: '已有被认证的运行会驱动一个循环并读取 master 总线的 analyser,所以它坏了会被发现——但语料只触到 23 个音频符号里的少数几个',
entry: ['Audio'],
},
{
id: 'animation',
title: 'Animation & timeline',
titleZh: '动画与时间轴',
source: ['animation', 'timeline', 'springbone'],
tier: 'beta',
why: 'sprite-animation now certifies it end to end, but the corpus reaches two of eighty animation symbols and the timeline half of them is untouched',
whyZh: 'sprite-animation 现在端到端认证了它,但语料只触到 80 个动画符号里的 2 个,而其中时间轴那一半完全没被碰过',
entry: ['Animator', 'SpriteAnimator'],
},
{
id: 'tilemap',
title: 'Tilemap',
titleZh: '瓦片地图',
source: ['tilemap'],
tier: 'beta',
why: 'two games certify it and one of them runs on every change, which is broader evidence than '
+ 'several rows already at this tier; what is not settled is the multi-tileset layer, '
+ 'whose singular field is still carried for older scenes',
whyZh: '两个游戏认证了它,其中一个每次改动都跑 —— 这比几个已经在这一级的子系统证据还多;'
+ '还没定下来的是多 tileset 的图层,单数字段仍为旧场景保留着',
entry: ['TilemapLayer'],
},
{
id: 'particles',
title: 'Particles',
titleZh: '粒子',
source: ['particle', 'trail'],
tier: 'beta',
why: 'one certified game drives it, the same evidence spine and scene were published on; '
+ 'the authored curves are the young half — they override the start/end pairs, and only '
+ 'one game has authored any',
whyZh: '有一个被认证的游戏在驱动它,与 spine、scene 当初发布时的证据同级;'
+ '年轻的那一半是可编辑曲线 —— 它们会覆盖 start/end,而只有一个游戏真的编过',
entry: ['ParticleEmitter'],
},
{
id: 'video',
title: 'Video',
titleZh: '视频',
source: ['video'],
tier: 'experimental',
why: 'the platform paths differ enough that the surface is still converging',
whyZh: '各平台路径差异仍大,这套面还在收敛',
entry: ['Video'],
},
{
id: 'gameplay',
title: 'Gameplay — third-person character and camera',
titleZh: 'Gameplay —— 第三人称角色与相机',
source: ['gameplay'],
tier: 'experimental',
why: 'the newest layer in the engine, and the one a game shapes hardest: what a character owes its animator settled first, everything above it has not',
whyZh: '引擎里最新的一层,也是最被具体游戏塑形的一层:角色欠动画什么已经定了,它之上的还没有',
entry: ['ThirdPersonController', 'ThirdPersonCamera'],
},
{
id: 'ai',
title: 'AI — navigation, FSM, behaviour trees',
titleZh: 'AI —— 导航、状态机、行为树',
source: ['ai'],
tier: 'experimental',
why: 'deliberately after the rest: 0.50 freezes what a game is built OUT of, and the layers built ON that come once those are settled',
whyZh: '刻意排在后面:0.50 冻的是「一个游戏由什么构成」,建立在其上的层要等下面这些定下来',
entry: ['Nav', 'NavAgent', 'StateMachineAgent', 'BehaviorTreeAgent', 'Perception'],
},
{
id: 'script-graph',
title: 'Script graphs — visual logic',
titleZh: '脚本图 —— 可视化逻辑',
source: ['logic'],
tier: 'experimental',
why: 'the node vocabulary is still growing: a name that gains an output changes what an authored graph can read, so the shape is not one to freeze yet',
whyZh: '节点词汇表还在长:一个名字多一个输出就改变了已画好的图能读到什么,形状还不到冻结的时候',
entry: ['ScriptGraphAgent', 'registerScriptGraph', 'registerValue', 'scriptGraphPlugin'],
},
{
id: 'networking',
title: 'Networking & replication',
titleZh: '网络与状态复制',
source: ['net'],
tier: 'experimental',
why: 'as AI — the high-level layer waits on the layers under it',
whyZh: '同 AI —— 高层要等它下面的层',
entry: ['Net', 'Replicated'],
},
{
id: 'rendering',
title: 'Materials, lighting, post-processing',
titleZh: '材质、光照、后处理',
source: ['render', 'postprocess', 'character'],
tier: 'experimental',
why: 'as AI — a game is built OUT of the layers under this one and they freeze first; '
+ 'the render graph it was waiting on has settled',
whyZh: '同 AI —— 一个游戏是由它下面那几层构成的,那些先冻;它当初等的那个 render graph 已经定下来了',
entry: ['Material', 'Light', 'PostProcessStack'],
},
{
id: 'physics-3d',
title: '3D physics',
titleZh: '3D 物理',
source: ['physics3d'],
tier: 'experimental',
why: 'its door — the plugin, the world resource, the contact events — reached no entry until this release, so nothing has yet built on the half a game actually calls',
whyZh: '它的门(插件、世界资源、碰撞事件)到这个版本才第一次进入口,所以游戏真正会调用的那一半还没有被任何东西建立在上面',
entry: ['RigidBody3D', 'Physics3D', 'Physics3DPlugin', 'CharacterController3D'],
},
{
id: 'breakable',
title: 'Breakable objects',
titleZh: '可破坏物体',
source: ['breakable'],
tier: 'experimental',
why: 'a struck thing swaps for its pre-cut pieces in a unit test and an editor check, and no example or golden project breaks anything yet',
whyZh: '被击中的物体换成预先切好的碎块,这件事有单元测试和编辑器检查在验,但还没有任何示例或 golden 项目真的打碎过东西',
entry: ['Breakable', 'Broke', 'BreakablePlugin'],
},
{
id: 'mesh',
title: '3D models & skinning',
titleZh: '3D 模型与蒙皮',
source: ['render'],
tier: 'experimental',
why: 'the import chain is certified end to end, but the runtime surface a game drives a model through — geometry, materials per submesh, joint entities — has not been read for a tier',
whyZh: '导入链路已经端到端认证,但游戏用来驱动模型的运行时面(几何体、逐子网格材质、关节实体)还没有被拿来定级',
entry: ['MeshRenderer', 'MeshRendererAPI', 'MeshRenderers'],
},
{
id: 'terrain-foliage',
title: 'Terrain & foliage',
titleZh: '地形与植被',
source: ['terrain', 'foliage', 'worldgen'],
tier: 'experimental',
why: 'the ground and the plants on it draw and are checked in the editor on both backends, but nothing collides with the ground yet and the authoring panels have not been read for a shape',
whyZh: '地面和上面的植物在编辑器里两个后端都能画出来并有检查,但还没有东西和地面碰撞,创作面板也还没有被拿来定下这套接口的形状',
entry: ['Terrain', 'Foliage'],
},
{
id: 'voxel',
title: 'Voxel terrain',
titleZh: '体积地形',
source: ['voxel'],
tier: 'experimental',
why: 'carving, the skin, collision and saves are checked against the real solver and on both backends, but it has no levels of detail or editor brush, and nothing has been measured on a device',
whyZh: '开挖、网格、碰撞和存档都用真实求解器和两个后端检查过,但还没有 LOD 和编辑器笔刷,也没有在真机上测过',
entry: ['VoxelTerrain', 'VoxelTerrains'],
},
{
id: 'spline',
title: 'Splines',
titleZh: '样条',
source: ['spline'],
tier: 'experimental',
why: 'the curve and its measuring by distance are checked, but the only thing that follows one so far is a river, and the editor has no tool to draw it',
whyZh: '曲线和按距离度量已经有检查,但目前只有河流会沿着它走,编辑器里也还没有绘制它的工具',
entry: ['Spline', 'SplineCurve'],
},
{
id: 'image',
title: 'Texture recipes',
titleZh: '贴图配方',
source: ['image'],
tier: 'experimental',
why: 'a recipe draws on the device to the very pixels its baked picture has, checked in a headless game, and is drawn on a worker once and read from the content cache after, checked in a browser opened twice, text, figures, laid-in pictures and surface maps included; but it has not been timed on a phone, text follows the fonts of the device unless a font file is named, and a ground reading a recipe as its layer is checked by a test and not in a game',
whyZh: '配方在设备上画出来的像素与烘焙好的图片逐像素一致,已在无头游戏里检查过;它在工作线程上画一次,之后从内容缓存读取,已在浏览器里两次打开检查过,文字、人物、铺入的图片和表面贴图都在内;但没有在手机上计过时,不指定字体文件时文字跟随设备字体,地形把配方当图层读只有测试检查过、没在游戏里检查过',
entry: ['renderImage', 'validateImageSource'],
},
{
id: 'sound',
title: 'Audio recipes',
titleZh: '音频配方',
source: ['sound'],
tier: 'experimental',
why: 'a clip named by its source is made on the device by the code the editor bakes it with, on a worker, and read from the content cache after; checked in a headless game for a sound and a piece of music, and heard by nobody yet on a phone or in a mini-game',
whyZh: '以源文件命名的音频片段在设备上用编辑器烘焙时的同一份代码生成,在工作线程上完成,之后从内容缓存读取;已在无头游戏里对一个音效和一段音乐做过检查,还没有人在手机或小游戏里听过',
entry: ['renderSound', 'renderMusic'],
},
{
id: 'rig2d',
title: '2D rigs',
titleZh: '2D 骨骼',
source: ['rig2d'],
tier: 'experimental',
why: 'baking, weights and the solvers are checked against the real engine, but no shipped example carries a rig yet, and its editor is new.',
whyZh: '烘焙、权重和解算都对真实引擎做了检查,但还没有示例真正用上骨骼角色,编辑器也是新的。',
entry: ['createRig', 'bakeRig', 'IK2D'],
},
{
id: 'imported-scene',
title: 'Imported scene runtime',
titleZh: '导入场景运行时',
source: ['imported-scene'],
tier: 'experimental',
why: 'what a glTF scene brings beside geometry, a node shown or hidden by its animation and particles authored in model units, is checked against the importer, but only imported scenes write it so far',
whyZh: 'glTF 场景在几何体之外带来的东西(随动画显隐的节点、按模型单位写的粒子)已经和导入器一起检查过,但目前只有导入的场景会写它们',
entry: ['NodeVisibility', 'ParticleModelUnits'],
},
{
id: 'skeletal-animation',
title: 'Skeletal animation',
titleZh: '骨骼动画',
source: ['skeletal-animation'],
tier: 'experimental',
why: 'the animator graph and grip poses are checked against the engine, and a lean package installs them only where its content uses them',
whyZh: '动画状态机和握持姿态已对引擎做过检查,精简包只在内容用到时才安装它们',
entry: ['AnimatorController', 'GripPose'],
},
{
id: 'water',
title: 'Water',
titleZh: '水体',
source: ['water'],
tier: 'experimental',
why: 'oceans, lakes and rivers are baked into one zone and drawn as one surface the CPU reads back, and things float on it, but the field and its shading are still settling and nothing swims yet',
whyZh: '海洋、湖泊和河流烘焙进同一个水体区域、画成一张水面,CPU 读到的就是画出来的那一面,也能漂浮物体;但区域场和着色还在定型,还没有东西能游泳',
entry: ['WaterBody', 'WaterZone', 'Waters'],
},
{
id: 'decal',
title: 'Decals',
titleZh: '贴花',
source: ['decal'],
tier: 'experimental',
why: 'the cut is proven and nothing authors one yet — the shape will follow what a projector panel turns out to need',
whyZh: '裁剪本身已经证明是对的,但还没有任何创作面去做一个贴花,所以这套接口的形状要跟着投影盒面板最终需要什么走',
entry: ['bakeDecalMesh', 'clipToProjector'],
},
{
id: 'lightmap',
title: 'Baked lighting',
titleZh: '烘焙光照',
source: ['lightmap'],
tier: 'experimental',
why: 'the bake runs and nothing in the editor triggers one yet, so the shape of this will follow what an authoring panel turns out to need',
whyZh: '烘焙跑得起来,但编辑器里还没有什么去触发它,所以这套接口的形状要跟着创作面最终需要什么走',
entry: ['unwrapLightmapUV', 'bakeLightmap'],
},
{
id: 'dragonbones',
title: 'DragonBones',
titleZh: 'DragonBones',
source: ['dragonbones'],
tier: 'experimental',
why: 'the second 2D skeletal runtime, and the one no certified game animates with — Spine carries that evidence and this shares none of it',
whyZh: '第二个 2D 骨骼运行时,也是没有任何被认证的游戏在用的那个 —— 证据在 Spine 那边,这边一点也没分到',
entry: ['DragonBonesAnimation', 'DragonBonesPlugin'],
},
{
id: 'math',
title: 'Math',
titleZh: '数学库',
source: ['math'],
tier: 'experimental',
why: 'the TYPES are frozen — Vec2, Vec3, Quat are @public and a Transform is made of them — but the operations over them are not, and a verdict has to name the weaker half',
whyZh: '类型本身已冻结 —— Vec2、Vec3、Quat 是 @public,Transform 就是由它们构成的 —— 但它们之上的运算没有,而判决必须按更弱的那一半来说',
entry: ['vec2', 'vec3', 'quat'],
},
{
id: 'i18n',
title: 'Localization',
titleZh: '本地化',
source: ['i18n'],
tier: 'experimental',
why: 'certified end to end by one game, whose use is a locale and a key lookup; the plural, formatting and fallback surface around that has no consumer',
whyZh: '有一个游戏端到端认证了它,但用到的只是「切语言 + 查 key」;围绕它的复数、格式化、回退这一圈没有任何消费者',
entry: ['Localization', 'LocalizationAPI', 'LocalizationPlugin'],
},
{
id: 'services',
title: 'Platform services',
titleZh: '平台服务',
source: ['services'],
tier: 'experimental',
why: 'each service is a contract with a store rather than with the engine, and the ones behind it differ enough that the shared shape is still being found',
whyZh: '每个服务都是与某个平台的契约而非与引擎的契约,而它们之间的差异大到共同形状还没找出来',
entry: ['Ads', 'Achievements', 'Identity'],
},
];