iniquity

A re-imagining of the iconic BBS software.

View on GitHub

Interface: BBSArtOptions

core/bbs.BBSArtOptions

Options for artwork rendering via bbs.art()

Table of contents

Properties

Properties

center

Optional center: "auto" | "horizontal" | "vertical" | "both" | "none"

Centering mode for artwork positioning

Defined in

core/src/bbs.ts:132


clearScreen

Optional clearScreen: boolean

Clear screen before rendering

Defined in

core/src/bbs.ts:124


data

Optional data: Record<string, any>

Data for MCI code interpolation (accessible as @KEY@ in artwork)

Defined in

core/src/bbs.ts:130


display

Optional display: "line" | "character" | "instant"

Display mode: ‘line’ (line-by-line), ‘character’ (char-by-char), ‘instant’ (all at once)

Defined in

core/src/bbs.ts:126


encoding

Optional encoding: "cp437" | "utf8"

Override session encoding for this artwork (default: use session preference)

Defined in

core/src/bbs.ts:140


pauseAfter

Optional pauseAfter: string | boolean

Pause after rendering (true for default pause, string for custom prompt)

Defined in

core/src/bbs.ts:138


speed

Optional speed: number

Speed in milliseconds (for line/character modes)

Defined in

core/src/bbs.ts:128


x

Optional x: number

Explicit X position (1-indexed)

Defined in

core/src/bbs.ts:134


y

Optional y: number

Explicit Y position (1-indexed)

Defined in

core/src/bbs.ts:136