Configuration

StartBare options

Pass options as the second argument to StartBare:

StartBare(sceneClass, options?): Promise<Scene> starts the engine and resolves with the initial scene after startup.

import { Color, StartBare } from 'bare-engine';

StartBare(Game, {
    backgroundColor: new Color(30, 30, 40, 255),
    resolution: { width: 1280, height: 720 },
});

Option	Default	Description
backgroundColor	renderer startup color	Canvas background color, as a Color. Set it explicitly for a predictable appearance.
resolution	full window	Render size, see below.
antiAlias	true	Smooth edges.
textureFilter	LINEAR	Use NEAREST for pixel art.
roundPixels	false	Snap rendering to whole pixels.
premultipliedAlpha	true	WebGL context alpha representation, passed to the renderer on startup.
scaleMode	CanvasScaleMode.CanvasItem	How canvas scaling affects the render buffer; see below.
fixedTimestep	1/60	Seconds per fixed update.
freezeOnUnfocus	true	Pause when the tab loses focus.
multiTouch	false	Accept more than one touch at once.
gameObjectPoolSize	50	Default size of object pools.
showEditorButton	automatic	true: keep the button visible when a level is loaded, including with the extension connected. false: hide it. Omitted: hide it when the extension connects. Development only.
editorButtonPosition	{ x: 0, y: 0 }	Normalized position and pivot, as { x: number, y: number }. { x: 1, y: 0 } anchors it at the top right. Development only; see Level editor in production.
debugKeys	E, P, R, L, C	Keyboard shortcuts during development. See Debug keys.

Resolution

See Resolution & Pixel Art for common setups.

Field	Description
width, height	Fixed game size in game units.
scale	A fixed CSS scale, or CanvasScale.Fit to fit the window.
position	CanvasPosition.Center or CanvasPosition.TopLeft.
integerScale	Only scale by whole numbers, for crisp pixel art.
pixelScale	Fill the window, but render at a lower resolution so everything appears pixelScale times bigger. Overrides width, height and scale.

Debug keys

The default keys and how to change them are listed under Debugging. They're removed from production builds.

Scene options

A scene's constructor passes options to super:

import { Scene } from 'bare-engine';
import settingsData from '../public/data/settingsData.json';

export class HUD extends Scene
{
    constructor()
    {
        super({ settingsData, UI: true, persistent: true });
    }
}

Option	Default	Description
settingsData	built-in defaults	The scene's settings: prefabs, layers, animations.
UI	false	Not moved by a camera, drawn in screen space, and kept above non-UI scenes.
resize	false	When the window size changes, move every object so it keeps its relative place on screen.
persistent	false	Keep the scene when bare.scene.Goto clears the others.

super(settingsData) is shorthand for super({ settingsData }).

package.json

Build settings such as gameId, firstLevelLoad and stripGeneratedAssets go under bareEngine in your project's package.json. See package.json Options for the full list.