Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opendnd/opendnd
This is the main collection of OpenDnD Tools with generators for persons, dynasties, cities, towns, and more
https://github.com/opendnd/opendnd
dnd dnd-tools dnd5e dragons dungeon dungeons-and-dragons generators javascript node-cli nodejs
Last synced: about 2 months ago
JSON representation
This is the main collection of OpenDnD Tools with generators for persons, dynasties, cities, towns, and more
- Host: GitHub
- URL: https://github.com/opendnd/opendnd
- Owner: opendnd
- License: mit
- Created: 2017-12-20T22:43:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T19:57:32.000Z (over 1 year ago)
- Last Synced: 2024-07-18T03:44:04.818Z (2 months ago)
- Topics: dnd, dnd-tools, dnd5e, dragons, dungeon, dungeons-and-dragons, generators, javascript, node-cli, nodejs
- Language: JavaScript
- Homepage: http://opendnd.org
- Size: 484 KB
- Stars: 175
- Watchers: 13
- Forks: 18
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# opendnd
This is the main collection of OpenDnD Tools with generators for persons, dynasties, cities, towns, and more
[](https://nodei.co/npm/opendnd/)
[](https://travis-ci.org/opendnd/opendnd)
## Installation
You will need [node](https://nodejs.org/en/) and [npm](https://www.npmjs.com/) installed. Then run the command:
`npm install -g opendnd`
## Generate from CLI
```shell
dnd name # generate a name for a character or city
dnd dna # generate DNA for a person with unique traits and physical characteristics
dnd person # generate a person either a playable character or non
dnd domain # generate a kingdom, city, town, etc. for the characters to explore
dnd dynasty # generate a dynasty to give the kingdom a rich history
```
## Module Usage
Require opendnd into your file and use either of the opendnd classes.
```javascript
const opendnd = require('opendnd');
const { Nomina, Genetica, Personae, Dominia, Dynastia } = opendnd;
// generate name
const nomina = new Nomina();
const name = nomina.generate();
// generate DNA
const genetica = new Genetica();
const DNA = genetica.generate();
// generate a person with our name and DNA
// all are optional if we leave it out it will be generated for us
const personae = new Personae();
const person = personae.generate({
name,
DNA,
});
// generate a dynasty with our person
const dynastia = new Dynastia();
const dynasty = dynastia.generate({
progenitor: person,
});
// generate a town where this dynasty is from
const dominia = new Dominia();
const town = dominia.generate({
size: 'town',
});
```
## Features
Here are the features of Dynastia:
### Person Generating
For more on person generating please see the Personae [README](https://github.com/opendnd/personae/blob/master/README.md).
### Name Generating
For more on name generating please see the Nomina [README](https://github.com/opendnd/nomina/blob/master/README.md).
### DNA Generating
For more on DNA generating please see the Genetica [README](https://github.com/opendnd/genetica/blob/master/README.md).
### Domain (kingdoms, cities, towns, etc.) Generating
For more on domain generating please see the Dominia [README](https://github.com/opendnd/dominia/blob/master/README.md).
### Dynasty Generating
For more on person dynasty please see the Dynastia [README](https://github.com/opendnd/dynastia/blob/master/README.md).
## Developing
To develop with OpenDnD,
```shell
git clone https://github.com/opendnd/opendnd.git
cd opendnd/
npm install
```
## Contributing
If you'd like to contribute, please fork the repository and use a feature
branch. Pull requests are welcome!
OpenDnD use the [Airbnb](https://github.com/airbnb/javascript) javascript style.
## Licensing
[MIT](https://github.com/opendnd/opendnd/blob/master/LICENSE)