Realot StudioDocs
Get started

Realot Studio documentation

Everything you need to build 2D games with Realot Studio, verified against the supplied engine source.

View as Markdownllms.txt
What is Realot Studio?A browser-based 2D game engine with a visual editor, JavaScript gameplay scripting, PixiJS rendering and Rapier2D physics. The hosted engine is updated by publishing its web files; users do not need a separate engine installer.

#Start here

#Open Realot Studio

Use the hosted editor or serve the static distribution yourself.

#Build your first game

Entities, components and a first script in a few steps.

#Scripting quickstart

onStart, onUpdate, this and the component modules.

#Editor controls

Exact menu paths, panels and keyboard shortcuts.

#Browse by topic

#Get started

Run the editor, build a first game and learn the scripting model.

5 pages

#Concepts

Architecture, the entity–component model, the game loop and coordinates.

4 pages

#Editor

Every panel, menu path, shortcut and authoring workflow.

13 pages

#Scripting

Lifecycle, globals, input, physics, navigation, saving and debugging.

18 pages

#API reference

Component fields, script members, option shapes and prerequisites.

6 pages

#Export & deploy

HTML5, installable PWA and Android APK builds.

4 pages

#Reference

Tuning rules, scene and project formats, live updates and source map.

8 pages

#AI & machine access

llms.txt, Markdown twins, JSON catalogs and guidance for assistants.

3 pages

#Component reference

25 components, each documented with serialized fields, defaults, script API and editor location.

TransformPosition, rotation and scale. Every spatial entity uses a Transform.SpriteRendererDraw a 2D texture sprite for an entity.ShapeRendererDraw a procedural 2D shape without requiring a sprite asset.TextRendererRender text either in world space or as screen-space UI.StrokePathA variable-thickness strip along placed points — rivers, cables, roads, conveyor belts or walls — with flat color or…SpeechBubbleSpeech bubble UI attached to an entity, useful for dialogue and NPC callouts.ChatLogScrollable-style conversation log component for UI dialogue.TextInputInteractive text input control driven by the runtime UI system.JoystickVirtual touch joystick for mobile and pointer-driven control schemes.Rigidbody2D2D physics body backed by the engine physics runtime. Dynamic, Kinematic and Static bodies have different script…Collider2DPhysics collision shape and contact filtering. A Collider2D is also required for accurate pointer/touch hit tests.Joint2DConnect physics bodies with Fixed, Revolute, Prismatic, Rope or Spring constraints.CharacterControllerHigh-level movement modes: Character Controller, Platformer, Top-Down, Car, Follow, Patrol and Free.SpriteAnimationSprite-sheet/clip animation state on a SpriteRenderer.CameraOrthographic 2D camera with reference resolutions, responsive scaling, follow, shake and optional pseudo-3D sprite…AudioSourcePlay a local audio asset, optionally with distance-based 3D attenuation.AudioListenerDefines the hearing area for 3D audio and drives audio enter/leave callbacks.Light2D light source supporting Directional, Point, Spot, Area, GodRays and Freeform light shapes.ShadowCasterMarks an entity as a shadow occluder for the lighting system.LightingSettingsScene-wide lighting quality and mood controls. Attach to one entity; the lighting system reads it scene-wide.NavAgent2DPer-agent navigation settings and current path state for NavWorld2D pathfinding.NavWorld2DShared navigation world for baked or dynamic 2D pathfinding, with 16 navigation areas.TilesetDefines a reusable 16-role autotile set. The editor can auto-slice one image or accept separate role images.TilemapSparse painted tile grid that references a Tileset entity by ID.ScriptScript component holding a script name, source and enabled state.

#For automated systems

Every page is complete static HTML with a Markdown twin (same URL, .md). Machine entry points: llms.txt, llms-full.txt (all documentation in one file), search-index.json, api/index.json, sitemap.xml and robots.txt. See AI & crawlers.