Skip to content
/ tiyl Public

A library for generating character backstories based on the Xanathar's Guide to Everything 'This Is Your Life' tables.

License

Notifications You must be signed in to change notification settings

tom-wolfe/tiyl

Repository files navigation

TIYL (This Is Your Life) NPM version

See an interface for this running here

A TypeScript library for generating characters based on the tables presented in the This Is Your Life chapter of Xanathar's Guide To Everything for 5th edition Dungeons & Dragons.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

npm install --save tiyl

Usage

Basic Usage

At its simplest, the dice roller is very simple to use. Take the following example:

import { Generator } from "tiyl";

const generator = new Generator();
const character = generator.generate();
console.log(character); // Outputs the randomly generated character.

Configuration

Installing Dependencies

Installing the dependencies is done using a standard npm i.

Running the Tests

npm run test

Building the project

npm run build

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Releases

No releases published

Packages

No packages published