Fantasy Name Generator


Generate names on the fly

Want a new name on the fly? Just use npx and the appropriate options for the race you want.

``
$ npx fantasy-name-generator generate elf --gender female
$ npx fantasy-name-generator g human --allowMulitpleNames false
`

See the npx command options with -h:

`
$ npx fantasy-name-generator generate -h
$ npx fantasy-name-generator g -h
`

Installation

`
$ npm i fantasy-name-generator
`

Usage

nameByRace(race: string, options?: { gender?: 'male' | 'female', allowMultipleNames?: boolean })

`typescript
import { nameByRace } from "fantasy-name-generator";

const elfHero = nameByRace("elf", { gender: "female" });
const enemyDemon = nameByRace("demon");
`

$3

| Race | Gender | allowMultipleNames |
| ---------- | ------ | ------------------ |
| angel | ✅ | |
| cavePerson | ✅ | |
| darkelf | ✅ | |
| demon | | |
| dragon | ✅ | |
| drow | ✅ | |
| dwarf | ✅ | |
| elf | ✅ | |
| fairy | ✅ | |
| gnome | ✅ | |
| goblin | | |
| halfdemon | ✅ | |
| halfling | ✅ | |
| highelf | ✅ | |
| highfairy | ✅ | |
| human | | ✅ |
| ogre | | |
| orc | | |

Contributing

$3

Please use npm run commit` when committing to this project to ensure your commits are consistent.