character-maker v0.2.2

character-maker

This site aims to help you create new characters for your next novel, story, game, TV show, etc.

Usage

Install the package:

npm install character-maker

Import the module and create a new character:

import { Character } from 'character-maker'

// create a new blank character:
const character = new Character()

// create a new character with given parameters:
const character = new Character({
  name: {
    first: 'John',
    last: 'Smith',
  }
})

// create a new fully-randomized character:
const character = new Character().generate()

All parameters available can be found here.

API Reference

All parameters listed here are optional.

The following properties are available on an instance of the Character class:

• .age
• .arms
• .background
• .build
• .chest
• .crotch
• .eyes
• .hair
• .health
• .height
• .legs
• .mouth
• .muscles
• .name
• .neck
• .nose
• .pronouns
• .sex
• .sexuality
• .shoulders
• .skin
• .speech
• .stomach
• .waist
• .weight

View all sub-properties and more documentation here.

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.