https://github.com/seiyria/fantastical

A fantasy name generator based on fantasygen
https://github.com/seiyria/fantastical

fantasy gender generator name rpg species

Last synced: 3 months ago
JSON representation

A fantasy name generator based on fantasygen

• Host: GitHub
• URL: https://github.com/seiyria/fantastical
• Owner: seiyria
• License: mit
• Created: 2017-06-10T18:25:57.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-22T14:53:10.000Z (almost 2 years ago)
• Last Synced: 2024-05-09T19:31:49.700Z (9 months ago)
• Topics: fantasy, gender, generator, name, rpg, species
• Language: TypeScript
• Size: 375 KB
• Stars: 26
• Watchers: 5
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fantastical

A fantasy name generator based on [fantasygen](https://github.com/alxgiraud/fantasygen). You can see examples of the output below [here](http://fantasygen.herokuapp.com/).

## Install

`npm i fantastical`

## Usage

`import { human, mysticOrder, adventure, tavern, species, parties, places, adventures } = from 'fantastical';`

## API

### `species`

Some species support options, and those will be listed. If a species allows for a gender, you can use `'male'`, `'female'`, or any other string (including null) to ignore gender usage.

Function      | Options

--------      | -------

`goblin`      | none

`orc`         | none

`ogre`        | none

`cavePerson`  | `gender`

`dwarf`       | `gender`

`halfling`    | `gender`

`gnome`       | `gender`

`elf`         | `gender`

`highelf`     | `gender`

`fairy`       | `gender`

`highfairy`   | `gender`

`darkelf`     | `gender`

`drow`        | `gender`

`halfdemon`   | `gender`

`demon`       | none

`dragon`      | `gender`

`angel`       | `gender`

`human`       | `{ allowMultipleNames: boolean }`

### `parties`

No party supports options at this time.

Function      | Options

--------      | -------

`mysticOrder` | none

`militaryUnit`| none

`guild`       | none

### `places`

No place function supports options at this time.

Function      | Options

--------      | -------

`tavern`      | none

### `adventures`

No adventure function supports options at this time.

Function      | Options

--------      | -------

`adventure`   | none