Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codyebberson/wglt
WebGL Terminal
https://github.com/codyebberson/wglt
javascript roguelike terminal typescript webgl
Last synced: 4 days ago
JSON representation
WebGL Terminal
- Host: GitHub
- URL: https://github.com/codyebberson/wglt
- Owner: codyebberson
- License: mit
- Created: 2018-11-03T22:18:03.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T06:06:37.000Z (18 days ago)
- Last Synced: 2025-01-17T07:12:07.780Z (15 days ago)
- Topics: javascript, roguelike, terminal, typescript, webgl
- Language: TypeScript
- Homepage: https://wglt.js.org
- Size: 4.5 MB
- Stars: 60
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/libtcod/libtcod) and [rot.js](https://ondras.github.io/rot.js/hp/).
## Install
### Install with npm (recommended)
Add dependency to your package.json:
```bash
npm i -D wglt
```
Import library:
```typescript
import { Colors, Terminal } from 'wglt';
```
## Usage
Use it:
```typescript
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](https://ondras.github.io/rot.js/hp/)
- [Phaser](https://phaser.io/)
- [PixiJS](https://pixijs.com/)
- [Kontra.js](https://github.com/straker/kontra)
- [LittleJS](https://github.com/KilledByAPixel/LittleJS)
- [Kaboom](https://kaboomjs.com/)
## 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