https://github.com/tom-wolfe/tiyl

A library for generating character backstories based on the Xanathar's Guide to Everything 'This Is Your Life' tables.
https://github.com/tom-wolfe/tiyl

and character dnd dnd5e dragons dungeons everything generator guide library random to tool typescript utility xanathar-s xgte

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/tom-wolfe/tiyl
• Owner: tom-wolfe
• License: mit
• Created: 2018-04-24T12:44:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T16:36:08.000Z (about 2 years ago)
• Last Synced: 2024-04-23T22:10:05.530Z (9 months ago)
• Topics: and, character, dnd, dnd5e, dragons, dungeons, everything, generator, guide, library, random, to, tool, typescript, utility, xanathar-s, xgte
• Language: TypeScript
• Homepage: https://tiyl.twolfe.dev
• Size: 688 KB
• Stars: 8
• Watchers: 0
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TIYL (This Is Your Life) [![NPM version](https://badge.fury.io/js/tiyl.svg)](http://badge.fury.io/js/tiyl)

[See an interface for this running here](https://tiyl.twolfe.dev)

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

```batchfile

npm install --save tiyl

```

### Usage

#### Basic Usage

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

```typescript

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

```dice

npm run test

```

## Building the project

```dice

npm run build

```

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/trwolfe13/dice-typescript/tags).

## Authors

* **Tom Wolfe** - *Initial work* - [trwolfe13](https://github.com/trwolfe13)

See also the list of [contributors](https://github.com/trwolfe13/tiyl/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details