Giter Club home page Giter Club logo

nomina's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.