Module Handbook

Download an SDK from Releases, unzip it and run eve run <game-directory>. No engine compilation is needed.

Guides explain tasks, working examples, ownership and failure handling. Exact C++ signatures belong in Doxygen; callable EveScript signatures belong in the SDK's share/eve/ai/eve-api.json or editor/MCP API lookup. A C++ public method is not necessarily script-callable.

English guides are maintained by hand with Chinese as the authoritative source. This first batch covers onboarding, language, saving and common game-development workflows. Links marked Chinese lead to guides not yet translated; they remain useful and are not represented as English documentation.

Use has_module("slot") for optional features. Project module selection and source-build trimming are different; see EveScript and module trimming.

Runtime and input

Window: window dimensions, resizing and DPI.
Keyboard: held keys, edge detection and text input.
Mouse: pointer coordinates, relative motion and wheel snapshots.
Agent — Chinese: policy learning, decisions, tensor inference and trajectory replay.
Events — Chinese: platform event pumping and string-message queues.
Reactive streams — Chinese: Subjects, operators, reactive properties and event bridging.
Timer — Chinese: elapsed time and frame intervals.
OS — Chinese: operating system, CPU, memory, battery, clipboard and GPU information.
Touch — Chinese: touch counts and normalized/screen coordinates.
Joystick — Chinese: axes, buttons, hats, controller mappings and vibration.

Assets and I/O

Filesystem and hot reload: virtual paths, save files and local/remote reload.
Data — Chinese: byte data/views, compression, hashes and JSON/XML.
Image — Chinese: script-binding limits and image data from font glyphs.
Font — Chinese: font data, glyph metrics and bitmaps.
Localization — Chinese: JSON dictionaries, placeholders, plurals and language fallback.
Sound data — Chinese: decoding and samples for audio sources.
Audio — Chinese: playback, volume, pitch, looping and 3D source positions.
3D models — Chinese: model loading for rendering.
Network — Chinese: HTTP, TCP and network state.

Gameplay

Script ECS: components, entity composition, systems and GPU integration.
Physics — Chinese: 2D and 3D worlds, contacts and spatial queries.
Cloth — Chinese: cloth simulation.
Rope — Chinese: rope simulation and attachments.
Destruction — Chinese: geometry collections and runtime destruction.
Destruction graphics — Chinese: destruction presentation.
Tilemap — Chinese: layers, tiles, projections and rendering.
Particles — Chinese: emitters, movement, color, lifetime and rendering.
PixelWorld — Chinese: material-cell simulation.
PixelWorld replay — Chinese: deterministic replay.
PixelWorld streaming — Chinese: interest areas and authoritative corrections.
PixelWorld editor — Chinese: material catalog editing.
Animation — Chinese: tweening, skeletal playback, motion matching, procedural poses and trails.
Climbing — Chinese: obstacle detection and physics-constrained vault/mantle actions.
Action and abilities — Chinese: grants, cooldowns, activation and action submission.
Combat — Chinese: combat runtime and simulation.
Settlement — Chinese: deterministic settlement rules and ledgers.
NPC AI — Chinese: state trees, blackboards, sensing memory and scheduling.
RPG — Chinese: attributes, statuses, skills, casting and damage.
Inventory — Chinese: bags, transfer, equipment and capacity/stacking rules.
Cards — Chinese: hands, drawing, shuffling, dragging and costs.
Building — Chinese: definitions, occupied cells, previews, validation and snapping.
Building visuals — Chinese: 2D/3D placement presentation.
House generation — Chinese: component-based generation into layout JSON.
ArchSpace — Chinese: floor, wall, room and opening documents.
Procedural generation — Chinese: meshes, maps, images and GPU textures.
Hex maps — Chinese: planar/spherical terrain, pathfinding, units and saves.
Weapons — Chinese: ammunition, mounts, aiming, firing and reloading.
Vehicles — Chinese: movement, seats, turrets, damage and physics integration.
Effects — Chinese: stackable and expiring effects.
State patches — Chinese: atomic JSON updates with conflict checks.
Orders — Chinese: priority queues, preemption, timeouts and snapshots.
Social graph — Chinese: ownership, control, roles and directed relations.
Production — Chinese: parallel slots and resumable production tasks.
Authority — Chinese: prioritized allow/deny rules.
Sensing — Chinese: candidate queries and selection.
Emergence — Chinese: rule-based triggers.

Rendering and scenes

Graphics: getting started: 2D frames, sprites, 3D resources and rendering boundaries.
UI: getting started: retained trees, stable IDs, events and reusable components.
Fog — Chinese: fluid density, ray marching and froxel integration.
Voxel — Chinese: chunk worlds, meshes, picking, streaming and saves.
Sprite stacking — Chinese: layered images for pseudo-3D rendering.
Day/night — Chinese: sun orbit, sky and night lighting.
Weather — Chinese: rain, snow, lightning and wind.
Snow — Chinese: interactive accumulation and displacement.
Avatar — Chinese: layered characters, expressions, lip sync and motion.
Dialogue — Chinese: staging, typing, choices and .dnut scripts.
Camera controllers — Chinese: follow, orbit, top-down, first-person and sequences.
Scene loading — Chinese: glTF/OBJ/FBX, reload and async loading.
Scene graph — Chinese: hierarchy, local/world transforms and render entities.
Decals — Chinese: projected and procedural decals.

Advanced capabilities

Math — Chinese: vectors, matrices, geometry, noise, random numbers and easing.
Spatial indexing — Chinese: culling and neighborhood queries.
Editor components — Chinese: gizmos, brushes, inspectors, docks and history.
IK — Chinese: skeletons, targets and FABRIK solving.
GPU compute — Chinese: buffers, compute shaders and dispatch.
Tensor — Chinese: eager operations and compiled graphs.
Threads — Chinese: safe worker tasks and main-thread delivery.
Stylized rendering — Chinese: cartoon, watercolor, ink and pixel effects.
Virtual geometry — Chinese: GPU cluster culling and LOD.
Grid — Chinese: native coordinate/topology services used by map and building.
Native plugins — Chinese: SDK-built dynamic modules.
Built-in demo — Chinese: runtime installation checks.

For player persistence, start with Saving games across modules. Additional guides remain indexed by the Chinese handbook.