# deity-generator

> A generator for deities

Latest version **1.0.0** (published 2023-04-23) · 0 weekly downloads

## Install

```sh
npm install deity-generator
pnpm add deity-generator
yarn add deity-generator
bun add deity-generator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-04-23 |
| First published | 2022-09-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 69.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Luca Tabone |
| Maintainers | tabone |

## Links

- npm: https://www.npmjs.com/package/deity-generator
- Repository: https://github.com/tabone/deity-generator
- Homepage: https://github.com/tabone/deity-generator#readme
- Issues: https://github.com/tabone/deity-generator/issues
- npm.io page: https://npm.io/package/deity-generator

## Recent versions

- 1.0.0 (latest) — 2023-04-23
- 0.9.0 — 2022-10-15
- 0.8.0 — 2022-09-20
- 0.7.0 — 2022-09-20
- 0.6.0 — 2022-09-19
- 0.5.0 — 2022-09-19
- 0.4.0 — 2022-09-18
- 0.3.0 — 2022-09-17
- 0.2.0 — 2022-09-17
- 0.1.0 — 2022-09-17

## README

# Deity Generator

Generates a random Dwarf Fortress Deity.

## Installation

```bash
npm install --save deity-generator
```

## Usage

```javascript
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](https://dwarffortresswiki.org/index.php/DF2014:Deity)
- [DF2014:Creature](https://dwarffortresswiki.org/index.php/DF2014:Creature)
- [DF2014:Animals](https://dwarffortresswiki.org/index.php/Category:DF2014:Animals)
- [DF2014:Deity](https://dwarffortresswiki.org/index.php/DF2014:Vermin)

---
_Source: https://npm.io/package/deity-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._