# dnd5-srd

> Dungeons & Dragons 5th Edition - SRD Database

Latest version **1.0.0** (published 2019-11-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install dnd5-srd
pnpm add dnd5-srd
yarn add dnd5-srd
bun add dnd5-srd
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-11-15 |
| First published | 2019-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Adrian Padua |
| Maintainers | climax708 |
| Keywords | dungeons, dragons, dnd, 5e, 5th, edition, srd, json |

## Links

- npm: https://www.npmjs.com/package/dnd5-srd
- Repository: https://github.com/soryy708/5e-database
- Issues: https://github.com/soryy708/5e-database/issues
- npm.io page: https://npm.io/package/dnd5-srd

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.0 (latest) — 2019-11-15

## README

# dnd5-srd

Dungeons & Dragons (5th edition) System Reference Document in node module form, as JSON.

Fork of a [project](https://github.com/adrpadua/5e-database) by [adrpadua](https://github.com/adrpadua).

  # Documentation

## How to use?

As a simple example, lets display how many hit points an Aboleth has.
There are two ways to access the data about monsters:

### Approach 1:

```javascript
const monsters = require('dnd5-srd/monsters');
const aboleth = monsters.find(monster => monster.name === 'Aboleth');
console.log(aboleth.hit_points);
```

### Approach 2:

```javascript
const dnd = require('dnd5-srd');
const monsters = dnd.data.monsters;
const aboleth = monsters.find(monster => monster.name === 'Aboleth');
console.log(aboleth.hit_points);
```

## Reference

Currently there's no documentation for how the data looks like. You'll have to explore the JSON files to figure that out.
The following data types are available:
  
*  `abilityScores`
*  `classes`
*  `conditions`
*  `damageTypes`
*  `equipment`
*  `equipmentCategories`
*  `features`
*  `languages`
*  `levels`
*  `magicSchools`
*  `monsters`
*  `proficiencies`
*  `races`
*  `skills`
*  `spellcasting`
*  `spells`
*  `startingEquipment`
*  `subclasses`
*  `subraces`
*  `traits`
*  `weaponProperties`

---
_Source: https://npm.io/package/dnd5-srd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._