fantasy-name-generator
v2.0.0
Published
An easy to use race-based fantasy name generator. With TypeScript!
Downloads
2,506
Maintainers
Readme
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 })
import { nameByRace } from "fantasy-name-generator";
const elfHero = nameByRace("elf", { gender: "female" });
const enemyDemon = nameByRace("demon");
Races and required options
| Race | Gender | allowMultipleNames | | ---------- | ------ | ------------------ | | angel | ✅ | | | cavePerson | ✅ | | | darkelf | ✅ | | | demon | | | | dragon | ✅ | | | drow | ✅ | | | dwarf | ✅ | | | elf | ✅ | | | fairy | ✅ | | | gnome | ✅ | | | goblin | | | | halfdemon | ✅ | | | halfling | ✅ | | | highelf | ✅ | | | highfairy | ✅ | | | human | | ✅ | | ogre | | | | orc | | |
Contributing
Committing
Please use npm run commit
when committing to this project to ensure your commits are consistent.