@shaisrc/tty v0.1.0-beta.5

The renderer instance

Returns

void

stop()

stop(id): void

Defined in: core/AnimationManager.ts:270

Stop an animation

Parameters

id

number

Animation ID returned from animate/flash/pulse

Returns

void

stopAll()

stopAll(): void

Defined in: core/AnimationManager.ts:281

Stop all animations

Returns

void

update()

update(currentTime): void

Defined in: core/AnimationManager.ts:298

Update all active animations Should be called each frame, typically from the game loop

Parameters

currentTime

number = ...

Current time in milliseconds (defaults to Date.now())

Returns

void

Example

gameLoop.update((dt) => {
  animations.update();
});

CanvasTarget

Defined in: targets/CanvasTarget.ts:29

Renders to an HTML Canvas element

Implements

RenderTarget

Constructors

Constructor

new CanvasTarget(canvas, options): CanvasTarget

Defined in: targets/CanvasTarget.ts:44

Create a new CanvasTarget

Parameters

canvas

HTMLCanvasElement

Canvas element to render to

options

CanvasTargetOptions

Canvas configuration including width, height, and rendering options

Returns

CanvasTarget

Methods

clear()

clear(): void

Defined in: targets/CanvasTarget.ts:93

Clear the entire canvas

Returns

void

Implementation of

RenderTarget.clear

flush()

flush(): void

Defined in: targets/CanvasTarget.ts:100

Flush changes (no-op for canvas as drawing is immediate)

Returns

void

Implementation of

RenderTarget.flush

getCanvas()

getCanvas(): HTMLCanvasElement

Defined in: targets/CanvasTarget.ts:114

Get the canvas element

Returns

HTMLCanvasElement

getSize()

getSize(): object

Defined in: targets/CanvasTarget.ts:107

Get the size of the render target

Returns

object

height

height: number

width

width: number

Implementation of

RenderTarget.getSize

setCell()

setCell(x, y, char, fg, bg): void

Defined in: targets/CanvasTarget.ts:73

Set a character at the specified position

Parameters

x

number

y

number

char

string

fg

bg

Returns

void

Implementation of

RenderTarget.setCell

setOptions()

setOptions(options): void

Defined in: targets/CanvasTarget.ts:121

Update canvas options

Parameters

options

Partial<CanvasTargetOptions>

Returns

void

GameLoop

Defined in: core/GameLoop.ts:15

Constructors

Constructor

new GameLoop(update, render?, options?): GameLoop

Defined in: core/GameLoop.ts:41

Create a new game loop

Parameters

update

UpdateCallback

Update callback (called with delta time in ms)

render?

RenderCallback

Optional render callback

options?

GameLoopOptions = {}

Game loop options

Returns

GameLoop

Methods

getActualFPS()

getActualFPS(): number

Defined in: core/GameLoop.ts:171

Get actual FPS (calculated over last second)

Returns

number

getElapsedTime()

getElapsedTime(): number

Defined in: core/GameLoop.ts:193

Get total elapsed time in milliseconds (excluding paused time)

Returns

number

getFPS()

getFPS(): number

Defined in: core/GameLoop.ts:164

Get target FPS

Returns

number

getTimestep()

getTimestep(): number

Defined in: core/GameLoop.ts:186

Get fixed timestep in milliseconds

Returns

number

isPaused()

isPaused(): boolean

Defined in: core/GameLoop.ts:157

Check if game loop is paused

Returns

boolean

isRunning()

isRunning(): boolean

Defined in: core/GameLoop.ts:150

Check if game loop is running

Returns

boolean

pause()

pause(): void

Defined in: core/GameLoop.ts:131

Pause the game loop (stops update/render but keeps running)

Returns

void

resume()

resume(): void

Defined in: core/GameLoop.ts:139

Resume the game loop

Returns

void

setFPS()

setFPS(fps): void

Defined in: core/GameLoop.ts:178

Set target FPS

Parameters

fps

number

Returns

void

start()

start(): void

Defined in: core/GameLoop.ts:101

Start the game loop

Returns

void

stop()

stop(): void

Defined in: core/GameLoop.ts:114

Stop the game loop

Returns

void

GamepadManager

Defined in: input/GamepadManager.ts:19

Constructors

Constructor

new GamepadManager(options): GamepadManager

Defined in: input/GamepadManager.ts:34

Create a new gamepad manager

Parameters

options

Configuration options

deadzone?

number

Returns

GamepadManager

Methods

destroy()

destroy(): void

Defined in: input/GamepadManager.ts:337

Remove event listeners and cleanup

Returns

void

getAxis()

getAxis(axisIndex, gamepadIndex): number

Defined in: input/GamepadManager.ts:209

Get axis value with deadzone applied

Parameters

axisIndex

number

gamepadIndex

number = 0

Returns

number

getButton()

getButton(buttonIndex, gamepadIndex): GamepadButtonState

Defined in: input/GamepadManager.ts:186

Get button state with all flags

Parameters

buttonIndex

number

gamepadIndex

number = 0

Returns

GamepadButtonState

getConnectedCount()

getConnectedCount(): number

Defined in: input/GamepadManager.ts:154

Get the number of connected gamepads

Returns

number

getDeadzone()

getDeadzone(): number

Defined in: input/GamepadManager.ts:267

Get current deadzone value

Returns

number

getDPad()

getDPad(gamepadIndex): GamepadAxisState

Defined in: input/GamepadManager.ts:245

Get D-pad direction as {x, y} (-1, 0, 1) Uses buttons 12-15 (standard mapping)

Parameters

gamepadIndex

number = 0

Returns

GamepadAxisState

getGamepad()

getGamepad(index): Gamepad | null

Defined in: input/GamepadManager.ts:133

Get a gamepad by index (0-3)

Parameters

index

number = 0

Returns

Gamepad | null

getGamepads()

getGamepads(): Gamepad[]

Defined in: input/GamepadManager.ts:140

Get all connected gamepads

Returns

Gamepad[]

getLeftStick()

getLeftStick(gamepadIndex): GamepadAxisState

Defined in: input/GamepadManager.ts:224

Get left stick as

Parameters

gamepadIndex

number = 0

Returns

GamepadAxisState

getRightStick()

getRightStick(gamepadIndex): GamepadAxisState

Defined in: input/GamepadManager.ts:234

Get right stick as

Parameters

gamepadIndex

number = 0

Returns

GamepadAxisState

isConnected()

isConnected(index): boolean

Defined in: input/GamepadManager.ts:147

Check if a gamepad is connected

Parameters

index

number = 0

Returns

boolean

isPressed()

isPressed(buttonIndex, gamepadIndex): boolean

Defined in: input/GamepadManager.ts:161

Check if a button is currently pressed

Parameters

buttonIndex

number

gamepadIndex

number = 0

Returns

boolean

justPressed()

justPressed(buttonIndex, gamepadIndex): boolean

Defined in: input/GamepadManager.ts:170

Check if a button was just pressed this frame

Parameters

buttonIndex

number

gamepadIndex

number = 0

Returns

boolean

justReleased()

justReleased(buttonIndex, gamepadIndex): boolean

Defined in: input/GamepadManager.ts:178

Check if a button was just released this frame

Parameters

buttonIndex

number

gamepadIndex

number = 0

Returns

boolean

onConnected()

onConnected(callback): void

Defined in: input/GamepadManager.ts:305

Parameters

callback

GamepadCallback

Returns

void

onDisconnected()

onDisconnected(callback): void

Defined in: input/GamepadManager.ts:312

Parameters

callback

GamepadCallback

Returns

void

removeCallback()

removeCallback(callback, type): void

Defined in: input/GamepadManager.ts:319

Remove a callback

Parameters

callback

GamepadCallback

type

"connected" | "disconnected"

Returns

void

setDeadzone()

setDeadzone(deadzone): void

Defined in: input/GamepadManager.ts:260

Set the deadzone for analog sticks (0-1)

Parameters

deadzone

number

Returns

void

update()

update(): void

Defined in: input/GamepadManager.ts:84

Poll gamepads and update state (call once per frame before checking inputs)

Returns

void

vibrate()

vibrate(duration, weakMagnitude, strongMagnitude, gamepadIndex): Promise<boolean>

Defined in: input/GamepadManager.ts:278

Vibrate/rumble the gamepad

Parameters

duration

number = 200

Duration in milliseconds

weakMagnitude

number = 0.5

Weak motor magnitude (0-1)

strongMagnitude

number = 0.5

Strong motor magnitude (0-1)

gamepadIndex

number = 0

Gamepad index

Returns

Promise<boolean>

KeyboardManager

Defined in: input/KeyboardManager.ts:21

Constructors

Constructor

new KeyboardManager(element): KeyboardManager

