Skip to content

Guides Scripting API Reference For AI

v1.0.0

Get started

Overview Installation The Vaelis Hub Build your first game Scripting quickstart

Concepts

Architecture Entities & components Game loop & scenes Coordinate system

Editor

Editor overview Controls & exact locations Editor settings & performance Hierarchy & Inspector Scenes & projects Assets & animation Prefab workflow Physics authoring Navigation authoring Lighting, audio & UI Tilemaps & tilesets Component workflows Complete feature workflows

Scripting

Lifecycle Global API Tween API Time scale & game speed Entity context (this)Entity shortcuts Finding & spawning Input Physics scripting Collisions & triggers Pathfinding Navigation: complete setup State & messaging Timers, state & messaging Persistence Save data Errors & debugging API cookbook

API reference

API index Runtime modules this (EntityContext)Option schemas (opts)Requirements & usage map

Export & deploy

Export overview HTML5 & PWA Export window reference Android APK

Reference

Tuning guide Scene JSON Project format Engine conventions Debugging Security & play origin Versioning Source map Changelog

AI & machine access

AI & crawlers For AI assistants & LLMs

Components

Rendering & UI

Transform SpriteRenderer ShapeRenderer TextRenderer StrokePath SpeechBubble ChatLog TextInput Joystick

Physics & movement

Rigidbody2D Collider2D Joint2D CharacterController

Animation, camera & audio

SpriteAnimation Camera AudioSource AudioListener

Lighting

Light ShadowCaster LightingSettings

Navigation & tiles

NavAgent2D NavWorld2D Tileset Tilemap

Scripting

Docs

Site map

All 85 documentation pages, grouped by section.

Get started

Overview
Installation
The Vaelis Hub
Build your first game
Scripting quickstart

Concepts

Architecture
Entities & components
Game loop & scenes
Coordinate system

Editor

Editor overview
Controls & exact locations
Editor settings & performance
Hierarchy & Inspector
Scenes & projects
Assets & animation
Prefab workflow
Physics authoring
Navigation authoring
Lighting, audio & UI
Tilemaps & tilesets
Component workflows
Complete feature workflows

Scripting

Lifecycle
Global API
Tween API
Time scale & game speed
Entity context (this)
Entity shortcuts
Finding & spawning
Input
Physics scripting
Collisions & triggers
Pathfinding
Navigation: complete setup
State & messaging
Timers, state & messaging
Persistence
Save data
Errors & debugging
API cookbook

API reference

API index
Runtime modules
this (EntityContext)
Option schemas (opts)
Requirements & usage map

Export & deploy

Export overview
HTML5 & PWA
Export window reference
Android APK

Reference

Tuning guide
Scene JSON
Project format
Engine conventions
Debugging
Security & play origin
Versioning
Source map
Changelog

AI & machine access

AI & crawlers
For AI assistants & LLMs

Components

Transform
SpriteRenderer
ShapeRenderer
TextRenderer
StrokePath
SpeechBubble
ChatLog
TextInput
Joystick
Rigidbody2D
Collider2D
Joint2D
CharacterController
SpriteAnimation
Camera
AudioSource
AudioListener
Light
ShadowCaster
LightingSettings
NavAgent2D
NavWorld2D
Tileset
Tilemap
Script

Vaelis 1.0.0 documentation · static, versioned, machine-readable

Home Versions llms.txt llms-full.txt Search index API JSON Site map