wglt

WGLT - WebGL Terminal

• Fast, lightweight, terminal emulator using WebGL
• MIT license
• ~30kb minified JS, ~10kb gzipped
• No external dependencies

What is it?

WGLT is a JavaScript/TypeScript library for creating ASCII games in the browser.

WGLT is absurdly overoptimized for performance, using WebGL for minimal CPU.

WGLT is modelled after libtcod and rot.js.

Install

Install with npm (recommended)

Add dependency to your package.json:

npm i -D wglt

Import library:

import { Colors, Terminal } from 'wglt';

Usage

Use it:

import { Colors, Terminal } from 'wglt';

const term = new Terminal(document.querySelector('canvas') as HTMLCanvasElement, 80, 45);
term.fillRect(0, 0, 80, 45, 0, Colors.YELLOW, Colors.DARK_BLUE);

let x = 10;
let y = 10;

term.update = () => {
  const moveKey = term.getMovementKey();
  if (moveKey) {
    x += moveKey.x;
    y += moveKey.y;
  }

  term.clear();
  term.drawString(1, 1, 'Hello world!');
  term.drawString(1, 3, 'Use arrow keys to move');
  term.drawString(x, y, '@');
};

Limitations

WGLT is a minimalist library. It is intended to be small, lightweight, and fast. It serves the very narrow use case of minimalist ASCII or ANSI games in the web browser.

By default, WGLT uses the original IBM CGA Character set, thick variant, dumped from addresses 0x1800-0x1fff the 5788005 IBM Character Generator ROM.

I do not have intentions to include support for formatted text (i.e., bold or underline), extended character sets, emoji, etc. While I am flattered by those feature requests, I suggest you look at alternate libraries such as:

• rot.js
• Phaser
• PixiJS
• Kontra.js
• LittleJS
• Kaboom

Fonts

WGLT supports custom font images, and provides built in support for standard fonts:

• [x] IBM CGA Character
• [ ] IBM VGA 9x14 (MS-DOS)
• [ ] Commodore 64
• [ ] ZX Spectrum
• [ ] Amstrad CPC 464

Palettes

WGLT supports full 32-bit color, and also provides constants for standard palettes:

• [x] CGA
• [x] Commodore 64
• [x] "Colodore"
• [x] PICO 8

CRT Filter

By default, WGLT renders crisp pixels. WGLT also provides an optional CRT filter with the following effects:

• [x] Scanlines
• [x] Curvature
• [x] Vignette (darker in the corners and around the edges)
• [x] Chromatic aberration (RGB independent offsets)
• [ ] Bloom
• [ ] Interference animation