https://github.com/tabone/deity-generator
A generator for deities
https://github.com/tabone/deity-generator
Last synced: 9 days ago
JSON representation
A generator for deities
- Host: GitHub
- URL: https://github.com/tabone/deity-generator
- Owner: tabone
- Created: 2022-09-17T08:03:41.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-23T12:06:15.000Z (about 3 years ago)
- Last Synced: 2025-11-07T14:11:29.240Z (8 months ago)
- Language: JavaScript
- Size: 78.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
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)