nomina
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 = ;const nomina = ; // specify options, none are requiredconst options = theme: 'medieval' type: 'female'; // call the methodconst result = nomina; // get all themes availableconst themes = nomina;
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 = ;const defaults = themes: myCustomTheme: male: female: dominia: myOtherCustomTheme: male: female: dominia: ; const nomina = defaults ;const themes = nomina; // ['myCustomTheme', 'myOtherCustomTheme']
Developing
To develop nomina,
git clone https://github.com/opendnd/nomina.gitcd 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.