README.md

Deity Generator

Generates a random Dwarf Fortress Deity.

Installation

npm install --save deity-generator

Usage

import { Deity } from 'deity-generator'

const deity = new Deity({ seed: 'seed' })

console.log(deity.name) // => ak Upuh
console.log(deity.gender) // => male
console.log(deity.spheres) // => [ 'rulership', 'jealousy' ]
console.log(deity.creature) // => cave swallow
console.log(deity.toString()) // => ak Upuh most often takes the form of a male cave swallow and is associated with rulership and jealousy.

Deity API

new Deity(props) => Deity

Used to create a new Deity.

Field	Type	Description
props.seed	string	Seed used to generate the deity.
props.name	string	Deity's name.
props.gender	string	Deity's gender.
props.creature	string	Deity's creature.
props.spheres	string[]	Deity's spheres.

.name => string

Used to get the Deity's name.

.gender => string

Used to get the Deity's gender.

.spheres => string

Used to get the Deity's spheres.

.creature => string

Used to get the Deity's name.

.toString() => string

Used to descripe the Deity.

References

• DF2014:Deity
• DF2014:Creature
• DF2014:Animals
• DF2014:Deity