Background color. E.g. [ 0, 0, 255 ] for solid blue background, or [ 0, 0, 0, 0 ] for transparent background. Accepts RGB value array or string hex codes.

texFilter

?: TexFilter

Default texture filter.

logMax

?: number

How many log messages can there be on one screen (default 8).

logTime

?: number

How many seconds log messages stay on screen (default 4).

since v3000.1

hashGridSize

?: number

Size of the spatial hash grid for collision detection (default 64).

since v3000.0

touchToMouse

?: boolean

If translate touch events as mouse clicks (default true).

loadingScreen

?: boolean

If KAPLAY should render a default loading screen when assets are not fully ready (default true).

since v3000.0

backgroundAudio

?: boolean

If pause audio when tab is not active (default false).

since v3000.0

gamepads

?: Record<string, GamepadDef>

Custom gamepad definitions (see gamepad.json for reference of the format).

since v3000.0

buttons

?: TButtonDef

Defined buttons for input binding.

since v30010

maxFPS

?: number

Limit framerate to an amount per second.

since v3000.0

focus

?: boolean

If focus on the canvas on start (default true).

since v3001.0

global

?: boolean

If import all KAPLAY functions to global (default true).

plugins

?: TPlugin

List of plugins to import.

burp

?: boolean

Enter burp mode.

tagsAsComponents

?: boolean

Make component's id ("sprite" for sprite() comp) be added as tags. That means .is() will return true for components with that id.

default true

experimental This feature is in experimental phase, it will be fully released in v4000.0

spriteAtlasPadding

?: number

Padding used when adding sprites to texture atlas.

default 0

experimental This feature is in experimental phase, it will be fully released in v4000.0