Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webcaetano/data-creatures
[Node] Hard data of RPG creatures
https://github.com/webcaetano/data-creatures
game generator nodejs rpg rpg-creatures
Last synced: 13 days ago
JSON representation
[Node] Hard data of RPG creatures
- Host: GitHub
- URL: https://github.com/webcaetano/data-creatures
- Owner: webcaetano
- License: mit
- Created: 2016-07-20T01:17:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-07-20T04:08:20.000Z (over 8 years ago)
- Last Synced: 2024-12-08T05:47:48.366Z (about 1 month ago)
- Topics: game, generator, nodejs, rpg, rpg-creatures
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Data-Creatures
[![NPM version][npm-image]][npm-url]
[![Build status][travis-image]][travis-url]
> Hard data of RPG creatures
## Installation
```
npm install data-creatures --save
```
## Usage
```javascript
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](https://github.com/blakeembrey/pluralize)
Irregular plural words should be registred at `irregulars.js`.
## License
MIT
[npm-image]: https://img.shields.io/npm/v/data-creatures.svg?style=flat-square
[npm-url]: https://npmjs.org/package/data-creatures
[travis-image]: https://img.shields.io/travis/webcaetano/data-creatures.svg?style=flat-square
[travis-url]: https://travis-ci.org/webcaetano/data-creatures