KAPLAYOpt
:KAPLAY configurations.
group Start
width
?: numberWidth of game.
height
?: numberHeight of game.
scale
?: numberPixel scale / size.
letterbox
?: booleanKeep aspect ratio and leave black bars on remaining spaces.
debug
?: booleanIf register debug buttons (default true)
debugKey
?: KeyKey that toggles debug mode
font
?: stringDefault font (defaults to "monospace").
pixelDensity
?: numberDevice pixel scale (defaults to 1, high pixel density will hurt performance).
since v3000.0
crisp
?: booleanDisable antialias and enable sharp pixel display. If you see rendering artifacts, set pixelDensity
param to Math.min(devicePixelRatio, 2) and scale to FHD resolution (e.g. 960x540 would need scale 2). Will result in up to 4K.
canvas
?: HTMLCanvasElementThe canvas DOM element to use. If empty will create one.
root
?: HTMLElementThe container DOM element to insert the canvas if created. Defaults to document.body.
background
?: RGBValue | RGBAValue | stringBackground 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
?: TexFilterDefault texture filter.
logMax
?: numberHow many log messages can there be on one screen (default 8).
logTime
?: numberHow many seconds log messages stay on screen (default 4).
since v3000.1
hashGridSize
?: numberSize of the spatial hash grid for collision detection (default 64).
since v3000.0
touchToMouse
?: booleanIf translate touch events as mouse clicks (default true).
loadingScreen
?: booleanIf KAPLAY should render a default loading screen when assets are not fully ready (default true).
since v3000.0
backgroundAudio
?: booleanIf 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
maxFPS
?: numberLimit framerate to an amount per second.
since v3000.0
focus
?: booleanIf focus on the canvas on start (default true).
since v3001.0
global
?: booleanIf import all KAPLAY functions to global (default true).
plugins
?: PluginList<any>List of plugins to import.
burp
?: booleanEnter burp mode.
tagComponentIds
?: booleanMake components ids be added as tags. That means .is() will return true for components with that id.
default true
spriteAtlasPadding
?: numberPadding used when adding sprites to texture atlas.
default 2
inspectOnlyActive
?: booleanIf the debug inspect view should ignore objects that are paused when choosing the object to show the inspect view on.
default false
experimental
narrowPhaseCollisionAlgorithm
?: stringWhich strategy to use for narrow phase collision, gjk or sat
default "gjk"
loadTimeout
?: numberTimeout (in milliseconds) at which other loaders waiting on sprites will give up and throw an error. Currently this is only used by .
default 3000
types
?: TypesOptTypeScript Advanced Features (TAF) are a series of options for TypeScript
only features.
It should be created using the helper function kaplayTypes.
ts
kaplay({
types: kaplayTypes
since v4000.0
Guides 
API Reference 
Blog