1.0.1 • Published 6 years ago

monster-stories v1.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

monster-stories

Get random dungeons and very interesting stories about the monsters living in them :paw_prints:

Build Status XO code style

Install

$ npm install monster-stories

Usage

const monsterStories = require('monster-stories');

monsterStories.generateDungeon();
//=> Dungeon {
//			name: 'The Cave Above the Sea',
//			foundingYear: 139,
//			habitants:
//			 [ Monster {
//					 gender: 2,
//					 name: 'Raryolia',
//					 age: 79,
//					 married: true,
//					 alive: false,
//					 so: [Object],
//					 canMarryWith: [Function],
//					 marryTo: [Function],
//					 die: [Function],
//					 story: [Array],
//					 pronoun: 'he' },
//			...

API

monsterStories.generateDungeon()

Generates a random dungeon with some monsters in it.

monsterStories.generateMonster()

Generates a random monster.

monsterStories.generateMonsterFamily()

Generates a random monster family.

monsterStories.generateMonsterName()

Generates a random monster name.

monsterStories.generateDungeonName()

Generates a random dungeon name.

monsterStories.generateStory(dungeon, monsterIndex = -1)

Generates a story, given a dungeon

dungeon

The dungeon to extract the story of.

monsterIndex

The monster to get the story of. Leave at -1 to get a random valid monster index.

License

MIT © vikepic

1.0.1

6 years ago

1.0.0

6 years ago