opendnd / opendnd

This is the main collection of OpenDnD Tools with generators for persons, dynasties, cities, towns, and more

opendnd

This is the main collection of OpenDnD Tools with generators for persons, dynasties, cities, towns, and more

Installation

You will need node and npm installed. Then run the command:

npm install -g opendnd

Generate from CLI

dnd name    # generate a name for a character or city
dnd dna     # generate DNA for a person with unique traits and physical characteristics
dnd person  # generate a person either a playable character or non
dnd domain  # generate a kingdom, city, town, etc. for the characters to explore
dnd dynasty # generate a dynasty to give the kingdom a rich history

Module Usage

Require opendnd into your file and use either of the opendnd classes.

const opendnd = require('opendnd');
const { Nomina, Genetica, Personae, Dominia, Dynastia } = opendnd;

// generate name
const nomina = new Nomina();
const name = nomina.generate();

// generate DNA
const genetica = new Genetica();
const DNA = genetica.generate();

// generate a person with our name and DNA
// all are optional if we leave it out it will be generated for us
const personae = new Personae();
const person = personae.generate({
  name,
  DNA,
});

// generate a dynasty with our person
const dynastia = new Dynastia();
const dynasty = dynastia.generate({
  progenitor: person,
});

// generate a town where this dynasty is from
const dominia = new Dominia();
const town = dominia.generate({
  size: 'town',
});

Features

Here are the features of Dynastia:

Person Generating

For more on person generating please see the Personae README.

Name Generating

For more on name generating please see the Nomina README.

DNA Generating

For more on DNA generating please see the Genetica README.

Domain (kingdoms, cities, towns, etc.) Generating

For more on domain generating please see the Dominia README.

Dynasty Generating

For more on person dynasty please see the Dynastia README.

Developing

To develop with OpenDnD,

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

Contributing

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

OpenDnD use the Airbnb javascript style.

Licensing

MIT