An implementation of the Facet MUD Project in JavaScript.
To work on this project, you will need NodeJS installed. There is no specific version required, but it is being built consistently against the latest available.
With Node installed, all you need to do is run the standard command from any old NPM project:
$ npm install
added 401 packages from 914 contributors and audited 402 packages in 4.886sTo run tests, you will similarly want to run a standard command:
$ npm test
> [email protected] test /home/jwilhelm/Documents/workspace/facetmud/facetjs
> nyc mocha
# ... a whole lot of test output here
54 passing (354ms)
# Code coverage will show here. Be sure this stays high!
>You can also check the code style by running:
$ npm run lint
> [email protected] lint /home/jwilhelm/Documents/workspace/facetmud/facetjs
> eslint .
$You can generate a full docs site for the code by running:
$ npm run docs
> [email protected] docs /facetmud/facetjs
> typedoc src/
Using TypeScript 3.9.3 from /facetmud/facetjs/node_modules/typescript/lib
Rendering [========================================] 100%
Documentation generated at /facetmud/facetjs/docs
$To start up a server, you can run the following:
$ npm start
> [email protected] start /facetmud/facetjs
> ts-node .
[info] Server started on :::8000