OSR Generators
A collection of tools and generators for OSR-style TTRPG
## Suppport
- [x] Knave 1e
- [ ] Knave 2e
- [ ] OSE
- [ ] Basic Fantasy RPG
- [ ] Outcast Silver Raiders
- [ ] Cairn
- [ ] Mork Borg
- [ ] Shadowdark
# Usage
**Install**
```shell
npm i osr-generators
```
**Create a Knave character**
```typescript
import { KnaveCharacter } from 'osr-generators'
// Generate a new character
const character = new KnaveCharacter()
// Regenerate character
character.generate()
// Regenerate traits only
character.generateTraits()
```
# Contributing
## Prerequisites
- [asdf version manager](https://asdf-vm.com/)
- [asdf nodejs plugin](https://github.com/asdf-vm/asdf-nodejs)
- [yarn](https://yarnpkg.com/)
## Install nodejs
Use `asdf` to install the node version listed in `.tool-verisons`
```shell
asdf install
```
## Install dependencies
```shell
yarn
```
### Testing
Tests are written using [Vitest](https://vitest.dev/) and can be run with `yarn test`