Defined in: input/KeyboardManager.ts:40

Create a new keyboard manager

Parameters

element

Element to attach listeners to (default: window)

HTMLElement | Window

Returns

KeyboardManager

Methods

clear()

clear(): void

Defined in: input/KeyboardManager.ts:220

Clear all key states

Returns

void

destroy()

destroy(): void

Defined in: input/KeyboardManager.ts:383

Remove event listeners and cleanup

Returns

void

getDirection()

getDirection(options): DirectionVector

Defined in: input/KeyboardManager.ts:239

Get direction vector from WASD/Arrow keys

Parameters

options

DirectionOptions = {}

Options for direction calculation

Returns

DirectionVector

Direction vector {x, y} with values -1, 0, or 1 (or normalized)

Example

const dir = keyboard.getDirection()
if (dir.x !== 0 || dir.y !== 0) {
  player.move(dir.x, dir.y)
}

getPressed()

getPressed(): string[]

Defined in: input/KeyboardManager.ts:205

Get array of all currently pressed keys

Returns

string[]

isDown()

isDown(key): boolean

Defined in: input/KeyboardManager.ts:112

Alias for isPressed - check if a key is currently down

Parameters

key

string

Key to check

Returns

boolean

true if the key is currently pressed

Example

if (keyboard.isDown('Space')) {
  player.jump()
}

isPressed()

isPressed(key): boolean

Defined in: input/KeyboardManager.ts:96

Check if a key is currently pressed

Parameters

key

string

Returns

boolean

justPressed()

justPressed(key): boolean

Defined in: input/KeyboardManager.ts:119

Check if a key was just pressed this frame

Parameters

key

string

Returns

boolean

justReleased()

justReleased(key): boolean

Defined in: input/KeyboardManager.ts:126

Check if a key was just released this frame

Parameters

key

string

Returns

boolean

onKeyDown()

onKeyDown(key, callback): void

Defined in: input/KeyboardManager.ts:144

Parameters

key

Single key or array of keys to bind

string | string[]

callback

KeyCallback

Callback function to execute

Returns

void

Example

// Single key
keyboard.onKeyDown('Enter', () => console.log('Enter pressed'))

// Multiple keys (alternative bindings)
keyboard.onKeyDown(['ArrowUp', 'w', 'W'], () => player.moveUp())

onKeyUp()

onKeyUp(key, callback): void

Defined in: input/KeyboardManager.ts:169

Parameters

key

Single key or array of keys to bind

string | string[]

callback

KeyCallback

Callback function to execute

Returns

void

Example

// Single key
keyboard.onKeyUp('Space', () => player.stopJumping())

// Multiple keys (alternative bindings)
keyboard.onKeyUp(['ArrowLeft', 'a', 'A'], () => player.stopMovingLeft())

removeCallback()

removeCallback(key, callback, type): void

Defined in: input/KeyboardManager.ts:183

Remove a callback

Parameters

key

string

callback

KeyCallback

type

"keydown" | "keyup"

Returns

void

update()

update(): void

Defined in: input/KeyboardManager.ts:212

Clear just pressed/released states (call once per frame)

Returns

void

waitForKey()

waitForKey(key?, options?): Promise<string>

Defined in: input/KeyboardManager.ts:301

Wait for a specific key press (promise-based)

Parameters

key?

Key or array of keys to wait for (omit for any key)

string | string[]

options?

WaitForKeyOptions = {}

Timeout and abort signal options

Returns

Promise<string>

Promise that resolves with the pressed key

Example

// Wait for Enter
const key = await keyboard.waitForKey('Enter')

// Wait for Y or N with timeout
try {
  const key = await keyboard.waitForKey(['y', 'n'], { timeout: 5000 })
  if (key === 'y') console.log('Yes!')
} catch {
  console.log('Timeout!')
}

MouseManager

Defined in: input/MouseManager.ts:21

Deprecated

Use PointerManager instead. MouseManager is deprecated and will be removed in a future version.

Constructors

Constructor

new MouseManager(element, gridWidth, gridHeight, cellWidth, cellHeight): MouseManager

Defined in: input/MouseManager.ts:57

MouseManager

Methods

clear()

clear(): void

Defined in: input/MouseManager.ts:326

Clear all button states

Returns

void

destroy()

destroy(): void

Defined in: input/MouseManager.ts:336

Remove event listeners and cleanup

Returns

void

getDragDelta()

getDragDelta(): MousePosition

Defined in: input/MouseManager.ts:280

Get drag delta from start position

Returns

getGridPosition()

getGridPosition(): MousePosition

Defined in: input/MouseManager.ts:240

Get current mouse position in grid coordinates

Returns

getPosition()

getPosition(): MousePosition

Defined in: input/MouseManager.ts:233

Get current mouse position in pixels

Returns

getWorldPosition()

getWorldPosition(cameraX, cameraY): MousePosition

Defined in: input/MouseManager.ts:247

Get mouse position in world coordinates

Parameters

cameraX

number

cameraY

number

Returns

isDragging()

isDragging(): boolean

Defined in: input/MouseManager.ts:273

Check if currently dragging

Returns

boolean

isHovering()

isHovering(): boolean

Defined in: input/MouseManager.ts:258

Check if mouse is hovering over element

Returns

boolean

isHoveringCell()

isHoveringCell(x, y): boolean

Defined in: input/MouseManager.ts:265

Check if hovering over specific grid cell

Parameters

x

number

y

number

Returns

boolean

isLeftPressed()

isLeftPressed(): boolean

Defined in: input/MouseManager.ts:198

Check if left mouse button is pressed

Returns

boolean

isMiddlePressed()

isMiddlePressed(): boolean

Defined in: input/MouseManager.ts:212

Check if middle mouse button is pressed

Returns

boolean

isPressed()

isPressed(button): boolean

Defined in: input/MouseManager.ts:191

Check if mouse button is currently pressed

Parameters

button

number

Returns

boolean

isRightPressed()

isRightPressed(): boolean

Defined in: input/MouseManager.ts:205

Check if right mouse button is pressed

Returns

boolean

justPressed()

justPressed(button): boolean

Defined in: input/MouseManager.ts:219

Check if button was just pressed this frame

Parameters

button

number

Returns

boolean

justReleased()

justReleased(button): boolean

update(): void

Defined in: input/MouseManager.ts:318

Clear just pressed/released states (call once per frame)

Returns

void

PointerManager

Defined in: input/PointerManager.ts:19

Constructors

Constructor

new PointerManager(element, gridWidth, gridHeight, cellWidth, cellHeight): PointerManager

Defined in: input/PointerManager.ts:57

PointerManager

Methods

clear()

clear(): void

Defined in: input/PointerManager.ts:347

Clear all button states

Returns

void

destroy()

destroy(): void

Defined in: input/PointerManager.ts:357

Remove event listeners and cleanup

Returns

void

getDragDelta()

getDragDelta(): PointerPosition

Defined in: input/PointerManager.ts:301

Get drag delta from start position

Returns

getGridPosition()

getGridPosition(): PointerPosition

Defined in: input/PointerManager.ts:246

Get current pointer position in grid coordinates

Returns

getPointerType()

getPointerType(): string

Defined in: input/PointerManager.ts:264

Get the type of pointer device (mouse, touch, pen, or empty string)

Returns

string

getPosition()

getPosition(): PointerPosition

Defined in: input/PointerManager.ts:239

Get current pointer position in pixels

Returns

getPressure()

getPressure(): number

Defined in: input/PointerManager.ts:272

Get the pressure of the pointer (0.0 to 1.0) Useful for pen input with pressure sensitivity

Returns

number

getWorldPosition()

getWorldPosition(cameraX, cameraY): PointerPosition

Defined in: input/PointerManager.ts:253

Get pointer position in world coordinates

Parameters

cameraX

number

cameraY

number

Returns

isDragging()

isDragging(): boolean

Defined in: input/PointerManager.ts:294

Check if currently dragging

Returns

boolean

isHovering()

isHovering(): boolean

Defined in: input/PointerManager.ts:279

Check if pointer is hovering over element

Returns

boolean

isHoveringCell()

isHoveringCell(x, y): boolean

Defined in: input/PointerManager.ts:286

Check if hovering over specific grid cell

Parameters

x

number

y

number

Returns

boolean

isLeftPressed()

isLeftPressed(): boolean

Defined in: input/PointerManager.ts:204

Check if left pointer button is pressed

Returns

boolean

isMiddlePressed()

isMiddlePressed(): boolean

Defined in: input/PointerManager.ts:218

Check if middle pointer button is pressed

Returns

boolean

isPressed()

isPressed(button): boolean

Defined in: input/PointerManager.ts:197

Check if pointer button is currently pressed

