Nitrogenous Polymorphic Molecule

    fantasy-name-generator
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    Fantasy Name Generator

    Commitizen friendly

    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.

    Install

    npm i fantasy-name-generator

    DownloadsWeekly Downloads

    311

    Version

    2.0.0

    License

    ISC

    Unpacked Size

    489 kB

    Total Files

    21

    Last publish

    Collaborators

    • fentech