Skip to content

webcaetano/data-creatures

Repository files navigation

Data-Creatures

NPM version Build status

Hard data of RPG creatures

Installation

npm install data-creatures --save

Usage

var data = require('data-creatures');
data();
// return all data
// orc
// elf
// minotaur
// ...


// All options
data({
	size:2, // amount
	plural:true, // return words in plural
})
// return 
// trolls
// elves

CLI

npm install data-creatures -g
Examples
	$ data-creatures
	elf

	$ data-creatures --plural
	elves

	$ data-creatures --all
	orc
	elf
	...

Options
	--all  Get all the words instead of a random word
	--size  Get this amount of words
	--plural  Get words in plural

Contributing

Contributions are very welcome.
If you have any new creature that are not in the list please submit.
All the hard data are in data.js

Plural words are generated by the module blakeembrey/pluralize
Irregular plural words should be registred at irregulars.js.

License

MIT

Releases

No releases published

Packages

No packages published