Parameters

button

number

Returns

boolean

isRightPressed()

isRightPressed(): boolean

Defined in: input/PointerManager.ts:211

Check if right pointer button is pressed

Returns

boolean

justPressed()

justPressed(button): boolean

Defined in: input/PointerManager.ts:225

Check if button was just pressed this frame

Parameters

button

number

Returns

boolean

justReleased()

justReleased(button): boolean

update(): void

Defined in: input/PointerManager.ts:339

Clear just pressed/released states (call once per frame)

Returns

void

Renderer

Defined in: core/Renderer.ts:80

Main renderer class providing drawing primitives and higher-level helpers

Constructors

Constructor

new Renderer(target, options): Renderer

Defined in: core/Renderer.ts:103

Create a new Renderer

Parameters

target

RenderTarget

Render target to output to

options

RendererCreateOptions = {}

Renderer options

Returns

ShowPointerCoordsOptions

Properties

debug

readonly debug: object

Defined in: core/Renderer.ts:1285

Debug namespace providing visualization and inspection tools

logCell()

logCell: (x, y) => CellInfo | null

Get detailed information about a cell

Parameters

x

number

X coordinate of the cell

y

number

Y coordinate of the cell

Returns

CellInfo | null

Cell information object, or null if out of bounds

showBounds()

showBounds: (x, y, width, height, options?) => this

this

The renderer instance for chaining

showFPS()

showFPS: (fps, options?) => this

Display FPS (frames per second) counter

Parameters

fps

number

Current FPS value

options?

ShowFPSOptions

FPS display options

Returns

this

The renderer instance for chaining

showGrid()

showGrid: (options?) => this

Draw a grid overlay for alignment and positioning

Parameters

options?

ShowGridOptions

Grid display options

Returns

this

The renderer instance for chaining

showPointerCoords()

showPointerCoords: (pointerX, pointerY, options?) => this

Display pointer/mouse coordinates

Parameters

pointerX

number

Pointer X grid coordinate

pointerY

number

Pointer Y grid coordinate

options?

Display options

Returns

this

The renderer instance for chaining

height

readonly height: number

Defined in: core/Renderer.ts:96

Height in characters

width

readonly width: number

Defined in: core/Renderer.ts:93

Width in characters

Accessors

validate

Get Signature

get validate(): object

Defined in: core/Renderer.ts:1545

Validation helpers for bounds checking

Provides methods to check if drawing operations would be within bounds before attempting to draw. Useful for conditional rendering logic.

Returns

box()

box: (x, y, width, height) => boolean

if (renderer.validate.box(x, y, 20, 10)) {
  renderer.box(x, y, 20, 10)
} else {
  console.warn('Box out of bounds')
}

cell()

cell: (x, y) => boolean

Check if a cell position is within bounds

Parameters

x

number

X coordinate

y

number

Y coordinate

Returns

boolean

True if position is valid, false otherwise

Example

if (renderer.validate.cell(x, y)) {
  renderer.setChar(x, y, '@')
}

line()

line: (x1, y1, x2, y2) => boolean

if (renderer.validate.line(x1, y1, x2, y2)) {
  renderer.drawLine(x1, y1, x2, y2, '-')
}

text()

text: (x, y, text) => boolean

Check if text would fit within bounds

Parameters

x

number

Starting X coordinate

y

number

Y coordinate

text

string

Text string to check

Returns

boolean

True if text fits entirely within bounds, false otherwise

Example

if (renderer.validate.text(x, y, message)) {
  renderer.drawText(x, y, message)
} else {
  // Truncate or wrap text
  renderer.drawText(x, y, message.substring(0, 10))
}

Methods

alignBox()

alignBox(anchor, width, height, offsetX, offsetY): object

Defined in: core/Renderer.ts:626

Calculate aligned box position

Returns the (x, y) position for a box aligned to a specific anchor point within the viewport. Useful for positioning dialogs, menus, and UI elements.

Parameters

anchor

BoxAnchor

Alignment anchor (center, top, bottom, left, right, or combinations)

width

number

Box width

height

number

Box height

offsetX

number = 0

X offset from anchor position (default: 0)

offsetY

number = 0

Y offset from anchor position (default: 0)

Returns

object

Object with x and y coordinates

x

x: number

y

y: number

Example

// Center a 30x10 dialog
const pos = renderer.alignBox('center', 30, 10)
renderer.box(pos.x, pos.y, 30, 10, { style: 'double' })

// Top-right notification with offset
const notifPos = renderer.alignBox('top-right', 20, 5, -2, 1)
renderer.box(notifPos.x, notifPos.y, 20, 5)

alignText()

alignText(y, text, options, startX, width?): this

Defined in: core/Renderer.ts:804

Draw aligned text using options.align property

Generic text alignment that uses the align property from TextOptions. Delegates to centerText, rightAlign, or leftAlign based on the setting.

Parameters

y

number

Y coordinate for the text

text

string

Text to draw

options

TextOptions = {}

Text styling options (including align property)

startX

number = 0

Starting X coordinate of alignment area (default: 0)

width?

number

Width of alignment area (default: screen width)

Returns

this

The renderer instance for chaining

Example

renderer
  .alignText(5, 'Title', { align: 'center', fg: 'yellow' })
  .alignText(10, 'Score', { align: 'right', fg: 'green' })
  .render()

animate()

animate(options?): number

Defined in: core/Renderer.ts:1245

Parameters

options?

AnimateOptions

Returns

number

applyBoxPreset()

applyBoxPreset(x, y, width, height, presetName, overrides?): this

Defined in: core/Renderer.ts:1457

definePreset('panel', { type: 'box', style: 'double', fill: true })
renderer.applyBoxPreset(0, 0, 80, 24, 'panel')

applyMenuPreset()

applyMenuPreset(x, y, items, presetName, overrides?): this

Defined in: core/Renderer.ts:1493

Apply a menu preset

Parameters

x

number

X coordinate

y

number

Y coordinate

items

string[]

Menu items

presetName

string

Name of the menu preset

overrides?

MenuOptions

Optional overrides for preset options

Returns

this

The renderer instance for chaining

Example

definePreset('mainMenu', {
  type: 'menu',
  selectedFg: 'black',
  selectedBg: 'cyan',
  border: true
})
renderer.applyMenuPreset(10, 5, ['Start', 'Quit'], 'mainMenu', {
  selected: 0
})

applyProgressBarPreset()

applyProgressBarPreset(x, y, width, progress, presetName, overrides?): this

Defined in: core/Renderer.ts:1526

definePreset('health', {
  type: 'progressBar',
  fillFg: 'red',
  emptyFg: 'gray'
})
renderer.applyProgressBarPreset(5, 5, 20, 0.75, 'health')

applyTextPreset()

applyTextPreset(x, y, text, presetName, overrides?): this

Defined in: core/Renderer.ts:1428

Apply a text preset

Parameters

x

number

X coordinate

y

number

Y coordinate

text

string

Text to draw

presetName

string

Name of the text preset

overrides?

TextOptions

Optional overrides for preset options

Returns

this

The renderer instance for chaining

Example

// Define preset first
definePreset('warning', { type: 'text', fg: 'yellow', bg: 'red' })

// Use preset
renderer.applyTextPreset(10, 5, 'Warning!', 'warning')

border()

border(x, y, w, h, options): this

Defined in: core/Renderer.ts:520

Draw a border without filling the interior

this

The renderer instance for chaining

Example

renderer
  .drawText(12, 7, 'Important!')
  .border(10, 5, 20, 5, { style: 'double', fg: 'red' })
  .render()

box()

box(x, y, w, h, options): this

Defined in: core/Renderer.ts:488

Draw a box with borders and optional fill

this

The renderer instance for chaining

Example

renderer
  .box(10, 5, 30, 10, { style: 'double', fg: 'cyan' })
  .box(15, 8, 20, 5, { style: 'rounded', fill: true, bg: 'blue' })
  .render()

centerBox()

centerBox(width, height, options, offsetX, offsetY): this

Defined in: core/Renderer.ts:665

Draw a centered box

Convenience method that combines alignBox('center') and box(). Centers a box in the viewport and draws it in one call.

Parameters

width

number

Box width

height

number

Box height

options

BoxOptions = {}

Box styling options

offsetX

number = 0

X offset from center (default: 0)

offsetY

number = 0

Y offset from center (default: 0)

Returns

this

The renderer instance for chaining

Example

renderer
  .centerBox(40, 15, { style: 'double', fill: true, fg: 'cyan' })
  .centerText(10, 'GAME OVER', { fg: 'red' })
  .render()

centerText()

centerText(y, text, options, startX, width?): this

Defined in: core/Renderer.ts:697

Draw centered text

