Documentation

The documentation

Depending on where you are coming from: install and start, learn by building a whole game, understand how a scene lives, get to know the hooks and the creators, or look up one symbol.

Up and running in ten minutes

The fast track, for people who already code. Install, a sprite on screen, and move it.

Install and start

Step-by-step tutorial

A complete Breakout in nine chapters, running on this very page. Nothing to install, and no prior coding needed.

Take the tutorial

The lifecycle of a scene

What happens to a scene from the moment it starts until it leaves, frame by frame, with a diagram for every step.

See the lifecycle

Hooks and creators

The two kinds of function a game is written with, by topic and with an example each.

See hooks and creators

API reference

Everything your game can use from the engine, generated from the code itself: signatures, options and examples.

Open the reference

Where each thing is imported from

Everything a game runs comes from the package root. Physics has two subpaths of its own, because the physics engine is installed apart and only a game that uses it pays for it. Those are the three the reference covers.

What a game runsimport { createGame, createSprite } from 'nacatamalon'
What moves the physicsimport { installPhysics2d } from 'nacatamalon/physics2d'import { installPhysics3d } from 'nacatamalon/physics3d'