usage

Usage

You can create a new npc in several ways.

const dnd = require('dnd-npc');
const npc = new dnd.npc({ raceType: "warforged", subRace: "juggernaut", roleType: "fighter"})
	.generate(); // Generates a Warforged-Juggernaut Fighter

const dnd = require('dnd-npc');
const npc = new dnd.npc()
	.raceType({ raceType: "warforged", subRace: "juggernaut"})
	.roleType("fighter")
	.generate(); // Generates a Warforged-Juggernaut Fighter

You can also overwrite settings that you have already input.

const dnd = require('dnd-npc');
const npc = new dnd.npc({ raceType: "warforged", subRace: "juggernaut", roleType: "fighter"})
	.raceType({ raceType: "human" })
	.roleType("bard")
	.generate(); // Generates a Human Bard (why u make Bard tho?)

Leaving the raceType or roleType blank, or passing an invalid type to it, will result in that thing being randomly generated.

const dnd = require('dnd-npc');
const npc = new dnd.npc({ raceType: "warforged" })
	.generate(); // Generates a Warforged with a random sub-race and role.

You can also pass a sub-race as the raceType and it will generate with the correct race and sub-race.

const dnd = require('dnd-npc');
const npc = new dnd.npc({ raceType: "juggernaut" })
	.generate(); // Generates a Warforged-Juggernaut with a random role.

Output

After using the npc#generate() method, you'll receive an object with all the NPC information inside of it.
The structure of the object should be as follows:

{
	"character": {
		"name": String, // The name of the NPC
		"gender": String, // The gender of the NPC
		"alignment": String, // The alignment of the NPC
		"age": Number, // The age of the NPC
		"background": String, // The type of background that this NPC has
		"level": Number // The level of the NPC. This should always be level 1
	},
	"race": {
		"name": String, // The name of the race
		"link": String, // Link to the race on D&D Beyond
		"size": String, // The size of the race Small, Medium etc.
		"speed": Number // The base movement speed of the race
	},
	"class": {
		"name": String, // The name of the class
		"link": String, // link to the class on D&D Beyond
		"stats": {
			"strength": Number, // The total strength of the NPC including the race bonus
			"dexterity": Number, // The total dexterity of the NPC including the race bonus
			"constitution": Number, // The total constitution of the NPC including the race bonus
			"intelligence": Number, // The total intelligence of the NPC including the race bonus
			"wisdom": Number, // The total wisdom of the NPC including the race bonus
			"charisma": Number // The total charisma of the NPC including the race bonus
		},
	},
	"inventory": {
		"weapon": { // The weapon that the NPC is carrying.
			"name": String, // The name of the weapon
			"link": String, // The link to the weapon on D&D Beyond
			"damageType": String, // What type of damage the weapon does. Bludgeoning, Piercing, Slashing etc.
			"damageAmount": String, // The damage done by the weapon.
			"vDamage": String, // Damage done if the weapon is "versatile" and being used two handed, otherwise undefined.
			"simple": Boolean, // Whether this weapon is classified as martial or simple
			"ranged": Boolean, // Whether or not the weapon is a ranged weapon
			"allowShield": Boolean, // Whether or not the weapon allows the use of a shield
			"properties": Array // The properties of the weapon, such as versatile, heavy etc. May be Empty.
		},
		"shield": Boolean, // Whether or not the NPC has a shield, if it does, this will instead be String with a link to shields on D&D Beyond
		"armor": { // The armor that the NPC is wearing, this may be undefined.
			"name": String, // The name of the armor
			"type": String, // The armor type. Light, Medium or Heavy
			"link": String, // Link to the armor on D&D Beyond
			"strength": Number, // The strength requirement for the armor
			"metal": Boolean, // Whether or not the armor is made of metal
			"stealth": Boolean // Whether or not the armor impedes the stealth of the NPC
		},
		"tools": [ // The tools that the NPC has. This may be empty.
			{
				"name": String, // Name of the tool
				"link": String // Link to the tool on D&D Beyond
			}
		]
	}
};