Centers text horizontally within a specified width or the entire screen. Useful for titles, menus, and dialog boxes.

Parameters

y

number

Y coordinate for the text

text

string

Text to draw

options

TextOptions = {}

Text styling options

startX

number = 0

Starting X coordinate of centering area (default: 0)

width?

number

Width of centering area (default: screen width)

Returns

this

The renderer instance for chaining

Example

renderer
  .centerText(5, 'GAME TITLE', { fg: 'yellow' })
  .centerText(10, 'Centered in box', {}, 10, 30) // Center within x=10 to x=40
  .render()

clear()

clear(): this

Defined in: core/Renderer.ts:401

Clear the current layer's buffer

Removes all drawn content from the current layer. Does not affect other layers or the render target. Call render() to flush changes to the screen.

Returns

this

The renderer instance for chaining

Example

renderer
  .clear() // Clear everything
  .drawText(0, 0, 'Fresh start')
  .render()

clearCameraBounds()

clearCameraBounds(): this

Defined in: core/Renderer.ts:1149

Clear camera bounds

Removes any camera movement restrictions, allowing unlimited scrolling.

Returns

this

The renderer instance for chaining

Example

renderer
  .clearCameraBounds()
  .setCamera(1000, 1000) // No longer restricted
  .render()

clearLayer()

clearLayer(name): this

Defined in: core/Renderer.ts:926

Clear a specific layer

Removes all content from the specified layer. The layer itself remains and stays visible.

Parameters

name

string

Name of the layer to clear

Returns

this

The renderer instance for chaining

Example

renderer
  .clearLayer('effects')
  .render()

drawLine()

drawLine(x1, y1, x2, y2, char, options): this

Defined in: core/Renderer.ts:590

Draw a line between two points

renderer
  .drawLine(0, 0, 10, 10, '/', { fg: 'cyan' })
  .drawLine(10, 0, 0, 10, '\\', { fg: 'cyan' })
  .drawLine(5, 0, 5, 10, '|', { fg: 'yellow' })
  .render()

drawText()

drawText(x, y, text, options): this

Defined in: core/Renderer.ts:330

Draw a text string

Draws text horizontally starting at the specified position. Each character is drawn sequentially to the right.

Parameters

x

number

Starting X coordinate

y

number

Y coordinate

text

string

Text string to draw

options

TextOptions = {}

Text styling options (fg, bg, wrap, align)

Returns

this

The renderer instance for chaining

Example

renderer
  .drawText(5, 10, 'Hello, World!', { fg: 'cyan' })
  .drawText(5, 11, 'Press any key', { fg: 'gray' })
  .render()

exportAsANSI()

exportAsANSI(): string

Defined in: core/Renderer.ts:1382

Export buffer as ANSI-colored text

Returns

string

ANSI-colored text string

Example

const ansi = renderer.exportAsANSI()
console.log(ansi) // Displays with colors in terminal

exportAsDataURL()

exportAsDataURL(format?, options?): Promise<string>

Defined in: core/Renderer.ts:1400

Export buffer as image data URL

Parameters

format?

ImageFormat

Image format ('png' or 'jpeg')

options?

ExportImageOptions

Image export options

Returns

Promise<string>

Promise resolving to data URL string

Example

const dataURL = await renderer.exportAsDataURL('png')
const img = document.createElement('img')
img.src = dataURL

exportAsString()

exportAsString(): string

Defined in: core/Renderer.ts:1367

Export buffer as plain text string

Returns

string

Plain text representation of the buffer

Example

const text = renderer.exportAsString()
console.log(text)

fill()

fill(x, y, w, h, char, fg?, bg?): this

Defined in: core/Renderer.ts:367

Fill a rectangular area

this

The renderer instance for chaining

Example

renderer
  .fill(10, 5, 20, 10, ' ', null, 'blue') // Blue background box
  .fill(15, 7, 5, 3, '░', 'gray') // Textured area
  .render()

flash()

flash(x, y, options?): number

Defined in: core/Renderer.ts:1249

Parameters

x

number

y

number

options?

FlashOptions

Returns

number

follow()

follow(targetX, targetY): this

Defined in: core/Renderer.ts:1196

Center camera on target position

Moves the camera to center on a specific world position. Useful for following a player character or focusing on important events.

Parameters

targetX

number

World X coordinate to center on

targetY

number

World Y coordinate to center on

Returns

this

The renderer instance for chaining

Example

const player = { x: 150, y: 75 }
renderer
  .follow(player.x, player.y) // Camera centers on player
  .setChar(player.x, player.y, '@', 'yellow')
  .render()

getActiveAnimationCount()

getActiveAnimationCount(): number

Defined in: core/Renderer.ts:1272

Returns

number

getCamera()

getCamera(): object

Defined in: core/Renderer.ts:1098

Get current camera position

Returns the camera's current position in world coordinates.

Returns

object

Object with x and y camera coordinates

x

x: number

y

y: number

Example

const { x, y } = renderer.getCamera()
console.log(`Camera at (${x}, ${y})`)

getCell()

getCell(x, y): Cell | undefined

Defined in: core/Renderer.ts:463

Get cell at position from current layer

Retrieves the cell data at the specified screen coordinates. Returns undefined if nothing is drawn at that position.

Parameters

x

number

X coordinate

y

number

Y coordinate

Returns

Cell | undefined

The cell data or undefined

Example

const cell = renderer.getCell(10, 5)
if (cell) {
  console.log(cell.char, cell.fg, cell.bg)
}

hideLayer()

hideLayer(name): this

Defined in: core/Renderer.ts:885

Hide a layer

Makes a layer invisible without deleting its contents. Hidden layers are not included in rendering.

Parameters

name

string

Name of the layer to hide

Returns

this

The renderer instance for chaining

Example

renderer
  .hideLayer('debug')
  .render() // Debug layer won't be visible

isAnimationActive()

isAnimationActive(animationId): boolean

Defined in: core/Renderer.ts:1276

Parameters

animationId

number

Returns

boolean

layer()

layer(name): this

Defined in: core/Renderer.ts:843

Select or create a layer

Switches the current drawing context to the specified layer. Layers are created automatically if they don't exist. All subsequent drawing operations affect the current layer.

Parameters

name

string

Name of the layer to select/create

Returns

this

The renderer instance for chaining

Example

renderer
  .layer('background').fill(0, 0, 80, 24, ' ', null, 'blue')
  .layer('ui').box(10, 5, 20, 10, { style: 'double' })
  .layerOrder(['background', 'ui'])
  .render()

layerOrder()

layerOrder(order): this

Defined in: core/Renderer.ts:864

Set layer rendering order

Defines the order in which layers are composited. Layers listed first are rendered at the bottom, last ones on top.

Parameters

order

string[]

Array of layer names in rendering order (bottom to top)

Returns

this

The renderer instance for chaining

Example

renderer
  .layerOrder(['background', 'entities', 'ui', 'effects'])
  .render()

leftAlign()

leftAlign(y, text, options, offsetX): this

Defined in: core/Renderer.ts:773

Draw left-aligned text

Draws text starting at a specified X offset. Primarily for consistency with centerText and rightAlign.

Parameters

y

number

Y coordinate for the text

text

string

Text to draw

options

TextOptions = {}

Text styling options

offsetX

number = 0

X offset from left edge (default: 0)

Returns

this

The renderer instance for chaining

Example

renderer
  .leftAlign(5, 'Menu Item 1', { fg: 'white' })
  .leftAlign(6, 'Menu Item 2', { fg: 'white' }, 2) // Indent by 2
  .render()

menu(x, y, items, options): this

Defined in: core/Renderer.ts:1038

Draw a menu with selectable items

Renders a list of menu items with visual indication of the selected item. Supports borders, titles, and customizable selection indicators.

Parameters

x

number

Top-left X coordinate

y

number

Top-left Y coordinate

items

string[]

Array of menu item strings

options

MenuOptions = {}

Menu styling options (selected, colors, indicator, border, title, etc.)

Returns

this

The renderer instance for chaining

Example

renderer
  .menu(20, 10, ['New Game', 'Load Game', 'Options', 'Quit'], {
    selected: 0,
    indicator: '>',
    border: true,
    title: 'Main Menu',
    selectedFg: 'black',
    selectedBg: 'yellow'
  })
  .render()

moveCamera()

moveCamera(dx, dy): this

Defined in: core/Renderer.ts:1172

Move camera by delta

Moves the camera relative to its current position. Positive values move the camera right/down in world space.

Parameters

dx

number

Change in X position

dy

number

Change in Y position

Returns

this

The renderer instance for chaining

Example

renderer
  .moveCamera(5, 0) // Pan camera 5 units right
  .moveCamera(0, -3) // Pan camera 3 units up
  .render()

