Happy-Ferret / wglt

WebGL Terminal

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.

Usage

Add dependency:

npm i -D wglt

Import library:

import * as wglt from 'wglt';

Or, simply use the prebuilt:

<script src="https://unpkg.com/wglt@0.2.3/dist/wglt.js"></script>

Use it:

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

let x = 10;
let y = 10;

term.update = function () {
    if (term.isKeyDown(wglt.Keys.VK_UP)) {
        y--;
    }
    if (term.isKeyDown(wglt.Keys.VK_LEFT)) {
        x--;
    }
    if (term.isKeyDown(wglt.Keys.VK_RIGHT)) {
        x++;
    }
    if (term.isKeyDown(wglt.Keys.VK_DOWN)) {
        y++;
    }

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