Phaser home
Log inCreate a game

← The API

Phaser AE

API docs

v3.0.0-1187 exports in 24 modulesreleased October 14, 2026

ContentsOverview

Need to get started? Install the Phaser AE CLI →

The Phaser AE kernel: the frame loop, the core services every game uses, and the contracts packs plug into. Version 3.0.0-1: 49 files, 8,627 lines.

Start hereThe guideWhat every game has: objects, input, loading, queries, verbs, timers, scenes, debug controls. 14 sections, the page every game's agent reads first.For pack authorsHow it worksThe 7 rules, the modules, one frame, ownership, and how a pack plugs in.ReferenceAPI reference187 exports in 24 modules, each with its signature and its documentation.

Entry points

import for holds
@phaser-ae/kernel packs, the bakery createGame, every public type, the 3D maths and drag conventions, colour helpers, tick sources, WebGL2 helpers
@phaser-ae/kernel/verbs game code move, moveTo, teleport, rotate, scale, tint, show, hide, kill, tag, untag, play
@phaser-ae/kernel/internal world packs only the raw roster tables and the shared 2D and 3D gathers

Game code does not call createGame: a bake writes it into the game's engine.ts, composing the manifest's packs in order, and game code imports the composed game from there. From the kernel itself, the bakery's game gate lets game code import only the verbs, types and the documented maths helpers.

API reference

Try it

Start a game from nothing

Make a Phaser AE game called Rock Dodge: a little ship dodges falling rocks, faster every level, with a score and a game-over screen. Start it with `npx -y @phaser-ae/cli blank rock-dodge --idea "A ship dodges falling rocks, faster every level."`, then build it, play it and publish it.

See one frame

In this Phaser AE game, read docs/00-kernel.md, then walk me through one frame of the game: which of my steps run, in what order, and where the packs' steps and render passes come in.

Add a pack

Add the bars pack to this Phaser AE game and show the player's health as a bar in the top-left corner that turns red as it empties. Search the packs first with `npm run -s packs -- search "health bar"`.

Paste one into Claude Code, Codex, Cursor or another coding agent with the Phaser AE CLI. Set up the CLI →

Phaser Pro

163 packs are free. 195 more come with Pro.

Everyone gets the same kernel. Pro unlocks all of the expansion packs, including whole kinds of game, 3D worlds and the showpiece effects, plus new packs as they're released.

Upgrade to Pro