panel()

panel(x, y, width, height, options): this

Defined in: core/Renderer.ts:1001

Draw a panel with border, title, and content

this

The renderer instance for chaining

Example

renderer
  .panel(10, 5, 40, 15, {
    title: 'Inventory',
    content: ['Sword', 'Shield', 'Potion x3'],
    style: 'double',
    fg: 'cyan',
    padding: 1
  })
  .render()

progressBar()

progressBar(x, y, length, progress, options): this

Defined in: core/Renderer.ts:957

Draw a progress bar

this

The renderer instance for chaining

Example

renderer
  .progressBar(10, 5, 30, 0.75, {
    style: 'blocks',
    fillFg: 'green',
    emptyFg: 'gray',
    showPercent: true
  })
  .progressBar(50, 10, 10, 0.5, { vertical: true })
  .render()

pulse()

pulse(x, y, options?): number

Defined in: core/Renderer.ts:1253

Parameters

x

number

y

number

options?

PulseOptions

Returns

number

rect()

rect(x, y, w, h, fillChar, fg?, bg?): this

Defined in: core/Renderer.ts:554

Draw a filled rectangle without borders

this

The renderer instance for chaining

Example

renderer
  .rect(10, 5, 20, 10, ' ', null, 'blue') // Solid blue rectangle
  .rect(15, 8, 10, 5, '█', 'red') // Solid block pattern
  .render()

render()

render(): this

Defined in: core/Renderer.ts:423

Render all layers to the target

Composites all visible layers in order and flushes the result to the render target. This is when drawing actually becomes visible.

Returns

this

The renderer instance for chaining

Example

renderer
  .clear()
  .box(10, 5, 20, 10)
  .drawText(12, 7, 'Game Over')
  .render() // Now visible on screen

resetCamera()

resetCamera(): this

Defined in: core/Renderer.ts:1080

Reset camera to origin (0, 0)

Moves the camera back to the world origin.

Returns

this

The renderer instance for chaining

Example

renderer
  .resetCamera()
  .render()

rightAlign()

rightAlign(y, text, options, startX, width?): this

Defined in: core/Renderer.ts:735

Draw right-aligned text

Aligns text to the right edge of a specified area.

Parameters

y

number

Y coordinate for the text

text

string

Text to draw

options

TextOptions = {}

Text styling options

startX

number = 0

Starting X coordinate of alignment area (default: 0)

width?

number

Width of alignment area (default: screen width)

Returns

this

The renderer instance for chaining

Example

renderer
  .rightAlign(5, 'Score: 1000', { fg: 'green' })
  .rightAlign(10, 'HP: 75/100', {}, 50, 30) // Right-align within x=50 to x=80
  .render()

screenToWorld()

screenToWorld(screenX, screenY): object

Defined in: core/Renderer.ts:1239

Convert screen coordinates to world coordinates

Transforms a screen position to its corresponding world position based on the current camera position. Useful for mouse input handling.

Parameters

screenX

number

X coordinate in screen space

screenY

number

Y coordinate in screen space

Returns

object

Object with world x and y coordinates

x

x: number

y

y: number

Example

mouseManager.onClick((pos) => {
  const world = renderer.screenToWorld(pos.x, pos.y)
  console.log(`Clicked world position (${world.x}, ${world.y})`)
})

setCamera()

setCamera(x, y): this

Defined in: core/Renderer.ts:1061

Set camera position (top-left of viewport in world coordinates)

Positions the camera at specific world coordinates. All subsequent drawing uses world coordinates, which are transformed by the camera.

Parameters

x

number

Camera X position in world space

y

number

Camera Y position in world space

Returns

this

The renderer instance for chaining

Example

renderer
  .setCamera(100, 50) // View world at (100, 50)
  .setChar(105, 55, '@') // Draw at world position (105, 55)
  .render() // Character appears at screen position (5, 5)

setCameraBounds()

setCameraBounds(minX, minY, maxX, maxY): this

Defined in: core/Renderer.ts:1124

Set camera bounds to limit scrolling area

// Limit camera to a 100x50 world map
renderer
  .setCameraBounds(0, 0, 100, 50)
  .follow(player.x, player.y) // Auto-clamped to bounds
  .render()

setChar()

setChar(x, y, char, fg?, bg?): this

Defined in: core/Renderer.ts:296

Set a character at position (world coordinates)

The fundamental drawing primitive. Positions are in world coordinates, which are transformed by the camera before rendering.

Parameters

x

number

X coordinate in world space

y

number

Y coordinate in world space

char

string

Character to display

fg?

