iniquity

A re-imagining of the iconic BBS software.

View on GitHub

Interface: IQArtworkRenderOptions

Core.IQArtworkRenderOptions

Artwork render options

Table of contents

Properties

Properties

basepath

Optional basepath: string

The full path to your art folder

Defined in

core/src/index.ts:161


clearScreenBefore

Optional clearScreenBefore: boolean

A boolean representing if you want the screen cleared before.

Defined in

core/src/index.ts:181


data

Optional data: unknown

Defined in

core/src/index.ts:182


encoding

Optional encoding: "CP437" | "UTF8"

Supported character encodings are CP437 and UTF8.

Defined in

core/src/index.ts:173


filename

Optional filename: string

The file name of the artwork you would like to render to the screen

Defined in

core/src/index.ts:165


mode

Optional mode: "line" | "character" | "@-codes" | "reactive"

The rendering mode to use. e.g. Line at a time, character at a time, etc.

Defined in

core/src/index.ts:177


speed

Optional speed: number

How fast you would like the artwork rendered to the screen.

Defined in

core/src/index.ts:169