Name Grimoire

A lightweight fantasy name generator library.

Installation

npm install name-grimoire

Usage

import { generateName, generateSurname, generateFullName } from 'name-grimoire';

// Generate a random name
const name = generateName();        // e.g., "Thorin" or "Galdor"

 // Generate a random surname
const surname = generateSurname();  // e.g., "Shadowmere"

// Generate a full name
const fullName = generateFullName(); // e.g., "Aerindel Stormwind"

Custom Options

import { generateName } from 'name-grimoire';

// Use custom syllables
const name = generateName({
  syllables: ['foo', 'bar', 'baz']
});

// Use custom random function
const name = generateName({
  randomFn: () => 0.5
});

API

generateName(options?)

Generates a random fantasy name.

Options:

• syllables - Array of syllable strings (default: built-in syllables)
• vowels - Array of vowel strings (default: ['a', 'e', 'i', 'o', 'u', 'y'])
• randomFn - Custom random function returning 0-1 (default: Math.random)

generateSurname(options?)

Generates a random fantasy surname. Same options as generateName.

generateFullName(options?)

Generates a random fantasy full name. Same options as generateName.

Development

npm install
npm run dev      # Start demo page
npm run build    # Build for production
npm run test     # Run tests
npm run lint     # Lint code

License

MIT