Skip to Content
defold-typescript
Get startedGuidesAPILibraries

Guides

Learn defold-typescript in order — core concepts first, sharp edges last.

Tutorials

Build complete games and learn the ideas behind them.

TypeScript

Writing TypeScript for this toolchain and how it lowers to Lua.

Core concepts

How Defold's script model works in TypeScript.

CLI

The command-line verbs you run day to day.

init

init scaffolds a Defold project with a TypeScript surface — or adds TypeScript to an existing Defold project.

init-agents

init-agents writes the agent contract at the project root: AGENTS.md, which tells any AI harness (or human) opening the repo how this project is built and…

upgrade

upgrade is the verb that moves a project to the latest toolchain.

set-target

set-target writes the project's Defold API target — the defold-target pin in package.json — to a fixed version, a release channel, or the version of the…

watch

watch rebuilds your Lua incrementally on every TypeScript change.

reload

reload pushes one reload into the game running under the Defold editor, then reads that editor's console for a…

build

build transpiles every TypeScript file under src/[^src-root] to Lua and writes the result into the Defold project tree — a one-shot compile.

run

run launches a project you already compiled — the Runnable (an engine executable plus a build/default/game.projectc) left in the tree by a prior build…

bob

bob is Defold's own headless build tool — the bob.jar the editor uses under the hood.

wall

This page covers wall, the opt-in command for narrowing the API surface of a source directory to a single script kind.

resolve

resolve reads the Defold dependencies declared in your game.project, fetches each archive, and generates the TypeScript types for them — so extension…

scene-types

scene-types reads the .collection and .go files in your project and writes one declaration file naming every game-object path and component id they…

view

view opens a file's state machines and entity worlds in your browser and runs them there, when checks, run…

library

library works on library data: the per-library folders resolve prints its library declarations from.

Toolchain & workflow

Build, inspect, and drive the transpiler.

Project configuration

Pin the engine and add native code.

Migration

Comparing surfaces and moving off ts-defold.

Releases

What changed in each published toolchain version.

On this page