New to DemiEngine?
Create a project from a template, run the development loop with hot reload, and learn the project/scene/entity model.
Getting started → Core concepts →DOCUMENTATION / 95 GUIDES
Learn the engine.
Ship the game.
Everything DemiEngine can do, organized by the job you are trying to finish. Start with a runnable project, then go deep on scripting, UI, physics, networking, and release builds.
Authoring gameplay
Script with Lua services, shape interfaces in the HUD tree, wire input actions, and reuse prefabs and packages.
Lua scripting → UI & HUD →Build and ship
Validate every reachable source, run E2E tests, cook deterministic content, and package Linux or Android releases.
Testing & debugging → Shipping & builds →All documentation
Start here
- Getting startedBuild the engine, create a project, and run your first scene with hot reload.
- Core conceptsProjects, scenes, entities, components, prefabs, assets, and packages.
- Entities & componentsWhat an entity is, how components attach, and hierarchy rules.
- Prefabs & instancesReusable compositions, overrides, and ID expansion.
- Assets & stable IDsURI schemes, conventional paths, and why IDs never change.
- Source vs generatedWhat to edit, what to ignore, and where saves live.
- Project & file formatsJSON document shapes, URI schemes, and conventional paths.
- demi.project.jsonEvery project field explained, from scenes to build metadata.
- Input bindingsWhat bindings are, what vector does, deadzones, and presets.
- Physics layersThe named collision matrix and how bodies filter each other.
- Simulation & seedsFixed timestep, random seeds, and why determinism matters.
- Performance budgetsWhat budgets measure and how they help you ship.
- Scene filesEntities, children, instances, and the full scene document.
- Prefab filesPrefab documents, nesting, and override semantics.
- HUD filesHUD document structure, variables, and themes.
- MaterialsShared mesh and terrain surfaces, PBR maps, projection and normal conventions.
- Asset manifestsManifest fields, importers, settings, and groups.
- Build & platform settingsapplication_id, window, Android permissions, branding.
- CLI referenceEvery demi command for authoring, validation, testing, and packaging.
Create
- EditorNative scene, HUD, and prefab workspace with Inspector, Undo, and Play.
- Lua scriptingLifecycle hooks, explicit imports, typed properties, events, and timers.
- Lua API referenceEngine service modules, return shapes, units, and error conventions.
- API conventionsReturn shapes, units, error handling, and require style.
- Entity APIFind, spawn, query, destroy, and component fields.
- Transform API2D/3D position, rotation, scale, directions, look_at.
- Scene & prefab APILoading scenes and instantiating prefabs at runtime.
- HUD APIFind, create, and mutate UI from Lua.
- Data & save APILoading game data and reading/writing saves.
- Assets, time & timersAsync loads, frame time, and scheduling.
- Math & debugVectors, seeded RNG, debug lines, and profiling.
- InputAction maps, bindings, contexts, gamepads, touch, and deterministic replay.
- UI & HUDRetained HUD trees, layout, themes, localization, prefabs, and accessibility.
- HUD nodesEvery node type and the fields it accepts.
- LayoutDock, stack, anchors, margins, padding, and safe areas.
- Text, theme & localeFonts, variables, localization, and styles.
- HUD from LuaSetters, events, tweens, and runtime-created nodes.
- Orbit UI kitNative controls, configurable palettes and compound-control bindings.
- UI prefabsParameterized reusable subtrees.
Game systems
- 2D & isometricSprites, animation, tilemaps, cameras, isometric grids, and render order.
- 3D gameplayModels, characters, lights, destruction, denting, and cameras.
- Models & meshesglTF models, LOD, instancing, and procedural meshes.
- Terrain generation & editingGenerate heightfields, paint biomes, sculpt adjustments and preserve edits across regeneration.
- CharactersCharacterController3D movement, slopes, and jumps.
- Lights & cameraLighting, environment, and screen/world conversion.
- DestructionFracture authoring, impacts, and debris.
- PhysicsBox2D and Jolt bodies, colliders, joints, queries, contacts, and events.
- Animation & audioState machines, blend spaces, IK, buses, snapshots, and spatial voices.
- Assets & streamingImporters, manifests, addressable groups, cooking, and portable packs.
- Game dataSchema-backed data assets for items, quests, dialogue, and balance.
- Networking & HTTPHost-authoritative sessions, contracts, prediction, TLS, and REST calls.
Ship
- PackagesInstall reusable gameplay modules and assets from the free catalog.
- Testing & debuggingE2E scripts, deterministic replay, profiler reports, and debug overlays.
- Shipping & buildsValidate, cook, and package Linux bundles and Android APK/AAB releases.
- CapabilitiesWhat is stable, experimental, or planned — and the compatibility policy.
- Examples tourEvery checked-in example project and what it demonstrates.