Foreground color (defaults to renderer's defaultFg)

bg?

Background color (defaults to renderer's defaultBg)

Returns

this

The renderer instance for chaining

Example

renderer
  .setChar(10, 5, '@', 'yellow', 'black')
  .setChar(11, 5, '#', 'green')
  .render()

setClipMode()

setClipMode(enabled): this

Defined in: core/Renderer.ts:252

Enable or disable clip mode

When enabled, clips drawing operations to stay within bounds. Useful for preventing visual artifacts when drawing near edges.

Parameters

enabled

boolean

True to enable clip mode, false to disable

Returns

this

The renderer instance for chaining

Example

renderer
  .setClipMode(true)
  .drawText(75, 10, 'This text will be clipped at screen edge')

setSafeMode()

setSafeMode(enabled): this

Defined in: core/Renderer.ts:231

Enable or disable safe mode

When enabled, throws errors for out-of-bounds operations. When disabled, silently ignores out-of-bounds operations.

Parameters

enabled

boolean

True to enable safe mode, false to disable

Returns

this

The renderer instance for chaining

Example

renderer
  .setSafeMode(true)
  .setChar(100, 100, 'X') // Will throw if out of bounds

showLayer()

showLayer(name): this

Defined in: core/Renderer.ts:905

Show a layer

Makes a previously hidden layer visible again.

Parameters

name

string

Name of the layer to show

Returns

this

The renderer instance for chaining

Example

renderer
  .showLayer('debug')
  .render() // Debug layer is now visible

stopAllAnimations()

stopAllAnimations(): this

Defined in: core/Renderer.ts:1262

Returns

this

stopAnimation()

stopAnimation(animationId): this

Defined in: core/Renderer.ts:1257

Parameters

animationId

number

Returns

this

updateAnimations()

updateAnimations(currentTime?): this

Defined in: core/Renderer.ts:1267

Parameters

currentTime?

number

Returns

this

worldToScreen()

worldToScreen(worldX, worldY): object

Defined in: core/Renderer.ts:1217

Convert world coordinates to screen coordinates

Transforms a world position to its corresponding screen position based on the current camera position.

Parameters

worldX

number

X coordinate in world space

worldY

number

Y coordinate in world space

Returns

object

Object with screen x and y coordinates

x

x: number

y

y: number

Example

const screen = renderer.worldToScreen(100, 50)
console.log(`World (100, 50) is at screen (${screen.x}, ${screen.y})`)

forCanvas()

static forCanvas(canvas, options): Renderer

Defined in: core/Renderer.ts:167

Create a Renderer for Canvas with improved, semantic API

Modern factory method with better parameter grouping for improved DX. Recommended over fromCanvas() for new code.

Parameters

canvas

HTMLCanvasElement

HTML Canvas element to render to

options

CanvasRendererOptions

Grouped configuration options

Returns

A new Renderer instance configured for the canvas

Example

const renderer = Renderer.forCanvas(canvas, {
  grid: { width: 80, height: 24 },
  cell: { width: 12, height: 20 },
  font: { family: 'monospace', size: 16 },
  colors: { fg: 'white', bg: 'black' }
})

fromCanvas()

static fromCanvas(canvas, canvasOptions, rendererOptions?): Renderer

Defined in: core/Renderer.ts:138

Create a Renderer from an HTML Canvas element

Convenience factory method that creates a CanvasTarget and Renderer in one step. Simplifies the common pattern of creating a canvas-based renderer.

Parameters

canvas

HTMLCanvasElement

HTML Canvas element to render to

canvasOptions

CanvasTargetOptions

Canvas target configuration (width, height, charWidth, etc.)

rendererOptions?

RendererCreateOptions

Optional renderer configuration (colors, autoClear)

Returns

A new Renderer instance configured for the canvas

Example

// Instead of:
const target = new CanvasTarget(canvas, { width: 80, height: 24 })
const renderer = new Renderer(target)

// Use:
const renderer = Renderer.fromCanvas(canvas, { width: 80, height: 24 })

Interfaces

AnimateOptions

Defined in: types/types.ts:286

Options for animate()

Properties

delay?

optional delay: number

Defined in: types/types.ts:298

Delay before starting in milliseconds

duration?

optional duration: number

Defined in: types/types.ts:288

Animation duration in milliseconds

easing?

optional easing: EasingFunction

Defined in: types/types.ts:290

Easing function

loop?

optional loop: boolean

Defined in: types/types.ts:296

Whether to loop the animation

onComplete?

optional onComplete: AnimationCompleteCallback

Defined in: types/types.ts:294

Callback called when animation completes

onUpdate?

optional onUpdate: AnimationCallback

Defined in: types/types.ts:292

Callback called on each frame with progress (0.0 to 1.0)

BorderChars

Defined in: types/types.ts:66

Custom border characters

Properties

bottomLeft

bottomLeft: string

Defined in: types/types.ts:69

bottomRight

bottomRight: string

Defined in: types/types.ts:70

horizontal

horizontal: string

Defined in: types/types.ts:71

topLeft

topLeft: string

Defined in: types/types.ts:67

topRight

topRight: string

Defined in: types/types.ts:68

vertical

vertical: string

Defined in: types/types.ts:72

BoxOptions

Defined in: types/types.ts:78

Options for drawing a box

Properties

bg?

optional bg: Color

Defined in: types/types.ts:84

Background color

fg?

optional fg: Color

Defined in: types/types.ts:82

Foreground color

fill?

optional fill: boolean

Defined in: types/types.ts:86

Fill the box interior

fillChar?

optional fillChar: string

Defined in: types/types.ts:88

Character to fill with when fill is true

padding?

optional padding: number

Defined in: types/types.ts:92

Inner padding

shadow?

optional shadow: boolean

Defined in: types/types.ts:90

Add shadow effect

style?

optional style: BoxStyle | BorderChars

Defined in: types/types.ts:80

Border style to use

title?

optional title: string

Defined in: types/types.ts:94

Optional title to display in the top border

titleAlign?

optional titleAlign: TextAlign

Defined in: types/types.ts:98

Alignment of the title in the top border

titleFg?

optional titleFg: Color

Defined in: types/types.ts:96

Foreground color for the title

BoxPreset

Defined in: helpers/presetHelpers.ts:37

Box preset definition

Extends

BasePreset

Properties

options

options: BoxOptions

Defined in: helpers/presetHelpers.ts:39

Overrides

BasePreset.options

type

type: "box"

Defined in: helpers/presetHelpers.ts:38

Overrides

BasePreset.type

CanvasRendererOptions

Defined in: core/Renderer.ts:50

Options for forCanvas factory method with semantic grouping

Properties

autoClear?

optional autoClear: boolean

Defined in: core/Renderer.ts:72

Auto-clear behavior

cell?

optional cell: object

Defined in: core/Renderer.ts:57

Cell/character sizing

height?

optional height: number

width?

optional width: number

clearColor?

optional clearColor: Color

Defined in: core/Renderer.ts:74

Clear color when autoClear is enabled

colors?

optional colors: object

Defined in: core/Renderer.ts:67

Color defaults

bg?

optional bg: Color

fg?

optional fg: Color

font?

optional font: object

Defined in: core/Renderer.ts:62

Font configuration

family?

optional family: string

size?

optional size: number

grid

grid: object

Defined in: core/Renderer.ts:52

Grid dimensions

height

height: number

width

width: number

CanvasTargetOptions

Defined in: targets/CanvasTarget.ts:11

Options for CanvasTarget initialization

Properties

charHeight?

optional charHeight: number

Defined in: targets/CanvasTarget.ts:19

Character height in pixels

charWidth?

optional charWidth: number

Defined in: targets/CanvasTarget.ts:17

Character width in pixels

fontFamily?

optional fontFamily: string

Defined in: targets/CanvasTarget.ts:21

Font family

fontSize?

optional fontSize: number

Defined in: targets/CanvasTarget.ts:23

Font size in pixels

height

height: number

Defined in: targets/CanvasTarget.ts:15

Height in characters

width

width: number

Defined in: targets/CanvasTarget.ts:13

Width in characters

Cell

Defined in: types/types.ts:49

A single cell in the render buffer

Properties

bg

bg: Color

Defined in: types/types.ts:55

Background color

char

char: string

Defined in: types/types.ts:51

The character to display

fg

fg: Color

Defined in: types/types.ts:53

Foreground color

CellInfo

Defined in: helpers/debugHelpers.ts:65

Cell information returned by logCell

Properties

bg

bg: Color

Defined in: helpers/debugHelpers.ts:70

char

char: string

Defined in: helpers/debugHelpers.ts:68

fg

fg: Color

Defined in: helpers/debugHelpers.ts:69

x

x: number

Defined in: helpers/debugHelpers.ts:66

y

y: number

Defined in: helpers/debugHelpers.ts:67

DirectionOptions

Defined in: input/KeyboardManager.ts:12

Properties

normalize?

optional normalize: boolean

Defined in: input/KeyboardManager.ts:13

DirectionVector

Defined in: input/KeyboardManager.ts:7

Properties

x

x: number

Defined in: input/KeyboardManager.ts:8

y

y: number

Defined in: input/KeyboardManager.ts:9

ExportImageOptions

Defined in: helpers/exportHelpers.ts:13

Export options for data URL/image export

Properties

backgroundColor?

optional backgroundColor: Color

Defined in: helpers/exportHelpers.ts:23

Background color for transparent areas

charHeight?

optional charHeight: number

Defined in: helpers/exportHelpers.ts:17

Character height in pixels (default: 16)

charWidth?

optional charWidth: number

Defined in: helpers/exportHelpers.ts:15

Character width in pixels (default: 10)

fontFamily?

optional fontFamily: string

Defined in: helpers/exportHelpers.ts:19

Font family (default: 'monospace')

fontSize?

optional fontSize: number

Defined in: helpers/exportHelpers.ts:21

Font size in pixels (default: 14)

FlashOptions

Defined in: types/types.ts:304

Options for flash()

Properties

bg?

optional bg: Color

Defined in: types/types.ts:314

Background color

char?

optional char: string

Defined in: types/types.ts:310

Character to flash

count?

optional count: number

Defined in: types/types.ts:308

Number of times to flash

duration?

optional duration: number

Defined in: types/types.ts:306

Flash duration in milliseconds

fg?

optional fg: Color

Defined in: types/types.ts:312

Foreground color

onComplete?

optional onComplete: AnimationCompleteCallback

Defined in: types/types.ts:316

Callback when flash completes

GameLoopOptions

Defined in: core/GameLoop.ts:5

Game loop utility with fixed timestep and delta time support

Properties

fps?

optional fps: number

Defined in: core/GameLoop.ts:7

Target frames per second (default: 60)

maxFrameSkip?

optional maxFrameSkip: number

Defined in: core/GameLoop.ts:9

Maximum number of update calls per frame (prevents spiral of death)

GamepadAxisState

Defined in: input/GamepadManager.ts:14

Properties

x

x: number

Defined in: input/GamepadManager.ts:15

y

y: number

Defined in: input/GamepadManager.ts:16

GamepadButtonState

Defined in: input/GamepadManager.ts:7

Properties

justPressed

justPressed: boolean

Defined in: input/GamepadManager.ts:9

justReleased

justReleased: boolean

Defined in: input/GamepadManager.ts:10

pressed

pressed: boolean

Defined in: input/GamepadManager.ts:8

value

value: number

Defined in: input/GamepadManager.ts:11

MenuOptions

Defined in: types/types.ts:169

Options for menu rendering

Properties

bg?

optional bg: Color

Defined in: types/types.ts:175

Background color for unselected items

border?

optional border: boolean

Defined in: types/types.ts:183

Draw a border around the menu

fg?

optional fg: Color

Defined in: types/types.ts:173

Foreground color for unselected items

indicator?

optional indicator: string

Defined in: types/types.ts:181

Selection indicator character (e.g., '>' or '•')

padding?

optional padding: number

Defined in: types/types.ts:191

Padding inside the menu

selected?

optional selected: number

Defined in: types/types.ts:171

Index of selected item (0-based)

selectedBg?

optional selectedBg: Color

Defined in: types/types.ts:179

Background color for selected item

selectedFg?

optional selectedFg: Color

Defined in: types/types.ts:177

Foreground color for selected item

style?

optional style: BoxStyle

Defined in: types/types.ts:185

Box style for border

title?

optional title: string

Defined in: types/types.ts:187

Menu title (displayed in top border if border is true)

width?

optional width: number

Defined in: types/types.ts:189

Fixed width (auto-calculated if not specified)

MenuPreset

Defined in: helpers/presetHelpers.ts:45

Menu preset definition

Extends

BasePreset

Properties

options

options: MenuOptions

Defined in: helpers/presetHelpers.ts:47

Overrides

BasePreset.options

type

type: "menu"

Defined in: helpers/presetHelpers.ts:46

Overrides

BasePreset.type

MouseEvent

Defined in: input/MouseManager.ts:13

Properties

event

event: MouseEvent

Defined in: input/MouseManager.ts:16

grid

grid: MousePosition

Defined in: input/MouseManager.ts:15

pixel

pixel: MousePosition

Defined in: input/MouseManager.ts:14

MousePosition

Defined in: input/MouseManager.ts:8

Mouse input manager for handling mouse events and state

Deprecated

Use PointerManager instead for unified mouse/touch/pen support

See

PointerManager

Properties

x

x: number

Defined in: input/MouseManager.ts:9

y

y: number

Defined in: input/MouseManager.ts:10

PanelOptions

Defined in: types/types.ts:234

Options for panel rendering

Properties

bg?

optional bg: Color

Defined in: types/types.ts:246

Background color

content?

optional content: string[]

Defined in: types/types.ts:248

Content lines to display

contentAlign?

optional contentAlign: TextAlign

Defined in: types/types.ts:250

Content alignment

fg?

optional fg: Color

Defined in: types/types.ts:244

Foreground color

fill?

optional fill: boolean

Defined in: types/types.ts:254

Fill panel background

fillChar?

optional fillChar: string

Defined in: types/types.ts:256

Fill character when fill is true

optional footer: string

Defined in: types/types.ts:240

Panel footer (displayed in bottom border)

padding?

optional padding: number

Defined in: types/types.ts:258

Inner padding

scrollOffset?

optional scrollOffset: number

Defined in: types/types.ts:252

Scroll offset for content (0-based line index)

style?

optional style: BoxStyle

Defined in: types/types.ts:242

Box style for border

title?

optional title: string

Defined in: types/types.ts:236

Panel title (displayed in top border)

titleAlign?

optional titleAlign: TextAlign

Defined in: types/types.ts:238

Title alignment

Point

Defined in: types/types.ts:354

A 2D point or position

Example

const playerPos: Point = { x: 10, y: 5 };
renderer.setChar(playerPos.x, playerPos.y, '@');

Properties

x

x: number

Defined in: types/types.ts:356

X coordinate

y

y: number

Defined in: types/types.ts:358

Y coordinate

PointerEvent

Defined in: input/PointerManager.ts:11

Properties

event

event: PointerEvent

Defined in: input/PointerManager.ts:14

grid

grid: PointerPosition

Defined in: input/PointerManager.ts:13

pixel

pixel: PointerPosition

Defined in: input/PointerManager.ts:12

PointerPosition

Defined in: input/PointerManager.ts:6

Pointer input manager for handling mouse, touch, and pen events Uses the Pointer Events API for unified input handling across devices

Properties

x

x: number

Defined in: input/PointerManager.ts:7

y

y: number

Defined in: input/PointerManager.ts:8

ProgressBarOptions

Defined in: types/types.ts:202

Options for progress bar rendering

Properties

border?

optional border: boolean

Defined in: types/types.ts:216

Draw border around progress bar

borderChars?

optional borderChars: [string, string]

Defined in: types/types.ts:218

Border characters (defaults to [ and ])

emptyBg?

optional emptyBg: Color

Defined in: types/types.ts:214

Background color for empty portion

emptyChar?

optional emptyChar: string

Defined in: types/types.ts:206

Character for empty portion

emptyFg?

optional emptyFg: Color

Defined in: types/types.ts:212

Foreground color for empty portion

fillBg?

optional fillBg: Color

Defined in: types/types.ts:210

Background color for filled portion

fillChar?

optional fillChar: string

Defined in: types/types.ts:204

Character for filled portion

fillFg?

optional fillFg: Color

Defined in: types/types.ts:208

Foreground color for filled portion

label?

optional label: string

Defined in: types/types.ts:222

Custom label to display

labelPosition?

optional labelPosition: "left" | "center" | "right"

Defined in: types/types.ts:224

Label position

showPercent?

optional showPercent: boolean

Defined in: types/types.ts:220

Show percentage label

style?

optional style: ProgressBarStyle

Defined in: types/types.ts:228

Style preset

vertical?

optional vertical: boolean

Defined in: types/types.ts:226

Render vertically instead of horizontally

ProgressBarPreset

Defined in: helpers/presetHelpers.ts:53

Progress bar preset definition

Extends

BasePreset

Properties

options

options: ProgressBarOptions

Defined in: helpers/presetHelpers.ts:55

Overrides

BasePreset.options

type

type: "progressBar"

Defined in: helpers/presetHelpers.ts:54

Overrides

BasePreset.type

PulseOptions

Defined in: types/types.ts:322

Options for pulse()

Properties

bg?

optional bg: Color

Defined in: types/types.ts:336

Background color

duration?

optional duration: number

Defined in: types/types.ts:324

Pulse duration in milliseconds

easing?

optional easing: EasingFunction

Defined in: types/types.ts:330

Easing function

fg?

optional fg: Color

Defined in: types/types.ts:334

Foreground color

loop?

optional loop: boolean

Defined in: types/types.ts:332

Whether to loop the pulse

maxIntensity?

optional maxIntensity: number

Defined in: types/types.ts:328

Maximum opacity/intensity (0.0 to 1.0)

minIntensity?

optional minIntensity: number

Defined in: types/types.ts:326

Minimum opacity/intensity (0.0 to 1.0)

onComplete?

optional onComplete: AnimationCompleteCallback

Defined in: types/types.ts:338

Callback when pulse completes (only called if not looping)

Rect

Defined in: types/types.ts:370

A rectangle defined by position and dimensions

Example

const bounds: Rect = { x: 5, y: 5, width: 20, height: 10 };
renderer.box(bounds.x, bounds.y, bounds.width, bounds.height);

Properties

height

height: number

Defined in: types/types.ts:378

Height in characters

width

width: number

Defined in: types/types.ts:376

Width in characters

x

x: number

Defined in: types/types.ts:372

X coordinate of top-left corner

y

y: number

Defined in: types/types.ts:374

Y coordinate of top-left corner

RendererCreateOptions

Defined in: core/Renderer.ts:36

Renderer initialization options

Properties

autoClear?

optional autoClear: boolean

Defined in: core/Renderer.ts:42

Auto-clear the render target each frame

clearColor?

optional clearColor: Color

Defined in: core/Renderer.ts:44

Optional clear color when autoClear is enabled

defaultBg?

optional defaultBg: Color

Defined in: core/Renderer.ts:40

Default background color

defaultFg?

optional defaultFg: Color

Defined in: core/Renderer.ts:38

Default foreground color

RendererOptions

Defined in: types/types.ts:123

Renderer configuration options

Properties

defaultBg?

optional defaultBg: Color

Defined in: types/types.ts:131

Default background color

defaultFg?

optional defaultFg: Color

Defined in: types/types.ts:129

Default foreground color

height

height: number

Defined in: types/types.ts:127

Height in characters

width

width: number

Defined in: types/types.ts:125

Width in characters

RenderTarget

Defined in: types/types.ts:138

Abstract interface for render targets Allows rendering to different outputs (Canvas, DOM, Terminal, etc.)

Methods

clear()

clear(): void

Defined in: types/types.ts:152

Clear the entire render target

Returns

void

flush()

flush(): void

Defined in: types/types.ts:157

Flush all pending changes to the actual output

Returns

void

getSize()

getSize(): object

Defined in: types/types.ts:163

Get the size of the render target

Returns

object

Width and height in characters

height

height: number

width

width: number

setCell()

setCell(x, y, char, fg, bg): void

Defined in: types/types.ts:147

Set a character at the specified position

Parameters

x

number

X coordinate (0-indexed)

y

number

Y coordinate (0-indexed)

char

string

Character to display

fg

Foreground color

bg

Background color

Returns

void

RGBColor

Defined in: types/types.ts:35

RGB color object

Properties

b

b: number

Defined in: types/types.ts:38

g

g: number

Defined in: types/types.ts:37

r

r: number

Defined in: types/types.ts:36

ShowBoundsOptions

Defined in: helpers/debugHelpers.ts:25

Options for showing bounds

Properties

fg?

optional fg: Color

Defined in: helpers/debugHelpers.ts:27

Foreground color

fill?

optional fill: boolean

Defined in: helpers/debugHelpers.ts:31

Fill the bounds with a transparent pattern

label?

optional label: string

Defined in: helpers/debugHelpers.ts:29

Label to display (positioned at top-left corner)

ShowFPSOptions

Defined in: helpers/debugHelpers.ts:37

Options for showing FPS counter

Properties

bg?

optional bg: Color

Defined in: helpers/debugHelpers.ts:45

Background color

fg?

optional fg: Color

Defined in: helpers/debugHelpers.ts:43

Foreground color

x?

optional x: number

Defined in: helpers/debugHelpers.ts:39

X position (default: 0)

y?

optional y: number

Defined in: helpers/debugHelpers.ts:41

Y position (default: 0)

ShowGridOptions

Defined in: helpers/debugHelpers.ts:13

Options for showing a grid overlay

Properties

char?

optional char: string

Defined in: helpers/debugHelpers.ts:19

Character to use for grid lines (default: '·' for dots, '┼' for intersections)

fg?

optional fg: Color

Defined in: helpers/debugHelpers.ts:17

Grid line color

spacing?

optional spacing: number

Defined in: helpers/debugHelpers.ts:15

Grid line spacing (default: 10)

ShowPointerCoordsOptions

Defined in: helpers/debugHelpers.ts:51

Options for showing pointer coordinates

Properties

bg?

optional bg: Color

Defined in: helpers/debugHelpers.ts:59

Background color

fg?

optional fg: Color

Defined in: helpers/debugHelpers.ts:57

Foreground color

x?

optional x: number

Defined in: helpers/debugHelpers.ts:53

X position for the display (default: 0)

y?

optional y: number

Defined in: helpers/debugHelpers.ts:55

Y position for the display (default: 0)

Size

Defined in: types/types.ts:389

Dimensions (width and height)

Example

const gridSize: Size = { width: 80, height: 24 };

Properties

height

height: number

Defined in: types/types.ts:393

Height in characters

width

width: number

Defined in: types/types.ts:391

Width in characters

TextOptions

Defined in: types/types.ts:109

Options for drawing text

Properties

align?

optional align: TextAlign

Defined in: types/types.ts:117

Text alignment

bg?

optional bg: Color

Defined in: types/types.ts:113

Background color

fg?

optional fg: Color

Defined in: types/types.ts:111

Foreground color

wrap?

optional wrap: boolean

Defined in: types/types.ts:115

Enable word wrapping

TextPreset

Defined in: helpers/presetHelpers.ts:29

Text preset definition

Extends

BasePreset

Properties

options

options: TextOptions

Defined in: helpers/presetHelpers.ts:31

Overrides

BasePreset.options

type

type: "text"

Defined in: helpers/presetHelpers.ts:30

Overrides

BasePreset.type

WaitForKeyOptions

Defined in: input/KeyboardManager.ts:16

Properties

signal?

optional signal: AbortSignal

Defined in: input/KeyboardManager.ts:18

timeout?

optional timeout: number

Defined in: input/KeyboardManager.ts:17

Type Aliases

AnimationCallback()

AnimationCallback = (progress) => void

Defined in: types/types.ts:276

Animation callback function

Parameters

progress

number

Animation progress (0.0 to 1.0)

Returns

void

AnimationCompleteCallback()

AnimationCompleteCallback = () => void

Defined in: types/types.ts:281

Animation completion callback

Returns

void

BoxStyle

BoxStyle = "single" | "double" | "rounded" | "heavy" | "ascii"

Defined in: types/types.ts:61

Box border styles

Color

Color = NamedColor | HexColor | RGBColor | null

Defined in: types/types.ts:44

All supported color formats

EasingFunction

EasingFunction = "linear" | "easeIn" | "easeOut" | "easeInOut" | "bounce" | "elastic"

Defined in: types/types.ts:264

Easing functions for animations

GamepadCallback()

GamepadCallback = (gamepad) => void

Defined in: input/GamepadManager.ts:5

Gamepad/Controller input manager using the native Gamepad API

Parameters

gamepad

Gamepad

Returns

void

HexColor

HexColor = `#${string}`

Defined in: types/types.ts:30

Hex color string (e.g., "#ff0000")

ImageFormat

ImageFormat = "png" | "jpeg"

Defined in: helpers/exportHelpers.ts:29

Image format for export

KeyCallback()

KeyCallback = (event) => void

Defined in: input/KeyboardManager.ts:5

Keyboard input manager for handling key events and state

Parameters

event

KeyboardEvent

Returns

void

MouseCallback()

MouseCallback = (event) => void

Defined in: input/MouseManager.ts:19

Parameters

event

MouseEvent

Returns

void

NamedColor

NamedColor = "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | "grey" | "brightRed" | "brightGreen" | "brightYellow" | "brightBlue" | "brightMagenta" | "brightCyan" | "brightWhite"

Defined in: types/types.ts:8

Named ANSI colors

PointerCallback()

PointerCallback = (event) => void

Defined in: input/PointerManager.ts:17

Parameters

event

PointerEvent

Returns

void

Preset

Preset = TextPreset | BoxPreset | MenuPreset | ProgressBarPreset

Defined in: helpers/presetHelpers.ts:61

Union type of all preset types

PresetDefinition

PresetDefinition = object & TextOptions | object & BoxOptions | object & MenuOptions | object & ProgressBarOptions

Defined in: helpers/presetHelpers.ts:66

Preset definition for definePreset function

PresetType

PresetType = "text" | "box" | "menu" | "progressBar"

Defined in: helpers/presetHelpers.ts:16

Preset type discriminators

ProgressBarStyle

ProgressBarStyle = "blocks" | "dots" | "arrows" | "custom"

Defined in: types/types.ts:197

Progress bar style presets

RenderCallback()

RenderCallback = () => void

Defined in: core/GameLoop.ts:13

Returns

void

TextAlign

TextAlign = "left" | "center" | "right"

Defined in: types/types.ts:104

Text alignment options

UpdateCallback()

UpdateCallback = (delta) => void

Defined in: core/GameLoop.ts:12

Parameters

delta

number

Returns

void

Functions

brighten()

brighten(color, amount): RGBColor

Defined in: drawing/colors.ts:138

Brighten a color by a given amount

Parameters

color

Color to brighten

amount

number

Amount to brighten (0-1)

Returns

Brightened RGB color

clearAllPresets()

clearAllPresets(): void

Defined in: helpers/presetHelpers.ts:174

Clear all defined presets

Removes all presets from the registry. Useful for testing or resetting the preset system.

Returns

void

Example

clearAllPresets()
console.log(listPresets()) // []

darken()

darken(color, amount): RGBColor

Defined in: drawing/colors.ts:155

Darken a color by a given amount

Parameters

color

Color to darken

amount

number

Amount to darken (0-1)

Returns

Darkened RGB color

definePreset()

definePreset(name, definition): void

Defined in: helpers/presetHelpers.ts:118

Define a reusable style preset

Presets allow you to define commonly used styles once and reuse them throughout your application. Supports text, box, menu, and progress bar styles.

Parameters

name

string

Unique name for the preset

definition

PresetDefinition

Preset definition with type and options

Returns

void

Example

// Define text presets
definePreset('title', {
  type: 'text',
  fg: 'yellow',
  bg: 'blue',
  align: 'center'
})

// Define box preset
definePreset('panel', {
  type: 'box',
  style: 'double',
  fg: 'cyan',
  fill: true
})

// Define menu preset
definePreset('mainMenu', {
  type: 'menu',
  selectedFg: 'black',
  selectedBg: 'white',
  border: true,
  style: 'rounded'
})

// Use presets
renderer.applyTextPreset(10, 5, 'Game Title', 'title')
renderer.applyBoxPreset(0, 0, 80, 24, 'panel')

getPreset()

getPreset(name): Preset | undefined

Defined in: helpers/presetHelpers.ts:143

Get a preset by name

Parameters

name

string

Preset name

Returns

Preset | undefined

Preset definition, or undefined if not found

Example

const preset = getPreset('title')
if (preset && preset.type === 'text') {
  console.log(preset.options.fg) // 'yellow'
}

lerp()

lerp(color1, color2, t): RGBColor

Defined in: drawing/colors.ts:120

Interpolate between two colors

Parameters

color1

First color

color2

Second color

t

number

Interpolation factor (0-1)

Returns

Interpolated RGB color

listPresets()

listPresets(): string[]

Defined in: helpers/presetHelpers.ts:158

List all defined preset names

Returns

string[]

Array of preset names

Example

const presets = listPresets()
console.log(presets) // ['title', 'panel', 'mainMenu']

parseColor()

parseColor(color): RGBColor | null

Defined in: drawing/colors.ts:62

Parse any color format to RGB

Parameters

color

Color in any supported format

Returns

RGBColor | null

RGB color object or null

rgbToHex()

rgbToHex(color): `#${string}`

Defined in: drawing/colors.ts:91

Convert RGB color to hex string

Parameters

color

RGB color

Returns

`#${string}`

Hex color string

toCSSColor()

toCSSColor(color): string

Defined in: drawing/colors.ts:105

Convert color to CSS-compatible string

Parameters

color