Skip to content
BornEngine markBornEngine

Search BornEngine docs

Search loads when you open it. Navigation remains available without JavaScript.

HomeDocsCLIGitHubGet started ↗
Browse docs

Getting Started

  • Overview
  • Installation
  • Quickstart
  • Project structure

Concepts

  • Game loop
  • API shape
  • Assets

CLI

  • CLI overview
  • Project commands
  • Build and run
  • Asset audit
  • Diagnostics
  • Engine versions
  • Configuration

API

  • API overview
  • Game objects
  • Core
  • 2D camera
  • Input
  • Shapes
  • Textures
  • Assets
  • Database and migrations
  • Sprites and animation
  • Physics 2D
  • Tilemaps
  • Debug tools
  • Text
  • Audio
  • Colyseus
  • Models
  • Math
  • Scene
  • Physics
  • VFX
  • World
  • Mobile
  • UI

Platforms

  • Platform overview
  • Desktop
  • Apple
  • Mobile
  • Web and WASM

Guides

  • Physics
  • 2D physics and tilemaps
  • Skeletal animation
  • World format
  • Assets
  • Runtime debugging
  • 2D game
  • 2D production workflow
  • Migrating the 2D API
  • 3D scene
  • Physics gameplay
  • Assets and worlds
  • Audio and UI
  • Multiplayer with Colyseus

Troubleshooting

  • Troubleshooting

Reference

  • Architecture
  • Migration
  1. Docs/
  2. Reference

Reference

Reference

Stable architecture notes and migration guidance for BornEngine projects.

Keep these pages nearby when you need to understand the boundary between game code, the CLI, and the runtime.

  • Architecture — the TypeScript, Perry, Rust, and renderer pipeline.
  • Migration — update projects as the engine and CLI evolve.
Edit this page ↗
On this page
BornEngine markBornEngine

A native TypeScript game engine for people who want to understand the whole pipeline.

DocumentationCLI referenceEngine GitHubCLI GitHub

Built for clear builds, readable code, and real targets.