Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 2.26 KB

README.md

File metadata and controls

36 lines (25 loc) · 2.26 KB

Trizbort.io

Trizbort.io is a JavaScript implementation of Trizbort, the adventure game mapping and code generation software. It aims to provide all Trizbort features in the browser, so that no download is required to create and share Trizbort maps, and generate code for several adventure design systems.

Drawing a map in Trizbort.io

Code generation

At the moment, Trizbort.io supports code generation for the following design systems and formats:

Code generation is more complete for some systems than for others. Experts are very welcome to contribute to make code generation results more complete. Code generation for Ink and Hugo may be added in the future.

Contributing

Trizbort.io is written in TypeScript using the JAMstack. There is no server back-end and there are few dependencies. It is simple to get it to run locally so you can hack on it. To do so:

  • Install Node.js (even if you have Node.js, a recent version is recommended). It will come with npm, the Node.js package manager.
  • Fork the project to a local directory.
  • Run npm install to install all dependencies. This includes TypeScript, Grunt, Handlebars and Express.
  • Build the project by running grunt build.
  • Optionally run grunt watch. This will rebuild parts of the project whenever you make a change.
  • Start an Express development server with npm run start:dev. This server will listen on port 3000.
  • Open http://localhost:3000/index.html in your browser.

Public web application

The public end-user implementation of Trizbort runs at Trizbort.io. The implementation is updated regularly to reflect changes as these are built into this repository.