Notorious Penguin Magicians

    nomina

    0.4.3 • Public • Published

    nomina

    NPM

    Build Status

    This is a tool for generating names for characters with a wide variety.

    Installation

    You will need node and npm installed. Then do:

    npm install -g nomina

    Generate a name

    Once you have installed nomina you can generate a name by simply running the following:

    nomina

    Options

    Theme

    nomina --theme medieval

    To see the available name types you can do nomina list

    Gender

    nomina --type female

    You can specify a gender by setting either male or female (or for convenience m / f) or you can specify a city/town name by passing dominia.

    Module Usage

    const Nomina = require('nomina');
    const nomina = new Nomina();
     
    // specify options, none are required
    const options = {
      theme: 'medieval',
      type: 'female',
    };
     
    // call the method
    const result = nomina.generate(options);
     
    // get all themes available
    const themes = nomina.getThemes();

    Custom Configs

    There are a couple of ways you can configure the themes that the tool uses:

    CLI Config

    The CLI checks for ~/.dnd/nomina/defaults.js before loading any other configuration. Simply add a file here while using the tool and you can customize the themes.

    Class Config

    You can pass a "defaults" config directly to the class on initialization:

    const Nomina = require('nomina');
    const defaults = {
      themes: {
        myCustomTheme: {
          male: [],
          female: [],
          dominia: [],
        },
        myOtherCustomTheme: {
          male: [],
          female: [],
          dominia: [],
        },
      },
    };
     
    const nomina = new Nomina({ defaults });
    const themes = nomina.getThemes(); // ['myCustomTheme', 'myOtherCustomTheme']

    Developing

    To develop nomina,

    git clone https://github.com/opendnd/nomina.git
    cd nomina/
    npm install

    Contributing

    If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome!

    Nomina use the Airbnb javascript style.

    Licensing

    MIT

    Install

    npm i nomina

    DownloadsWeekly Downloads

    27

    Version

    0.4.3

    License

    MIT

    Unpacked Size

    17.6 kB

    Total Files

    19

    Last publish

    Collaborators

    • drewry