Made Up Names

This is a library for generating random fictional names.

Generator Methods

The following methods are available. Each gives you a single random name of the specified type.

• magicItem
• modelNumber
• planet
• star
• tavern

In addition, there is a special method invent which takes an array of strings as its argument. These strings must be patterns (as per the rules here: Word Generator Cheat Sheet). The invent method will give you a random name that adheres to a random one of those patterns.

Generator Sets

A GeneratorSet is an object that can generate consistent names for a particular set of patterns.

It has the following signature:

interface GeneratorSet {
  name: string;
  culture: NameGenerator;
  country: NameGenerator;
  family: NameGenerator;
  female: NameGenerator;
  male: NameGenerator;
  town: NameGenerator;
}

In the above, "name" is the name of the generator set. The other properties are all NameGenerators. Each NameGenerator has a name, a set of patterns, and a generate method that takes a number as its only argument. The generate method will give you an array of random names, sized to that number.

So, if you had a GeneratorSet mySet, you could run mySet.family.generate(10) to get 10 random family names for that set.

The constructor for the above class creates an "empty" GenericNameGenerator for each of the NameGenerator fields. You can set the patterns field on each GenericNameGenerator to an array of patterns to set it up. For example:

let gen = new GeneratorSet();

gen.family.patterns = ['pvd', 'pv+d'];

let familyNames = gen.family.generate();

You can create your own GeneratorSets, or you can use one of the premade ones.

Use the method getSetByName(name: string, sets: GeneratorSet[]) to fetch a specific name generator set.

The method fantasyRaceSets() will give you an array of fantasy race name generator sets. Note: since I'm moving away from names based on race, these are actually derived from culture generator sets behind the scenes, but made available this way for folks who prefer the old way of doing things. So, the "goblin" name generator set is actually the "mud grubber" culture set, just with a new name.

The method cultureSets() will give you an array of culture name generator sets.

The method allSets() will give you an array of all available generator sets.

Further Documentation

See here.