@slugbugblue/trax-tty
v1.3.1
Published
Simple tty graphics for displaying trax games
Readme
trax-tty
This javascript module provides a simple to use interface for displaying a Trax game on a tty console (ie, from nodejs).
Usage:
import { Trax } from '@slugbugblue/trax'
import * as tty from '@slugbugblue/trax-tty'
const game = new Trax('trax', '@0/ A0+')
const players = ['first player', 'player 2']
tty.display(game, players)Environment variables
The tty display can use fancy characters to separate the player names and moves, and tries to determine characters automatically from the environment.
It prefers a rounded bubble look, using characters available from the
[nerdfonts][nerdfonts] collection, and will default to that if it detects either
NERDFONT or NERDFONTS set in the environment.
If that is not found, it will next choose an angled look using characters from
[powerline][powerline], and will default to that if it detects any of
POWERLINE, P9K_TTY, or P9K_SSH set in the environment.
Lacking either of those, it will then choose a block look using characters available in all terminals.
However, if you want to override any of these defaults, you can choose to set
TRAX_TTY_LEFT and TRAX_TTY_RIGHT to set the left and right characters. To
completely disable the fancy printouts, set TRAX_TTY_PLAIN=true.
See the source for more details.
