Git Product home page Git Product logo

regdar's Introduction

Regdar

A scraper and data aggregator for D&D Beyond

Allows you to query D&D Beyond for various data entities based on IDs.

Local Dev

  • npm i
  • npm test to run the tests, or node sandbox/index.js and play around with the sandbox environment

Using the library

  1. First bring the library in
const Regdar = require('regdar');
  1. Call the function you need
Regdar.getCharacter(0123456789)
    .then(character => {
        // use character as you want
    });

API

getCharacter(characterId) : Promise

Resolves to a character object.

Character object schema below

// As of v1.0.1
{
  name: 'Bhaal',
  race: 'Half-Orc',
  class: 'Warlock 1',
  classes: [
    {
      level: 1,
      name: 'Warlock'
    }
  ],
  abilities: {
    str: {
      modifier: -2,
      score: 6
    },
    dex: {
      modifier: 0,
      score: 11
    },
    con: {
      modifier: 2,
      score: 14
    },
    int: {
      modifier: 1,
      score: 12
    },
    wis: {
      modifier: 1,
      score: 12
    },
    cha: {
      modifier: 3,
      score: 17
    }
  }
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.