Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/OmarMtya/engine.js/llms.txt

Use this file to discover all available pages before exploring further.

Engine.js is a lightweight, browser-native 2D game engine editor. Open it in any modern browser and immediately start placing game objects on a canvas, configuring physics and animations, and previewing your scene with a single click — no installation, bundler, or compiler needed.

Introduction

Learn what Engine.js is, how it works, and what you can build with it.

Quickstart

Set up Engine.js and place your first game object on the canvas in minutes.

Core Concepts

Understand Figures, Transforms, physics, sprites, and sounds.

API Reference

Explore the full $g engine API — every class and method documented.

What you can build

Engine.js gives you a visual workspace for constructing 2D game scenes directly in the browser. You can create squares, circles, and image-based objects, attach physics bodies with gravity and collision, animate sprite sheets, and trigger sound effects — then hit Play to see everything run in real time.

Physics Objects

Add gravity and collision to any object using the Rigid Body system.

Sprite Animation

Animate sprite sheets with configurable rows, columns, and frame speed.

Sound Effects

Attach per-object audio triggered on collision, inverse collision, or scene start.

Get started in four steps

1

Clone or download the project

Grab the Engine.js source from GitHub and open index.html in your browser — no build step needed.
2

Place objects on the canvas

Use the toolbar to add squares, circles, or image objects. Each one appears at position (100, 100) and can be moved via the Attributes panel.
3

Configure object properties

Select any object in the Hierarchy panel to edit its name, position, size, color, physics, sprite animation, and sound in the Attributes panel.
4

Hit Play to animate

Click the Play button in the header to run your scene. Physics bodies will simulate gravity and collisions in real time. Click Pause to stop and resume editing.
Engine.js runs entirely in the browser. The engine/ core module is loaded as an ES module — no server or build pipeline is required to use the editor.

Build docs developers (and LLMs) love