This is a text adventure engine for the CLI and browsers, supporting both narrative fiction and procedural dungeon crawlers, using an event and service architecture.
See the demo on Github Pages or the getting started docs for more info.
Some make
targets are provided:
make build
: transpile Typescript sourcesmake test
: build and run mocha
testsmake cover
: run make test
with nyc
code coverageA recent version of the game is available on Github Pages.
If you have a copy of this repository checked out, the make run
target will build and launch the game on the CLI,
using the Ink rendering engine and demo world.
If you prefer to run a Docker image, the latest build is published as ssube/textual-engine:master-stretch
, and can
be run with:
> docker run --rm -it ssube/textual-engine:master-stretch \
--config data/config.yml \
--data file://data/demo.yml
More detailed docs are located in ./docs
.
Available documentation includes:
This project uses the MIT license.